@wix/auto_sdk_ecom_orders 1.0.310 → 1.0.312
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-WyKRc4fh.d.ts → ecom-v1-order-orders.universal-huN94lvX.d.ts} +1700 -1683
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +81 -80
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +81 -80
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1701 -1684
- package/build/cjs/meta.js +81 -80
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-WyKRc4fh.d.mts → ecom-v1-order-orders.universal-huN94lvX.d.mts} +1700 -1683
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +81 -80
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +81 -80
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1701 -1684
- package/build/es/meta.mjs +81 -80
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-BJo4OYMU.d.ts → ecom-v1-order-orders.universal-goQSEn_G.d.ts} +1837 -1810
- 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 +1838 -1811
- package/build/internal/es/{ecom-v1-order-orders.universal-BJo4OYMU.d.mts → ecom-v1-order-orders.universal-goQSEn_G.d.mts} +1837 -1810
- 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 +1838 -1811
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { eo as ImportOrderRequest$1, I as ImportOrderResponse$1, ep as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eq as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1,
|
|
1
|
+
import { eo as ImportOrderRequest$1, I as ImportOrderResponse$1, ep as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eq as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, eu as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ey as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, ez as RecordManuallyCollectedPaymentRequest$1, eC as RecordManuallyCollectedPaymentResponse$1, eD as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eE as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eJ as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eM as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, eO as ChargeMembershipsRequest$1, eR as ChargeMembershipsResponse$1, eS as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fz as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fA as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gV as GetOrderRequest$1, gW as GetOrderResponse$1, h6 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, ha as CreateOrderRequest$1, he as CreateOrderResponse$1, hf as UpdateOrderRequest$1, hg as UpdateOrderResponse$1, hh as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hM as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ib as AddActivityRequest$1, N as AddActivityResponse$1, id as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ie as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ig as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, im as CancelOrderRequest$1, a0 as CancelOrderResponse$1, io as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iM as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iQ as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-goQSEn_G.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -769,7 +769,11 @@ declare enum ItemTypePreset {
|
|
|
769
769
|
PHYSICAL = "PHYSICAL",
|
|
770
770
|
DIGITAL = "DIGITAL",
|
|
771
771
|
GIFT_CARD = "GIFT_CARD",
|
|
772
|
-
SERVICE = "SERVICE"
|
|
772
|
+
SERVICE = "SERVICE",
|
|
773
|
+
/** @documentationMaturity preview
|
|
774
|
+
* @internal
|
|
775
|
+
*/
|
|
776
|
+
BUNDLE = "BUNDLE"
|
|
773
777
|
}
|
|
774
778
|
/** @enumType */
|
|
775
779
|
type ItemTypePresetWithLiterals = ItemTypePreset | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
@@ -976,6 +980,12 @@ interface SubscriptionInfo {
|
|
|
976
980
|
* @internal
|
|
977
981
|
*/
|
|
978
982
|
billingAdjustment?: BillingAdjustment;
|
|
983
|
+
/**
|
|
984
|
+
* Regular price and cycle price of the billing cycle this order covers, when a cycle price
|
|
985
|
+
* override set a different price for that cycle. Absent when the cycle is charged the regular price.
|
|
986
|
+
* @internal
|
|
987
|
+
*/
|
|
988
|
+
cyclePriceOverride?: CyclePriceOverride;
|
|
979
989
|
}
|
|
980
990
|
interface SubscriptionTitle {
|
|
981
991
|
/**
|
|
@@ -4542,2328 +4552,2345 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
4542
4552
|
*/
|
|
4543
4553
|
jobId?: string;
|
|
4544
4554
|
}
|
|
4545
|
-
interface
|
|
4555
|
+
interface V1TriggerReindexRequest {
|
|
4546
4556
|
/** @format GUID */
|
|
4547
|
-
|
|
4548
|
-
}
|
|
4549
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
4550
|
-
}
|
|
4551
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
4557
|
+
metasiteId?: string;
|
|
4552
4558
|
/**
|
|
4553
4559
|
* @minLength 1
|
|
4554
4560
|
* @maxLength 100
|
|
4561
|
+
* @maxSize 100
|
|
4555
4562
|
*/
|
|
4556
|
-
|
|
4563
|
+
orderIds?: string[];
|
|
4557
4564
|
}
|
|
4558
|
-
interface
|
|
4565
|
+
interface V1TriggerReindexResponse {
|
|
4559
4566
|
}
|
|
4560
|
-
interface
|
|
4567
|
+
interface V1TriggerReindexOrderRequest {
|
|
4568
|
+
/** @format GUID */
|
|
4569
|
+
metasiteId?: string;
|
|
4561
4570
|
/**
|
|
4562
4571
|
* @minLength 1
|
|
4563
4572
|
* @maxLength 100
|
|
4564
4573
|
*/
|
|
4565
4574
|
orderId?: string;
|
|
4566
4575
|
}
|
|
4567
|
-
interface
|
|
4568
|
-
}
|
|
4569
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
4570
|
-
/**
|
|
4571
|
-
* IDs of orders to send pickup emails for.
|
|
4572
|
-
* @minSize 1
|
|
4573
|
-
* @maxSize 300
|
|
4574
|
-
*/
|
|
4575
|
-
orderIds?: string[];
|
|
4576
|
-
}
|
|
4577
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
4578
|
-
}
|
|
4579
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
4576
|
+
interface PreparePaymentCollectionRequest {
|
|
4580
4577
|
/**
|
|
4578
|
+
* Ecom order ID.
|
|
4581
4579
|
* @minLength 1
|
|
4582
4580
|
* @maxLength 100
|
|
4583
4581
|
*/
|
|
4584
|
-
|
|
4585
|
-
|
|
4586
|
-
|
|
4587
|
-
}
|
|
4588
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
4582
|
+
ecomOrderId: string;
|
|
4583
|
+
/** Amount to collect */
|
|
4584
|
+
amount: Price;
|
|
4589
4585
|
/**
|
|
4590
|
-
*
|
|
4591
|
-
*
|
|
4592
|
-
*
|
|
4586
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4587
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
4588
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4593
4589
|
*/
|
|
4594
|
-
|
|
4595
|
-
}
|
|
4596
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
4597
|
-
}
|
|
4598
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
4590
|
+
paymentGatewayOrderId?: string | null;
|
|
4599
4591
|
/**
|
|
4600
|
-
*
|
|
4601
|
-
*
|
|
4592
|
+
* Whether to delay capture of the payment.
|
|
4593
|
+
* Default: false
|
|
4594
|
+
* @deprecated Whether to delay capture of the payment.
|
|
4595
|
+
* Default: false
|
|
4596
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4597
|
+
* @targetRemovalDate 2024-09-30
|
|
4602
4598
|
*/
|
|
4603
|
-
|
|
4604
|
-
}
|
|
4605
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
4606
|
-
}
|
|
4607
|
-
interface SendCancelRefundEmailRequest {
|
|
4599
|
+
delayedCapture?: boolean;
|
|
4608
4600
|
/**
|
|
4609
|
-
*
|
|
4610
|
-
*
|
|
4611
|
-
* @
|
|
4601
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
4602
|
+
* Default: `true`
|
|
4603
|
+
* @internal
|
|
4612
4604
|
*/
|
|
4613
|
-
|
|
4605
|
+
merchantInitiated?: boolean | null;
|
|
4614
4606
|
/**
|
|
4615
|
-
*
|
|
4616
|
-
* @
|
|
4617
|
-
* @maxLength 1000
|
|
4607
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
4608
|
+
* @internal
|
|
4618
4609
|
*/
|
|
4619
|
-
|
|
4620
|
-
/**
|
|
4621
|
-
|
|
4610
|
+
redirectUrls?: RedirectUrls;
|
|
4611
|
+
/** Delayed capture payment settings */
|
|
4612
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4613
|
+
}
|
|
4614
|
+
interface RedirectUrls {
|
|
4622
4615
|
/**
|
|
4623
|
-
*
|
|
4624
|
-
* @format
|
|
4616
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4617
|
+
* @format WEB_URL
|
|
4625
4618
|
*/
|
|
4626
|
-
|
|
4627
|
-
}
|
|
4628
|
-
interface SendCancelRefundEmailResponse {
|
|
4629
|
-
}
|
|
4630
|
-
interface SendRefundEmailRequest {
|
|
4619
|
+
successUrl?: string | null;
|
|
4631
4620
|
/**
|
|
4632
|
-
*
|
|
4633
|
-
* @format
|
|
4621
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4622
|
+
* @format WEB_URL
|
|
4634
4623
|
*/
|
|
4635
|
-
|
|
4624
|
+
cancelUrl?: string | null;
|
|
4636
4625
|
/**
|
|
4637
|
-
*
|
|
4638
|
-
* @format
|
|
4626
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4627
|
+
* @format WEB_URL
|
|
4639
4628
|
*/
|
|
4640
|
-
|
|
4629
|
+
errorUrl?: string | null;
|
|
4641
4630
|
/**
|
|
4642
|
-
*
|
|
4643
|
-
* @
|
|
4644
|
-
* @maxLength 1000
|
|
4631
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4632
|
+
* @format WEB_URL
|
|
4645
4633
|
*/
|
|
4646
|
-
|
|
4647
|
-
}
|
|
4648
|
-
interface SendRefundEmailResponse {
|
|
4634
|
+
pendingUrl?: string | null;
|
|
4649
4635
|
}
|
|
4650
|
-
interface
|
|
4651
|
-
/**
|
|
4652
|
-
|
|
4653
|
-
/**
|
|
4654
|
-
|
|
4636
|
+
interface DelayedCaptureSettings {
|
|
4637
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4638
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
4639
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4640
|
+
delayDuration?: Duration;
|
|
4655
4641
|
}
|
|
4656
|
-
|
|
4642
|
+
declare enum ScheduledAction {
|
|
4643
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
4644
|
+
VOID = "VOID",
|
|
4645
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
4646
|
+
CAPTURE = "CAPTURE"
|
|
4657
4647
|
}
|
|
4658
|
-
|
|
4648
|
+
/** @enumType */
|
|
4649
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4650
|
+
interface Duration {
|
|
4659
4651
|
/**
|
|
4660
|
-
*
|
|
4661
|
-
* @
|
|
4652
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4653
|
+
* @min 1
|
|
4662
4654
|
*/
|
|
4663
|
-
|
|
4664
|
-
|
|
4665
|
-
|
|
4666
|
-
}
|
|
4667
|
-
interface PreviewEmailByTypeRequest {
|
|
4668
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
4655
|
+
count?: number;
|
|
4656
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4657
|
+
unit?: DurationUnitWithLiterals;
|
|
4669
4658
|
}
|
|
4670
|
-
declare enum
|
|
4671
|
-
|
|
4672
|
-
|
|
4673
|
-
|
|
4674
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4659
|
+
declare enum DurationUnit {
|
|
4660
|
+
MINUTES = "MINUTES",
|
|
4661
|
+
HOURS = "HOURS",
|
|
4662
|
+
DAYS = "DAYS"
|
|
4675
4663
|
}
|
|
4676
4664
|
/** @enumType */
|
|
4677
|
-
type
|
|
4678
|
-
interface
|
|
4679
|
-
|
|
4665
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4666
|
+
interface PreparePaymentCollectionResponse {
|
|
4667
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4668
|
+
paymentGatewayOrderId?: string;
|
|
4680
4669
|
}
|
|
4681
|
-
interface
|
|
4670
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4682
4671
|
/**
|
|
4672
|
+
* Ecom order ID.
|
|
4683
4673
|
* @minLength 1
|
|
4684
4674
|
* @maxLength 100
|
|
4685
4675
|
*/
|
|
4686
|
-
|
|
4687
|
-
|
|
4688
|
-
|
|
4689
|
-
/**
|
|
4690
|
-
|
|
4676
|
+
ecomOrderId: string;
|
|
4677
|
+
}
|
|
4678
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4679
|
+
/** Payment collectability status */
|
|
4680
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4681
|
+
/** Collectable order amount */
|
|
4682
|
+
amount?: Price;
|
|
4691
4683
|
/**
|
|
4692
|
-
*
|
|
4693
|
-
* @
|
|
4694
|
-
* @maxLength 1000
|
|
4684
|
+
* Whether authorization supported
|
|
4685
|
+
* @internal
|
|
4695
4686
|
*/
|
|
4696
|
-
|
|
4687
|
+
authorizationSupported?: boolean;
|
|
4697
4688
|
/**
|
|
4698
|
-
*
|
|
4699
|
-
* @
|
|
4689
|
+
* Whether custom amount is supported for payment collection
|
|
4690
|
+
* @internal
|
|
4700
4691
|
*/
|
|
4701
|
-
|
|
4692
|
+
customAmountSupported?: boolean;
|
|
4702
4693
|
}
|
|
4703
|
-
|
|
4704
|
-
|
|
4694
|
+
declare enum PaymentCollectabilityStatus {
|
|
4695
|
+
UNKNOWN = "UNKNOWN",
|
|
4696
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4697
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4698
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4699
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4700
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4701
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4702
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4703
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4704
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4705
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4706
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
4707
|
+
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
4708
|
+
}
|
|
4709
|
+
/** @enumType */
|
|
4710
|
+
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';
|
|
4711
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4705
4712
|
/**
|
|
4706
|
-
* Order
|
|
4707
|
-
* @
|
|
4713
|
+
* Order ID.
|
|
4714
|
+
* @minLength 1
|
|
4715
|
+
* @maxLength 100
|
|
4708
4716
|
*/
|
|
4709
|
-
|
|
4710
|
-
/**
|
|
4711
|
-
|
|
4717
|
+
orderId: string;
|
|
4718
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4719
|
+
amount: Price;
|
|
4712
4720
|
/**
|
|
4713
|
-
*
|
|
4714
|
-
*
|
|
4721
|
+
* Payment method name provided by user.
|
|
4722
|
+
*
|
|
4723
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4724
|
+
* @internal
|
|
4715
4725
|
*/
|
|
4716
|
-
|
|
4726
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
4727
|
+
}
|
|
4728
|
+
/**
|
|
4729
|
+
* User-defined payment method name.
|
|
4730
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4731
|
+
*/
|
|
4732
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4733
|
+
/** Predefined payment method. */
|
|
4734
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4717
4735
|
/**
|
|
4718
|
-
*
|
|
4719
|
-
*
|
|
4736
|
+
* Custom payment method name provided by user.
|
|
4737
|
+
*
|
|
4738
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4739
|
+
* @minLength 1
|
|
4740
|
+
* @maxLength 150
|
|
4720
4741
|
*/
|
|
4721
|
-
|
|
4722
|
-
|
|
4723
|
-
|
|
4724
|
-
|
|
4742
|
+
custom?: string | null;
|
|
4743
|
+
}
|
|
4744
|
+
/** @oneof */
|
|
4745
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4746
|
+
/** Predefined payment method. */
|
|
4747
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4748
|
+
/**
|
|
4749
|
+
* Custom payment method name provided by user.
|
|
4750
|
+
*
|
|
4751
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4752
|
+
* @minLength 1
|
|
4753
|
+
* @maxLength 150
|
|
4725
4754
|
*/
|
|
4726
|
-
|
|
4727
|
-
/** Shipping amount that was refunded. */
|
|
4728
|
-
shipping?: ShippingRefund;
|
|
4755
|
+
custom?: string | null;
|
|
4729
4756
|
}
|
|
4730
|
-
|
|
4757
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
4758
|
+
declare enum PredefinedPaymentMethod {
|
|
4759
|
+
/** Cash payment. */
|
|
4760
|
+
CASH = "CASH",
|
|
4761
|
+
/** Bank transfer. */
|
|
4762
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4763
|
+
/** Payment by check. */
|
|
4764
|
+
CHECK = "CHECK"
|
|
4765
|
+
}
|
|
4766
|
+
/** @enumType */
|
|
4767
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4768
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4769
|
+
}
|
|
4770
|
+
interface MarkOrderAsPaidRequest {
|
|
4731
4771
|
/**
|
|
4732
|
-
*
|
|
4733
|
-
* @
|
|
4772
|
+
* Ecom order ID.
|
|
4773
|
+
* @minLength 1
|
|
4774
|
+
* @maxLength 100
|
|
4734
4775
|
*/
|
|
4735
|
-
|
|
4776
|
+
ecomOrderId: string;
|
|
4736
4777
|
/**
|
|
4737
|
-
*
|
|
4738
|
-
*
|
|
4739
|
-
*
|
|
4778
|
+
* Payment method name provided by user.
|
|
4779
|
+
*
|
|
4780
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4781
|
+
* @internal
|
|
4740
4782
|
*/
|
|
4741
|
-
|
|
4783
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
4742
4784
|
}
|
|
4743
|
-
interface
|
|
4785
|
+
interface MarkOrderAsPaidResponse {
|
|
4786
|
+
/** Updated order. */
|
|
4787
|
+
order?: Order;
|
|
4788
|
+
}
|
|
4789
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4744
4790
|
/**
|
|
4745
|
-
*
|
|
4746
|
-
* @
|
|
4747
|
-
* @
|
|
4791
|
+
* IDs of orders to mark as paid.
|
|
4792
|
+
* @minSize 1
|
|
4793
|
+
* @maxSize 100
|
|
4794
|
+
* @minLength 1
|
|
4795
|
+
* @maxLength 100
|
|
4748
4796
|
*/
|
|
4749
|
-
|
|
4797
|
+
ecomOrderIds: string[];
|
|
4798
|
+
}
|
|
4799
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4750
4800
|
/**
|
|
4751
|
-
*
|
|
4752
|
-
*
|
|
4753
|
-
* @max 100000
|
|
4754
|
-
* @immutable
|
|
4801
|
+
* Items updated by the bulk action.
|
|
4802
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4755
4803
|
*/
|
|
4756
|
-
|
|
4804
|
+
results?: BulkOrderResult[];
|
|
4805
|
+
/** Bulk action metadata. */
|
|
4806
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4757
4807
|
}
|
|
4758
|
-
interface
|
|
4808
|
+
interface BulkOrderResult {
|
|
4809
|
+
/** Item metadata. */
|
|
4810
|
+
itemMetadata?: ItemMetadata;
|
|
4759
4811
|
/**
|
|
4760
|
-
*
|
|
4761
|
-
*
|
|
4762
|
-
*
|
|
4812
|
+
* Updated order.
|
|
4813
|
+
*
|
|
4814
|
+
* Returned when `returnFullEntity = true`.
|
|
4763
4815
|
*/
|
|
4764
|
-
|
|
4816
|
+
item?: Order;
|
|
4817
|
+
}
|
|
4818
|
+
interface ItemMetadata {
|
|
4819
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4820
|
+
id?: string | null;
|
|
4821
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4822
|
+
originalIndex?: number;
|
|
4823
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4824
|
+
success?: boolean;
|
|
4825
|
+
/** Details about the error in case of failure. */
|
|
4826
|
+
error?: ApplicationError;
|
|
4827
|
+
}
|
|
4828
|
+
interface ApplicationError {
|
|
4829
|
+
/** Error code. */
|
|
4830
|
+
code?: string;
|
|
4831
|
+
/** Description of the error. */
|
|
4832
|
+
description?: string;
|
|
4833
|
+
/** Data related to the error. */
|
|
4834
|
+
data?: Record<string, any> | null;
|
|
4835
|
+
}
|
|
4836
|
+
interface BulkActionMetadata {
|
|
4837
|
+
/** Number of items that were successfully processed. */
|
|
4838
|
+
totalSuccesses?: number;
|
|
4839
|
+
/** Number of items that couldn't be processed. */
|
|
4840
|
+
totalFailures?: number;
|
|
4841
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4842
|
+
undetailedFailures?: number;
|
|
4843
|
+
}
|
|
4844
|
+
interface GetRefundabilityStatusRequest {
|
|
4765
4845
|
/**
|
|
4766
|
-
*
|
|
4767
|
-
* @
|
|
4846
|
+
* Order ID.
|
|
4847
|
+
* @minLength 1
|
|
4848
|
+
* @maxLength 100
|
|
4768
4849
|
*/
|
|
4769
|
-
|
|
4850
|
+
ecomOrderId: string;
|
|
4770
4851
|
}
|
|
4771
|
-
interface
|
|
4852
|
+
interface GetRefundabilityStatusResponse {
|
|
4772
4853
|
/**
|
|
4773
|
-
*
|
|
4774
|
-
* @
|
|
4854
|
+
* Refundability details.
|
|
4855
|
+
* @maxSize 300
|
|
4775
4856
|
*/
|
|
4776
|
-
|
|
4857
|
+
refundabilities?: Refundability[];
|
|
4858
|
+
/**
|
|
4859
|
+
* Whether the order supports refunding per item.
|
|
4860
|
+
* @deprecated
|
|
4861
|
+
*/
|
|
4862
|
+
refundablePerItem?: boolean;
|
|
4777
4863
|
}
|
|
4778
|
-
interface
|
|
4779
|
-
|
|
4864
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4865
|
+
/** Reason why payment is not refundable. */
|
|
4866
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4867
|
+
/** Reason why payment is only refundable manually. */
|
|
4868
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4869
|
+
/** Payment ID. */
|
|
4870
|
+
paymentId?: string;
|
|
4871
|
+
/** Payment refundability status. */
|
|
4872
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4873
|
+
/** Link to payment provider dashboard. */
|
|
4874
|
+
providerLink?: string | null;
|
|
4780
4875
|
}
|
|
4781
|
-
|
|
4876
|
+
/** @oneof */
|
|
4877
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4878
|
+
/** Reason why payment is not refundable. */
|
|
4879
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4880
|
+
/** Reason why payment is only refundable manually. */
|
|
4881
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4882
|
+
}
|
|
4883
|
+
declare enum RefundableStatus {
|
|
4884
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4885
|
+
MANUAL = "MANUAL",
|
|
4886
|
+
REFUNDABLE = "REFUNDABLE"
|
|
4887
|
+
}
|
|
4888
|
+
/** @enumType */
|
|
4889
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4890
|
+
declare enum NonRefundableReason {
|
|
4891
|
+
NONE = "NONE",
|
|
4892
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4893
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4894
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4895
|
+
NOT_PAID = "NOT_PAID",
|
|
4896
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4897
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
4898
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4899
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
4900
|
+
FORBIDDEN = "FORBIDDEN",
|
|
4901
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4902
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4903
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4904
|
+
}
|
|
4905
|
+
/** @enumType */
|
|
4906
|
+
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';
|
|
4907
|
+
declare enum ManuallyRefundableReason {
|
|
4908
|
+
EXPIRED = "EXPIRED",
|
|
4909
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4910
|
+
OFFLINE = "OFFLINE",
|
|
4911
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4912
|
+
}
|
|
4913
|
+
/** @enumType */
|
|
4914
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4915
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
4782
4916
|
/**
|
|
4917
|
+
* Ecom order ID.
|
|
4783
4918
|
* @minLength 1
|
|
4784
4919
|
* @maxLength 100
|
|
4785
4920
|
*/
|
|
4786
|
-
|
|
4921
|
+
ecomOrderId: string;
|
|
4922
|
+
/** Information about the user who initiated the payment. */
|
|
4923
|
+
chargedBy?: ChargedBy;
|
|
4787
4924
|
/**
|
|
4788
|
-
*
|
|
4925
|
+
* Whether to delay capture of the payment.
|
|
4926
|
+
*
|
|
4927
|
+
* Default: false
|
|
4928
|
+
* @internal
|
|
4929
|
+
*/
|
|
4930
|
+
delayedCapture?: boolean;
|
|
4931
|
+
}
|
|
4932
|
+
interface ChargedBy {
|
|
4933
|
+
/**
|
|
4934
|
+
* ID - id of the user who initiated the payment
|
|
4935
|
+
* @format GUID
|
|
4936
|
+
*/
|
|
4937
|
+
id?: string;
|
|
4938
|
+
/**
|
|
4939
|
+
* Full name - name of the user who initiated the payment
|
|
4789
4940
|
* @minLength 1
|
|
4790
|
-
* @maxLength
|
|
4941
|
+
* @maxLength 200
|
|
4791
4942
|
*/
|
|
4792
|
-
|
|
4943
|
+
fullName?: string | null;
|
|
4793
4944
|
}
|
|
4794
|
-
interface
|
|
4795
|
-
|
|
4945
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4946
|
+
/** ID of the order created in the payment gateway */
|
|
4947
|
+
paymentGatewayOrderId?: string;
|
|
4796
4948
|
}
|
|
4797
|
-
interface
|
|
4949
|
+
interface ChargeMembershipsRequest {
|
|
4798
4950
|
/**
|
|
4951
|
+
* Order ID.
|
|
4799
4952
|
* @minLength 1
|
|
4800
4953
|
* @maxLength 100
|
|
4801
4954
|
*/
|
|
4802
|
-
|
|
4955
|
+
ecomOrderId: string;
|
|
4803
4956
|
/**
|
|
4804
|
-
*
|
|
4957
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4958
|
+
* but a user which is using the membership on behalf of the a member
|
|
4959
|
+
* @format GUID
|
|
4960
|
+
*/
|
|
4961
|
+
memberId: string;
|
|
4962
|
+
/**
|
|
4963
|
+
* List of items to be paid by memberships
|
|
4964
|
+
* @minSize 1
|
|
4965
|
+
* @maxSize 300
|
|
4966
|
+
*/
|
|
4967
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4968
|
+
}
|
|
4969
|
+
interface MembershipChargeItem {
|
|
4970
|
+
/**
|
|
4971
|
+
* The id of used membership
|
|
4805
4972
|
* @minLength 1
|
|
4806
|
-
* @maxLength
|
|
4973
|
+
* @maxLength 100
|
|
4807
4974
|
*/
|
|
4808
|
-
|
|
4809
|
-
/** Refund amount */
|
|
4810
|
-
refundAmount?: Price;
|
|
4975
|
+
membershipId?: string;
|
|
4811
4976
|
/**
|
|
4812
|
-
*
|
|
4977
|
+
* ID of the application providing this payment option
|
|
4813
4978
|
* @format GUID
|
|
4814
4979
|
*/
|
|
4815
|
-
|
|
4816
|
-
|
|
4817
|
-
|
|
4818
|
-
|
|
4819
|
-
|
|
4820
|
-
|
|
4821
|
-
|
|
4822
|
-
|
|
4823
|
-
|
|
4824
|
-
}
|
|
4825
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
4826
|
-
}
|
|
4827
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
4828
|
-
emailPreview?: string;
|
|
4829
|
-
}
|
|
4830
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4831
|
-
}
|
|
4832
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4833
|
-
emailPreview?: string;
|
|
4834
|
-
}
|
|
4835
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
4836
|
-
}
|
|
4837
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
4838
|
-
emailPreview?: string;
|
|
4839
|
-
}
|
|
4840
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
4841
|
-
}
|
|
4842
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
4843
|
-
emailPreview?: string;
|
|
4844
|
-
}
|
|
4845
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4846
|
-
/** Emitted on a meta site creation. */
|
|
4847
|
-
siteCreated?: SiteCreated;
|
|
4848
|
-
/** Emitted on a meta site transfer completion. */
|
|
4849
|
-
siteTransferred?: SiteTransferred;
|
|
4850
|
-
/** Emitted on a meta site deletion. */
|
|
4851
|
-
siteDeleted?: SiteDeleted;
|
|
4852
|
-
/** Emitted on a meta site restoration. */
|
|
4853
|
-
siteUndeleted?: SiteUndeleted;
|
|
4854
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4855
|
-
sitePublished?: SitePublished;
|
|
4856
|
-
/** Emitted on a meta site unpublish. */
|
|
4857
|
-
siteUnpublished?: SiteUnpublished;
|
|
4858
|
-
/** Emitted when meta site is marked as template. */
|
|
4859
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4860
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4861
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4862
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4863
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4864
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4865
|
-
serviceRemoved?: ServiceRemoved;
|
|
4866
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4867
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4868
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4869
|
-
hardDeleted?: SiteHardDeleted;
|
|
4870
|
-
/** Emitted on a namespace change. */
|
|
4871
|
-
namespaceChanged?: NamespaceChanged;
|
|
4872
|
-
/** Emitted when Studio is attached. */
|
|
4873
|
-
studioAssigned?: StudioAssigned;
|
|
4874
|
-
/** Emitted when Studio is detached. */
|
|
4875
|
-
studioUnassigned?: StudioUnassigned;
|
|
4876
|
-
/**
|
|
4877
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4878
|
-
* the actual URL.
|
|
4879
|
-
*
|
|
4880
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4881
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4882
|
-
*/
|
|
4883
|
-
urlChanged?: SiteUrlChanged;
|
|
4884
|
-
/** Site is marked as PurgedExternally */
|
|
4885
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4886
|
-
/** Emitted when Odeditor is attached. */
|
|
4887
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4888
|
-
/** Emitted when Odeditor is detached. */
|
|
4889
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4890
|
-
/** Emitted when Picasso is attached. */
|
|
4891
|
-
picassoAssigned?: PicassoAssigned;
|
|
4892
|
-
/** Emitted when Picasso is detached. */
|
|
4893
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4894
|
-
/** Emitted when Wixel is attached. */
|
|
4895
|
-
wixelAssigned?: WixelAssigned;
|
|
4896
|
-
/** Emitted when Wixel is detached. */
|
|
4897
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4898
|
-
/** Emitted when StudioTwo is attached. */
|
|
4899
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4900
|
-
/** Emitted when StudioTwo is detached. */
|
|
4901
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4902
|
-
/** Emitted when media from user domain is enabled. */
|
|
4903
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4904
|
-
/** Emitted when media from user domain is disabled. */
|
|
4905
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4906
|
-
/** Emitted when Editorless is attached. */
|
|
4907
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4908
|
-
/** Emitted when Editorless is detached. */
|
|
4909
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4910
|
-
/**
|
|
4911
|
-
* A meta site id.
|
|
4912
|
-
* @format GUID
|
|
4913
|
-
*/
|
|
4914
|
-
metaSiteId?: string;
|
|
4915
|
-
/** A meta site version. Monotonically increasing. */
|
|
4916
|
-
version?: string;
|
|
4917
|
-
/** A timestamp of the event. */
|
|
4918
|
-
timestamp?: string;
|
|
4919
|
-
/**
|
|
4920
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4921
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4922
|
-
* @maxSize 4000
|
|
4923
|
-
*/
|
|
4924
|
-
assets?: Asset[];
|
|
4925
|
-
}
|
|
4926
|
-
/** @oneof */
|
|
4927
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4928
|
-
/** Emitted on a meta site creation. */
|
|
4929
|
-
siteCreated?: SiteCreated;
|
|
4930
|
-
/** Emitted on a meta site transfer completion. */
|
|
4931
|
-
siteTransferred?: SiteTransferred;
|
|
4932
|
-
/** Emitted on a meta site deletion. */
|
|
4933
|
-
siteDeleted?: SiteDeleted;
|
|
4934
|
-
/** Emitted on a meta site restoration. */
|
|
4935
|
-
siteUndeleted?: SiteUndeleted;
|
|
4936
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4937
|
-
sitePublished?: SitePublished;
|
|
4938
|
-
/** Emitted on a meta site unpublish. */
|
|
4939
|
-
siteUnpublished?: SiteUnpublished;
|
|
4940
|
-
/** Emitted when meta site is marked as template. */
|
|
4941
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4942
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4943
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4944
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4945
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4946
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4947
|
-
serviceRemoved?: ServiceRemoved;
|
|
4948
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4949
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4950
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4951
|
-
hardDeleted?: SiteHardDeleted;
|
|
4952
|
-
/** Emitted on a namespace change. */
|
|
4953
|
-
namespaceChanged?: NamespaceChanged;
|
|
4954
|
-
/** Emitted when Studio is attached. */
|
|
4955
|
-
studioAssigned?: StudioAssigned;
|
|
4956
|
-
/** Emitted when Studio is detached. */
|
|
4957
|
-
studioUnassigned?: StudioUnassigned;
|
|
4958
|
-
/**
|
|
4959
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4960
|
-
* the actual URL.
|
|
4961
|
-
*
|
|
4962
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4963
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4964
|
-
*/
|
|
4965
|
-
urlChanged?: SiteUrlChanged;
|
|
4966
|
-
/** Site is marked as PurgedExternally */
|
|
4967
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4968
|
-
/** Emitted when Odeditor is attached. */
|
|
4969
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4970
|
-
/** Emitted when Odeditor is detached. */
|
|
4971
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4972
|
-
/** Emitted when Picasso is attached. */
|
|
4973
|
-
picassoAssigned?: PicassoAssigned;
|
|
4974
|
-
/** Emitted when Picasso is detached. */
|
|
4975
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4976
|
-
/** Emitted when Wixel is attached. */
|
|
4977
|
-
wixelAssigned?: WixelAssigned;
|
|
4978
|
-
/** Emitted when Wixel is detached. */
|
|
4979
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4980
|
-
/** Emitted when StudioTwo is attached. */
|
|
4981
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4982
|
-
/** Emitted when StudioTwo is detached. */
|
|
4983
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4984
|
-
/** Emitted when media from user domain is enabled. */
|
|
4985
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4986
|
-
/** Emitted when media from user domain is disabled. */
|
|
4987
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4988
|
-
/** Emitted when Editorless is attached. */
|
|
4989
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4990
|
-
/** Emitted when Editorless is detached. */
|
|
4991
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4992
|
-
}
|
|
4993
|
-
interface Asset {
|
|
4994
|
-
/**
|
|
4995
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4996
|
-
* @maxLength 36
|
|
4997
|
-
*/
|
|
4998
|
-
appDefId?: string;
|
|
4999
|
-
/**
|
|
5000
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
5001
|
-
* @maxLength 200
|
|
5002
|
-
*/
|
|
5003
|
-
instanceId?: string;
|
|
5004
|
-
/** An application state. */
|
|
5005
|
-
state?: StateWithLiterals;
|
|
5006
|
-
}
|
|
5007
|
-
declare enum State {
|
|
5008
|
-
UNKNOWN = "UNKNOWN",
|
|
5009
|
-
ENABLED = "ENABLED",
|
|
5010
|
-
DISABLED = "DISABLED",
|
|
5011
|
-
PENDING = "PENDING",
|
|
5012
|
-
DEMO = "DEMO"
|
|
5013
|
-
}
|
|
5014
|
-
/** @enumType */
|
|
5015
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5016
|
-
interface SiteCreated {
|
|
4980
|
+
appId?: string;
|
|
4981
|
+
/** The name of used membership */
|
|
4982
|
+
membershipName?: MembershipName;
|
|
4983
|
+
/** Additional data about this membership */
|
|
4984
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
4985
|
+
/** Catalog and item reference info. */
|
|
4986
|
+
catalogReference?: CatalogReference;
|
|
4987
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4988
|
+
serviceProperties?: ServiceProperties;
|
|
5017
4989
|
/**
|
|
5018
|
-
*
|
|
4990
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
4991
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4992
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4993
|
+
* @minLength 1
|
|
5019
4994
|
* @maxLength 36
|
|
5020
4995
|
*/
|
|
5021
|
-
|
|
5022
|
-
/**
|
|
5023
|
-
* An account id of the owner.
|
|
5024
|
-
* @format GUID
|
|
5025
|
-
*/
|
|
5026
|
-
ownerId?: string;
|
|
5027
|
-
/** A context in which meta site was created. */
|
|
5028
|
-
context?: SiteCreatedContextWithLiterals;
|
|
5029
|
-
/**
|
|
5030
|
-
* A meta site id from which this site was created.
|
|
5031
|
-
*
|
|
5032
|
-
* In case of a creation from a template it's a template id.
|
|
5033
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5034
|
-
* @format GUID
|
|
5035
|
-
*/
|
|
5036
|
-
originMetaSiteId?: string | null;
|
|
5037
|
-
/**
|
|
5038
|
-
* A meta site name (URL slug).
|
|
5039
|
-
* @maxLength 20
|
|
5040
|
-
*/
|
|
5041
|
-
siteName?: string;
|
|
5042
|
-
/** A namespace. */
|
|
5043
|
-
namespace?: NamespaceWithLiterals;
|
|
5044
|
-
}
|
|
5045
|
-
declare enum SiteCreatedContext {
|
|
5046
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5047
|
-
OTHER = "OTHER",
|
|
5048
|
-
/** A meta site was created from template. */
|
|
5049
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5050
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
5051
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5052
|
-
/** A copy of existing meta site. */
|
|
5053
|
-
DUPLICATE = "DUPLICATE",
|
|
5054
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5055
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5056
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
5057
|
-
FLASH = "FLASH"
|
|
5058
|
-
}
|
|
5059
|
-
/** @enumType */
|
|
5060
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5061
|
-
declare enum Namespace {
|
|
5062
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5063
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5064
|
-
WIX = "WIX",
|
|
5065
|
-
/** 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. */
|
|
5066
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
5067
|
-
/** 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. */
|
|
5068
|
-
ALBUMS = "ALBUMS",
|
|
5069
|
-
/** 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. */
|
|
5070
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5071
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5072
|
-
HOTELS = "HOTELS",
|
|
5073
|
-
/** 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. */
|
|
5074
|
-
CLUBS = "CLUBS",
|
|
5075
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5076
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5077
|
-
/**
|
|
5078
|
-
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5079
|
-
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
5080
|
-
*/
|
|
5081
|
-
DEV_SITE = "DEV_SITE",
|
|
5082
|
-
/** 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. */
|
|
5083
|
-
LOGOS = "LOGOS",
|
|
5084
|
-
/** 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. */
|
|
5085
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5086
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5087
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5088
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5089
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5090
|
-
/**
|
|
5091
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5092
|
-
*
|
|
5093
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5094
|
-
*/
|
|
5095
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
5096
|
-
/**
|
|
5097
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
5098
|
-
* Will be accessible from Site List and will not have a website app.
|
|
5099
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
5100
|
-
*/
|
|
5101
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
5102
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5103
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5104
|
-
/** It is to be used in the Business First efforts. */
|
|
5105
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5106
|
-
/** Bookings business flow with no site. */
|
|
5107
|
-
ANYWHERE = "ANYWHERE",
|
|
5108
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
5109
|
-
HEADLESS = "HEADLESS",
|
|
4996
|
+
rootCatalogItemId?: string | null;
|
|
5110
4997
|
/**
|
|
5111
|
-
*
|
|
5112
|
-
*
|
|
4998
|
+
* line item id of Checkout/Order line item
|
|
4999
|
+
* @minLength 1
|
|
5000
|
+
* @maxLength 100
|
|
5113
5001
|
*/
|
|
5114
|
-
|
|
5115
|
-
|
|
5116
|
-
|
|
5002
|
+
lineItemId?: string;
|
|
5003
|
+
}
|
|
5004
|
+
interface MembershipName {
|
|
5117
5005
|
/**
|
|
5118
|
-
*
|
|
5119
|
-
*
|
|
5120
|
-
* The Mobile company will be the owner of this namespace.
|
|
5006
|
+
* Membership name in the site's original language.
|
|
5007
|
+
* @maxLength 100
|
|
5121
5008
|
*/
|
|
5122
|
-
|
|
5123
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5124
|
-
NOWNIA = "NOWNIA",
|
|
5009
|
+
original?: string;
|
|
5125
5010
|
/**
|
|
5126
|
-
*
|
|
5127
|
-
*
|
|
5011
|
+
* Membership name translated into the buyer's language.
|
|
5012
|
+
*
|
|
5013
|
+
* Default: The value of `original`
|
|
5014
|
+
* @maxLength 100
|
|
5128
5015
|
*/
|
|
5129
|
-
|
|
5130
|
-
|
|
5131
|
-
|
|
5132
|
-
|
|
5133
|
-
|
|
5016
|
+
translated?: string | null;
|
|
5017
|
+
}
|
|
5018
|
+
interface ChargeMembershipsResponse {
|
|
5019
|
+
}
|
|
5020
|
+
interface TriggerRefundRequest {
|
|
5134
5021
|
/**
|
|
5135
|
-
*
|
|
5136
|
-
*
|
|
5022
|
+
* The order this refund related to
|
|
5023
|
+
* @minLength 1
|
|
5024
|
+
* @maxLength 100
|
|
5137
5025
|
*/
|
|
5138
|
-
|
|
5139
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5140
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5141
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5142
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5143
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5144
|
-
MIMIR = "MIMIR",
|
|
5145
|
-
/** Wix Twins platform. */
|
|
5146
|
-
TWINS = "TWINS",
|
|
5147
|
-
/** Wix Nano. */
|
|
5148
|
-
NANO = "NANO",
|
|
5149
|
-
/** Base44 headless sites. */
|
|
5150
|
-
BASE44 = "BASE44",
|
|
5151
|
-
/** Wix Channels Sites */
|
|
5152
|
-
CHANNELS = "CHANNELS",
|
|
5153
|
-
/** Nautilus platform. */
|
|
5154
|
-
NAUTILUS = "NAUTILUS",
|
|
5026
|
+
ecomOrderId: string;
|
|
5155
5027
|
/**
|
|
5156
|
-
*
|
|
5157
|
-
*
|
|
5028
|
+
* Refund operations information
|
|
5029
|
+
* @minSize 1
|
|
5030
|
+
* @maxSize 1
|
|
5158
5031
|
*/
|
|
5159
|
-
|
|
5160
|
-
/**
|
|
5161
|
-
|
|
5032
|
+
payments: PaymentRefund[];
|
|
5033
|
+
/** Business model of a refund */
|
|
5034
|
+
details?: RefundDetails;
|
|
5035
|
+
/** Side effect details related to refund */
|
|
5036
|
+
sideEffects?: RefundSideEffects;
|
|
5037
|
+
}
|
|
5038
|
+
interface PaymentRefund {
|
|
5162
5039
|
/**
|
|
5163
|
-
*
|
|
5164
|
-
*
|
|
5040
|
+
* Specific payment within the order to refund
|
|
5041
|
+
* @format GUID
|
|
5165
5042
|
*/
|
|
5166
|
-
|
|
5043
|
+
paymentId?: string;
|
|
5044
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5045
|
+
amount?: Price;
|
|
5167
5046
|
/**
|
|
5168
|
-
*
|
|
5169
|
-
* (
|
|
5170
|
-
*
|
|
5171
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5047
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5048
|
+
* 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.
|
|
5049
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5172
5050
|
*/
|
|
5173
|
-
|
|
5051
|
+
externalRefund?: boolean;
|
|
5174
5052
|
/**
|
|
5175
|
-
*
|
|
5176
|
-
*
|
|
5053
|
+
* Gateway refund id. When param is present, new refund is not created.
|
|
5054
|
+
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
5055
|
+
* and all side effects from request will be executed.
|
|
5056
|
+
* @internal
|
|
5057
|
+
* @minLength 1
|
|
5058
|
+
* @maxLength 100
|
|
5177
5059
|
*/
|
|
5178
|
-
|
|
5060
|
+
gatewayRefundId?: string | null;
|
|
5179
5061
|
}
|
|
5180
|
-
/**
|
|
5181
|
-
|
|
5182
|
-
/** Site transferred to another user. */
|
|
5183
|
-
interface SiteTransferred {
|
|
5062
|
+
/** Business model of a refund request */
|
|
5063
|
+
interface RefundDetails {
|
|
5184
5064
|
/**
|
|
5185
|
-
*
|
|
5186
|
-
* @
|
|
5065
|
+
* Order line item IDs and quantities that were refunded.
|
|
5066
|
+
* @maxSize 300
|
|
5187
5067
|
*/
|
|
5188
|
-
|
|
5068
|
+
items?: RefundItem[];
|
|
5069
|
+
/** Whether the shipping fee was also refunded. */
|
|
5070
|
+
shippingIncluded?: boolean;
|
|
5189
5071
|
/**
|
|
5190
|
-
*
|
|
5191
|
-
* @
|
|
5072
|
+
* Reason for the refund, provided by customer (optional).
|
|
5073
|
+
* @maxLength 200
|
|
5192
5074
|
*/
|
|
5193
|
-
|
|
5194
|
-
}
|
|
5195
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
5196
|
-
interface SiteDeleted {
|
|
5197
|
-
/** A deletion context. */
|
|
5198
|
-
deleteContext?: DeleteContext;
|
|
5199
|
-
}
|
|
5200
|
-
interface DeleteContext {
|
|
5201
|
-
/** When the meta site was deleted. */
|
|
5202
|
-
dateDeleted?: Date | null;
|
|
5203
|
-
/** A status. */
|
|
5204
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
5075
|
+
reason?: string | null;
|
|
5205
5076
|
/**
|
|
5206
|
-
*
|
|
5207
|
-
* @
|
|
5077
|
+
* Line items that were refunded.
|
|
5078
|
+
* @maxSize 300
|
|
5208
5079
|
*/
|
|
5209
|
-
|
|
5080
|
+
lineItems?: LineItemRefund[];
|
|
5210
5081
|
/**
|
|
5211
|
-
*
|
|
5212
|
-
* @
|
|
5082
|
+
* Additional fees that were refunded.
|
|
5083
|
+
* @maxSize 100
|
|
5213
5084
|
*/
|
|
5214
|
-
|
|
5215
|
-
|
|
5216
|
-
|
|
5217
|
-
UNKNOWN = "UNKNOWN",
|
|
5218
|
-
TRASH = "TRASH",
|
|
5219
|
-
DELETED = "DELETED",
|
|
5220
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
5221
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
5222
|
-
}
|
|
5223
|
-
/** @enumType */
|
|
5224
|
-
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
5225
|
-
/** Restoration of the meta site. */
|
|
5226
|
-
interface SiteUndeleted {
|
|
5227
|
-
}
|
|
5228
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5229
|
-
interface SitePublished {
|
|
5085
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
5086
|
+
/** Shipping amount that was refunded. */
|
|
5087
|
+
shipping?: ShippingRefund;
|
|
5230
5088
|
}
|
|
5231
|
-
interface
|
|
5089
|
+
interface RefundItem {
|
|
5232
5090
|
/**
|
|
5233
|
-
*
|
|
5234
|
-
* @
|
|
5235
|
-
* @maxSize 10000
|
|
5091
|
+
* Line item ID the refunded line item.
|
|
5092
|
+
* @format GUID
|
|
5236
5093
|
*/
|
|
5237
|
-
|
|
5238
|
-
|
|
5239
|
-
|
|
5240
|
-
|
|
5241
|
-
|
|
5094
|
+
lineItemId?: string;
|
|
5095
|
+
/**
|
|
5096
|
+
* Line item quantity refunded.
|
|
5097
|
+
* @min 1
|
|
5098
|
+
* @max 100000
|
|
5099
|
+
*/
|
|
5100
|
+
quantity?: number;
|
|
5242
5101
|
}
|
|
5243
|
-
|
|
5244
|
-
* Represents a service provisioned a site.
|
|
5245
|
-
*
|
|
5246
|
-
* Note on `origin_instance_id`:
|
|
5247
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5248
|
-
* This is because of the following scenario:
|
|
5249
|
-
*
|
|
5250
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5251
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5252
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
5253
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5254
|
-
* your site remains consistent with what you initially received and does not include any
|
|
5255
|
-
* changes made to the original template afterward.
|
|
5256
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5257
|
-
*/
|
|
5258
|
-
interface ServiceProvisioned {
|
|
5102
|
+
interface LineItemRefund {
|
|
5259
5103
|
/**
|
|
5260
|
-
*
|
|
5261
|
-
* @
|
|
5104
|
+
* Line item ID.
|
|
5105
|
+
* @format GUID
|
|
5106
|
+
* @immutable
|
|
5262
5107
|
*/
|
|
5263
|
-
|
|
5108
|
+
lineItemId?: string;
|
|
5264
5109
|
/**
|
|
5265
|
-
*
|
|
5266
|
-
* @
|
|
5110
|
+
* Refund quantity.
|
|
5111
|
+
* @min 1
|
|
5112
|
+
* @max 100000
|
|
5113
|
+
* @immutable
|
|
5267
5114
|
*/
|
|
5268
|
-
|
|
5115
|
+
quantity?: number;
|
|
5116
|
+
}
|
|
5117
|
+
interface AdditionalFeeRefund {
|
|
5269
5118
|
/**
|
|
5270
|
-
*
|
|
5271
|
-
* @
|
|
5119
|
+
* Additional fee ID.
|
|
5120
|
+
* @format GUID
|
|
5121
|
+
* @immutable
|
|
5272
5122
|
*/
|
|
5273
|
-
|
|
5123
|
+
additionalFeeId?: string;
|
|
5274
5124
|
/**
|
|
5275
|
-
*
|
|
5276
|
-
* @
|
|
5125
|
+
* Refund amount.
|
|
5126
|
+
* @immutable
|
|
5277
5127
|
*/
|
|
5278
|
-
|
|
5128
|
+
amount?: Price;
|
|
5129
|
+
}
|
|
5130
|
+
interface ShippingRefund {
|
|
5279
5131
|
/**
|
|
5280
|
-
*
|
|
5281
|
-
* @
|
|
5132
|
+
* Refund amount.
|
|
5133
|
+
* @immutable
|
|
5282
5134
|
*/
|
|
5283
|
-
|
|
5135
|
+
amount?: Price;
|
|
5284
5136
|
}
|
|
5285
|
-
interface
|
|
5137
|
+
interface RefundSideEffects {
|
|
5138
|
+
/** Inventory restock details as part of this refund. */
|
|
5139
|
+
restockInfo?: RestockInfo;
|
|
5140
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
5141
|
+
sendOrderRefundedEmail?: boolean;
|
|
5286
5142
|
/**
|
|
5287
|
-
*
|
|
5288
|
-
* @
|
|
5143
|
+
* Custom message added to the refund confirmation email.
|
|
5144
|
+
* @minLength 1
|
|
5145
|
+
* @maxLength 1000
|
|
5146
|
+
*/
|
|
5147
|
+
customMessage?: string | null;
|
|
5148
|
+
}
|
|
5149
|
+
interface RestockInfo {
|
|
5150
|
+
/** Restock type. */
|
|
5151
|
+
type?: RestockTypeWithLiterals;
|
|
5152
|
+
/**
|
|
5153
|
+
* Deprecated, use items instead
|
|
5154
|
+
* @internal
|
|
5155
|
+
* @maxSize 300
|
|
5156
|
+
* @deprecated
|
|
5289
5157
|
*/
|
|
5290
|
-
|
|
5158
|
+
lineItemIds?: string[];
|
|
5291
5159
|
/**
|
|
5292
|
-
*
|
|
5293
|
-
* @
|
|
5160
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
5161
|
+
* @maxSize 300
|
|
5294
5162
|
*/
|
|
5295
|
-
|
|
5163
|
+
items?: RestockItem[];
|
|
5164
|
+
}
|
|
5165
|
+
declare enum RestockType {
|
|
5166
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5167
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5168
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5169
|
+
}
|
|
5170
|
+
/** @enumType */
|
|
5171
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5172
|
+
interface RestockItem {
|
|
5296
5173
|
/**
|
|
5297
|
-
*
|
|
5298
|
-
* @
|
|
5174
|
+
* ID of the line item being restocked.
|
|
5175
|
+
* @format GUID
|
|
5299
5176
|
*/
|
|
5300
|
-
|
|
5301
|
-
}
|
|
5302
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
5303
|
-
interface SiteRenamed {
|
|
5177
|
+
lineItemId?: string;
|
|
5304
5178
|
/**
|
|
5305
|
-
*
|
|
5306
|
-
* @
|
|
5179
|
+
* Line item quantity being restocked.
|
|
5180
|
+
* @min 1
|
|
5181
|
+
* @max 100000
|
|
5307
5182
|
*/
|
|
5308
|
-
|
|
5183
|
+
quantity?: number;
|
|
5309
5184
|
/**
|
|
5310
|
-
*
|
|
5311
|
-
* @
|
|
5185
|
+
* Per-location breakdown of restock quantities.
|
|
5186
|
+
* @internal
|
|
5187
|
+
* @maxSize 5
|
|
5312
5188
|
*/
|
|
5313
|
-
|
|
5314
|
-
}
|
|
5315
|
-
/**
|
|
5316
|
-
* Hard deletion of the meta site.
|
|
5317
|
-
*
|
|
5318
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5319
|
-
*/
|
|
5320
|
-
interface SiteHardDeleted {
|
|
5321
|
-
/** A deletion context. */
|
|
5322
|
-
deleteContext?: DeleteContext;
|
|
5323
|
-
}
|
|
5324
|
-
interface NamespaceChanged {
|
|
5325
|
-
/** A previous namespace. */
|
|
5326
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
5327
|
-
/** A new namespace. */
|
|
5328
|
-
newNamespace?: NamespaceWithLiterals;
|
|
5329
|
-
}
|
|
5330
|
-
/** Assigned Studio editor */
|
|
5331
|
-
interface StudioAssigned {
|
|
5189
|
+
restockLocations?: RestockLocation[];
|
|
5332
5190
|
}
|
|
5333
|
-
|
|
5334
|
-
|
|
5191
|
+
interface TriggerRefundResponse {
|
|
5192
|
+
/** All order's transactions after the refunds were added */
|
|
5193
|
+
orderTransactions?: OrderTransactions;
|
|
5194
|
+
/** Created refund ID */
|
|
5195
|
+
refundId?: string | null;
|
|
5196
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5197
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5335
5198
|
}
|
|
5336
5199
|
/**
|
|
5337
|
-
*
|
|
5338
|
-
*
|
|
5339
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5340
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5200
|
+
* A record of all payments and refunds associated with an order.
|
|
5341
5201
|
*
|
|
5342
|
-
*
|
|
5343
|
-
*/
|
|
5344
|
-
interface SiteUrlChanged {
|
|
5345
|
-
}
|
|
5346
|
-
/**
|
|
5347
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5348
|
-
* Consumed by other teams to remove relevant data.
|
|
5202
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5349
5203
|
*/
|
|
5350
|
-
interface
|
|
5351
|
-
/**
|
|
5352
|
-
* @maxLength 2048
|
|
5353
|
-
* @maxSize 100
|
|
5354
|
-
* @deprecated
|
|
5355
|
-
* @targetRemovalDate 2025-04-15
|
|
5356
|
-
*/
|
|
5357
|
-
appDefId?: string[];
|
|
5358
|
-
}
|
|
5359
|
-
/** Assigned Odeditor */
|
|
5360
|
-
interface OdeditorAssigned {
|
|
5361
|
-
}
|
|
5362
|
-
/** Unassigned Odeditor */
|
|
5363
|
-
interface OdeditorUnassigned {
|
|
5364
|
-
}
|
|
5365
|
-
/** Assigned Picasso editor */
|
|
5366
|
-
interface PicassoAssigned {
|
|
5367
|
-
}
|
|
5368
|
-
/** Unassigned Picasso */
|
|
5369
|
-
interface PicassoUnassigned {
|
|
5370
|
-
}
|
|
5371
|
-
/** Assigned Wixel */
|
|
5372
|
-
interface WixelAssigned {
|
|
5373
|
-
}
|
|
5374
|
-
/** Unassigned Wixel */
|
|
5375
|
-
interface WixelUnassigned {
|
|
5376
|
-
}
|
|
5377
|
-
/** Assigned StudioTwo */
|
|
5378
|
-
interface StudioTwoAssigned {
|
|
5379
|
-
}
|
|
5380
|
-
/** Unassigned StudioTwo */
|
|
5381
|
-
interface StudioTwoUnassigned {
|
|
5382
|
-
}
|
|
5383
|
-
/** Media from user domain is enabled. */
|
|
5384
|
-
interface UserDomainMediaEnabled {
|
|
5385
|
-
}
|
|
5386
|
-
/** Media from user domain is disabled. */
|
|
5387
|
-
interface UserDomainMediaDisabled {
|
|
5388
|
-
}
|
|
5389
|
-
/** Assigned Editorless */
|
|
5390
|
-
interface EditorlessAssigned {
|
|
5391
|
-
}
|
|
5392
|
-
/** Unassigned Editorless */
|
|
5393
|
-
interface EditorlessUnassigned {
|
|
5394
|
-
}
|
|
5395
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
5396
|
-
}
|
|
5397
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
5398
|
-
hasCustomConfigurations?: boolean;
|
|
5399
|
-
}
|
|
5400
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
5401
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
5402
|
-
sendCustomEmailConfigs?: boolean;
|
|
5403
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5404
|
-
origin?: OriginWithLiterals;
|
|
5405
|
-
}
|
|
5406
|
-
declare enum Origin {
|
|
5407
|
-
OPT_IN = "OPT_IN",
|
|
5408
|
-
MIGRATION = "MIGRATION"
|
|
5409
|
-
}
|
|
5410
|
-
/** @enumType */
|
|
5411
|
-
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
5412
|
-
interface AddToAutomationMigrationPopulationResponse {
|
|
5413
|
-
success?: boolean;
|
|
5414
|
-
}
|
|
5415
|
-
interface IsInAutomationMigrationPopulationRequest {
|
|
5416
|
-
}
|
|
5417
|
-
interface IsInAutomationMigrationPopulationResponse {
|
|
5418
|
-
inPopulation?: boolean;
|
|
5419
|
-
}
|
|
5420
|
-
interface PreparePaymentCollectionRequest {
|
|
5204
|
+
interface OrderTransactions {
|
|
5421
5205
|
/**
|
|
5422
|
-
*
|
|
5423
|
-
* @
|
|
5424
|
-
* @maxLength 100
|
|
5206
|
+
* Order ID.
|
|
5207
|
+
* @format GUID
|
|
5425
5208
|
*/
|
|
5426
|
-
|
|
5427
|
-
/** Amount to collect */
|
|
5428
|
-
amount: Price;
|
|
5209
|
+
orderId?: string;
|
|
5429
5210
|
/**
|
|
5430
|
-
*
|
|
5431
|
-
*
|
|
5432
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
5211
|
+
* Record of payments made to the merchant.
|
|
5212
|
+
* @maxSize 100
|
|
5433
5213
|
*/
|
|
5434
|
-
|
|
5214
|
+
payments?: Payment[];
|
|
5435
5215
|
/**
|
|
5436
|
-
*
|
|
5437
|
-
*
|
|
5438
|
-
* @deprecated Whether to delay capture of the payment.
|
|
5439
|
-
* Default: false
|
|
5440
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
5441
|
-
* @targetRemovalDate 2024-09-30
|
|
5216
|
+
* Record of refunds made to the buyer.
|
|
5217
|
+
* @maxSize 300
|
|
5442
5218
|
*/
|
|
5443
|
-
|
|
5219
|
+
refunds?: Refund[];
|
|
5220
|
+
}
|
|
5221
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
5222
|
+
/** Regular payment details. */
|
|
5223
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5224
|
+
/** Gift card payment details. */
|
|
5225
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5226
|
+
/** Membership payment details. */
|
|
5227
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5444
5228
|
/**
|
|
5445
|
-
*
|
|
5446
|
-
* Default: `true`
|
|
5229
|
+
* Receipt created by Wix
|
|
5447
5230
|
* @internal
|
|
5448
5231
|
*/
|
|
5449
|
-
|
|
5232
|
+
wixReceipt?: WixReceiptInfo;
|
|
5450
5233
|
/**
|
|
5451
|
-
*
|
|
5234
|
+
* Receipt created by an external system.
|
|
5452
5235
|
* @internal
|
|
5453
5236
|
*/
|
|
5454
|
-
|
|
5455
|
-
/**
|
|
5456
|
-
|
|
5457
|
-
|
|
5458
|
-
|
|
5237
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5238
|
+
/** @internal */
|
|
5239
|
+
canceled?: CanceledStatusDetails;
|
|
5240
|
+
/** @internal */
|
|
5241
|
+
declined?: DeclinedStatusDetails;
|
|
5242
|
+
/** @internal */
|
|
5243
|
+
voided?: VoidedStatusDetails;
|
|
5459
5244
|
/**
|
|
5460
|
-
*
|
|
5461
|
-
* @format
|
|
5245
|
+
* Payment ID.
|
|
5246
|
+
* @format GUID
|
|
5247
|
+
* @readonly
|
|
5462
5248
|
*/
|
|
5463
|
-
|
|
5249
|
+
id?: string | null;
|
|
5250
|
+
/** 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. */
|
|
5251
|
+
createdDate?: Date | null;
|
|
5464
5252
|
/**
|
|
5465
|
-
*
|
|
5466
|
-
* @
|
|
5253
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5254
|
+
* @readonly
|
|
5467
5255
|
*/
|
|
5468
|
-
|
|
5256
|
+
updatedDate?: Date | null;
|
|
5257
|
+
/** Payment amount. */
|
|
5258
|
+
amount?: Price;
|
|
5469
5259
|
/**
|
|
5470
|
-
*
|
|
5471
|
-
*
|
|
5260
|
+
* Whether refunds for this payment are disabled.
|
|
5261
|
+
* + `true`: This payment is not refundable.
|
|
5262
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5472
5263
|
*/
|
|
5473
|
-
|
|
5264
|
+
refundDisabled?: boolean;
|
|
5474
5265
|
/**
|
|
5475
|
-
*
|
|
5476
|
-
*
|
|
5266
|
+
* Whether receipt generation is allowed for this payment.
|
|
5267
|
+
* + `true`: This payment supports receipt generation.
|
|
5268
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5269
|
+
* @readonly
|
|
5477
5270
|
*/
|
|
5478
|
-
|
|
5479
|
-
|
|
5480
|
-
|
|
5481
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
5482
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
5483
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
5484
|
-
delayDuration?: Duration;
|
|
5485
|
-
}
|
|
5486
|
-
declare enum ScheduledAction {
|
|
5487
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
5488
|
-
VOID = "VOID",
|
|
5489
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
5490
|
-
CAPTURE = "CAPTURE"
|
|
5491
|
-
}
|
|
5492
|
-
/** @enumType */
|
|
5493
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
5494
|
-
interface Duration {
|
|
5271
|
+
supportReceiptGeneration?: boolean;
|
|
5272
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5273
|
+
cashRounding?: CashRoundingDetails;
|
|
5495
5274
|
/**
|
|
5496
|
-
*
|
|
5497
|
-
*
|
|
5275
|
+
* Overall payment status.
|
|
5276
|
+
*
|
|
5277
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
5498
5278
|
*/
|
|
5499
|
-
|
|
5500
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
5501
|
-
unit?: DurationUnitWithLiterals;
|
|
5502
|
-
}
|
|
5503
|
-
declare enum DurationUnit {
|
|
5504
|
-
MINUTES = "MINUTES",
|
|
5505
|
-
HOURS = "HOURS",
|
|
5506
|
-
DAYS = "DAYS"
|
|
5507
|
-
}
|
|
5508
|
-
/** @enumType */
|
|
5509
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
5510
|
-
interface PreparePaymentCollectionResponse {
|
|
5511
|
-
/** Payment gateway order id which is associated with given payment */
|
|
5512
|
-
paymentGatewayOrderId?: string;
|
|
5513
|
-
}
|
|
5514
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
5279
|
+
status?: PaymentStatusWithLiterals;
|
|
5515
5280
|
/**
|
|
5516
|
-
*
|
|
5517
|
-
* @
|
|
5518
|
-
* @maxLength 100
|
|
5281
|
+
* Detailed payment status information including gateway reason codes and status-specific details.
|
|
5282
|
+
* @internal
|
|
5519
5283
|
*/
|
|
5520
|
-
|
|
5521
|
-
}
|
|
5522
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
5523
|
-
/** Payment collectability status */
|
|
5524
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
5525
|
-
/** Collectable order amount */
|
|
5526
|
-
amount?: Price;
|
|
5284
|
+
paymentStatusDetails?: PaymentStatusDetails;
|
|
5527
5285
|
/**
|
|
5528
|
-
*
|
|
5286
|
+
* Location where the payment was processed.
|
|
5529
5287
|
* @internal
|
|
5288
|
+
* @format GUID
|
|
5289
|
+
* @immutable
|
|
5530
5290
|
*/
|
|
5531
|
-
|
|
5291
|
+
locationId?: string | null;
|
|
5532
5292
|
/**
|
|
5533
|
-
*
|
|
5534
|
-
* @
|
|
5293
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
5294
|
+
* @format GUID
|
|
5535
5295
|
*/
|
|
5536
|
-
|
|
5296
|
+
chargeCorrelationId?: string | null;
|
|
5537
5297
|
}
|
|
5538
|
-
|
|
5539
|
-
|
|
5540
|
-
|
|
5541
|
-
|
|
5542
|
-
|
|
5543
|
-
|
|
5544
|
-
|
|
5545
|
-
|
|
5546
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
5547
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
5548
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
5549
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
5550
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
5551
|
-
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
5298
|
+
/** @oneof */
|
|
5299
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5300
|
+
/** Regular payment details. */
|
|
5301
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5302
|
+
/** Gift card payment details. */
|
|
5303
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5304
|
+
/** Membership payment details. */
|
|
5305
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5552
5306
|
}
|
|
5553
|
-
/** @
|
|
5554
|
-
|
|
5555
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
5307
|
+
/** @oneof */
|
|
5308
|
+
interface PaymentReceiptInfoOneOf {
|
|
5556
5309
|
/**
|
|
5557
|
-
*
|
|
5558
|
-
* @
|
|
5559
|
-
* @maxLength 100
|
|
5310
|
+
* Receipt created by Wix
|
|
5311
|
+
* @internal
|
|
5560
5312
|
*/
|
|
5561
|
-
|
|
5562
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
5563
|
-
amount: Price;
|
|
5313
|
+
wixReceipt?: WixReceiptInfo;
|
|
5564
5314
|
/**
|
|
5565
|
-
*
|
|
5566
|
-
*
|
|
5567
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5315
|
+
* Receipt created by an external system.
|
|
5568
5316
|
* @internal
|
|
5569
5317
|
*/
|
|
5570
|
-
|
|
5318
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5571
5319
|
}
|
|
5572
|
-
/**
|
|
5573
|
-
|
|
5574
|
-
|
|
5575
|
-
|
|
5576
|
-
|
|
5577
|
-
|
|
5578
|
-
|
|
5320
|
+
/** @oneof */
|
|
5321
|
+
interface PaymentStatusDetailsOneOf {
|
|
5322
|
+
/** @internal */
|
|
5323
|
+
canceled?: CanceledStatusDetails;
|
|
5324
|
+
/** @internal */
|
|
5325
|
+
declined?: DeclinedStatusDetails;
|
|
5326
|
+
/** @internal */
|
|
5327
|
+
voided?: VoidedStatusDetails;
|
|
5328
|
+
}
|
|
5329
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5330
|
+
/** Credit card details. */
|
|
5331
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5579
5332
|
/**
|
|
5580
|
-
*
|
|
5581
|
-
*
|
|
5582
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5583
|
-
* @minLength 1
|
|
5584
|
-
* @maxLength 150
|
|
5333
|
+
* Wix Payments order ID.
|
|
5334
|
+
* @maxLength 100
|
|
5585
5335
|
*/
|
|
5586
|
-
|
|
5587
|
-
}
|
|
5588
|
-
/** @oneof */
|
|
5589
|
-
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
5590
|
-
/** Predefined payment method. */
|
|
5591
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5336
|
+
paymentOrderId?: string | null;
|
|
5592
5337
|
/**
|
|
5593
|
-
*
|
|
5594
|
-
*
|
|
5595
|
-
*
|
|
5596
|
-
|
|
5338
|
+
* Payment gateway's transaction ID.
|
|
5339
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5340
|
+
* @maxLength 100
|
|
5341
|
+
*/
|
|
5342
|
+
gatewayTransactionId?: string | null;
|
|
5343
|
+
/**
|
|
5344
|
+
* Payment method.
|
|
5345
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5346
|
+
* Non-exhaustive list of supported values:
|
|
5347
|
+
* + `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`
|
|
5597
5348
|
* @maxLength 150
|
|
5349
|
+
* @deprecated Payment method.
|
|
5350
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5351
|
+
* Non-exhaustive list of supported values:
|
|
5352
|
+
* + `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`
|
|
5353
|
+
* @replacedBy payment_method_name
|
|
5354
|
+
* @targetRemovalDate 2026-07-01
|
|
5598
5355
|
*/
|
|
5599
|
-
|
|
5600
|
-
}
|
|
5601
|
-
/** Predefined payment method types for offline/manual payments. */
|
|
5602
|
-
declare enum PredefinedPaymentMethod {
|
|
5603
|
-
/** Cash payment. */
|
|
5604
|
-
CASH = "CASH",
|
|
5605
|
-
/** Bank transfer. */
|
|
5606
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
5607
|
-
/** Payment by check. */
|
|
5608
|
-
CHECK = "CHECK"
|
|
5609
|
-
}
|
|
5610
|
-
/** @enumType */
|
|
5611
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
5612
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
5613
|
-
}
|
|
5614
|
-
interface MarkOrderAsPaidRequest {
|
|
5356
|
+
paymentMethod?: string | null;
|
|
5615
5357
|
/**
|
|
5616
|
-
*
|
|
5617
|
-
* @minLength 1
|
|
5358
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5618
5359
|
* @maxLength 100
|
|
5619
5360
|
*/
|
|
5620
|
-
|
|
5361
|
+
providerTransactionId?: string | null;
|
|
5362
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5363
|
+
offlinePayment?: boolean;
|
|
5621
5364
|
/**
|
|
5622
|
-
* Payment
|
|
5623
|
-
*
|
|
5624
|
-
*
|
|
5365
|
+
* Payment status.
|
|
5366
|
+
* @deprecated Payment status.
|
|
5367
|
+
* @replacedBy payment.status
|
|
5368
|
+
* @targetRemovalDate 2026-11-01
|
|
5369
|
+
*/
|
|
5370
|
+
status?: TransactionStatusWithLiterals;
|
|
5371
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
5372
|
+
savedPaymentMethod?: boolean;
|
|
5373
|
+
/** Authorization details. */
|
|
5374
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5375
|
+
/**
|
|
5376
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
5625
5377
|
* @internal
|
|
5378
|
+
* @maxLength 300
|
|
5626
5379
|
*/
|
|
5627
|
-
|
|
5628
|
-
}
|
|
5629
|
-
interface MarkOrderAsPaidResponse {
|
|
5630
|
-
/** Updated order. */
|
|
5631
|
-
order?: Order;
|
|
5632
|
-
}
|
|
5633
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
5380
|
+
paymentProvider?: string | null;
|
|
5634
5381
|
/**
|
|
5635
|
-
*
|
|
5636
|
-
* @
|
|
5637
|
-
* @maxSize 100
|
|
5638
|
-
* @minLength 1
|
|
5639
|
-
* @maxLength 100
|
|
5382
|
+
* Record of chargebacks made by the buyer.
|
|
5383
|
+
* @maxSize 6
|
|
5640
5384
|
*/
|
|
5641
|
-
|
|
5642
|
-
}
|
|
5643
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
5385
|
+
chargebacks?: Chargeback[];
|
|
5644
5386
|
/**
|
|
5645
|
-
*
|
|
5646
|
-
*
|
|
5387
|
+
* Payment method ID.
|
|
5388
|
+
* @internal
|
|
5389
|
+
* @maxLength 36
|
|
5647
5390
|
*/
|
|
5648
|
-
|
|
5649
|
-
/**
|
|
5650
|
-
|
|
5651
|
-
}
|
|
5652
|
-
interface BulkOrderResult {
|
|
5653
|
-
/** Item metadata. */
|
|
5654
|
-
itemMetadata?: ItemMetadata;
|
|
5391
|
+
paymentMethodId?: string | null;
|
|
5392
|
+
/** Platform fee amount associated with this payment. */
|
|
5393
|
+
platformFee?: Price;
|
|
5655
5394
|
/**
|
|
5656
|
-
*
|
|
5657
|
-
*
|
|
5658
|
-
*
|
|
5395
|
+
* Payment method with buyer and optional owner translations.
|
|
5396
|
+
* Non-exhaustive list of supported values:
|
|
5397
|
+
* + `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`
|
|
5659
5398
|
*/
|
|
5660
|
-
|
|
5661
|
-
}
|
|
5662
|
-
interface ItemMetadata {
|
|
5663
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5664
|
-
id?: string | null;
|
|
5665
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5666
|
-
originalIndex?: number;
|
|
5667
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5668
|
-
success?: boolean;
|
|
5669
|
-
/** Details about the error in case of failure. */
|
|
5670
|
-
error?: ApplicationError;
|
|
5399
|
+
paymentMethodName?: PaymentMethodName;
|
|
5671
5400
|
}
|
|
5672
|
-
|
|
5673
|
-
|
|
5674
|
-
|
|
5675
|
-
|
|
5676
|
-
description?: string;
|
|
5677
|
-
/** Data related to the error. */
|
|
5678
|
-
data?: Record<string, any> | null;
|
|
5401
|
+
/** @oneof */
|
|
5402
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5403
|
+
/** Credit card details. */
|
|
5404
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5679
5405
|
}
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
|
|
5686
|
-
|
|
5406
|
+
declare enum TransactionStatus {
|
|
5407
|
+
UNDEFINED = "UNDEFINED",
|
|
5408
|
+
APPROVED = "APPROVED",
|
|
5409
|
+
PENDING = "PENDING",
|
|
5410
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5411
|
+
CANCELED = "CANCELED",
|
|
5412
|
+
DECLINED = "DECLINED",
|
|
5413
|
+
REFUNDED = "REFUNDED",
|
|
5414
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5415
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5416
|
+
VOIDED = "VOIDED"
|
|
5687
5417
|
}
|
|
5688
|
-
|
|
5418
|
+
/** @enumType */
|
|
5419
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5420
|
+
interface CreditCardPaymentMethodDetails {
|
|
5689
5421
|
/**
|
|
5690
|
-
*
|
|
5691
|
-
* @
|
|
5422
|
+
* The last 4 digits of the card number.
|
|
5423
|
+
* @maxLength 4
|
|
5424
|
+
*/
|
|
5425
|
+
lastFourDigits?: string | null;
|
|
5426
|
+
/**
|
|
5427
|
+
* Card issuer's brand.
|
|
5692
5428
|
* @maxLength 100
|
|
5693
5429
|
*/
|
|
5694
|
-
|
|
5430
|
+
brand?: string | null;
|
|
5695
5431
|
}
|
|
5696
|
-
interface
|
|
5432
|
+
interface AuthorizationDetails {
|
|
5697
5433
|
/**
|
|
5698
|
-
*
|
|
5699
|
-
* @
|
|
5434
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5435
|
+
* @readonly
|
|
5700
5436
|
*/
|
|
5701
|
-
|
|
5437
|
+
delayedCapture?: boolean;
|
|
5438
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5439
|
+
authorizedDate?: Date | null;
|
|
5702
5440
|
/**
|
|
5703
|
-
*
|
|
5704
|
-
*
|
|
5441
|
+
* List of captures associated with payment
|
|
5442
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5443
|
+
* @maxSize 1
|
|
5705
5444
|
*/
|
|
5706
|
-
|
|
5445
|
+
captures?: AuthorizationCapture[];
|
|
5446
|
+
/** Void associated with payment */
|
|
5447
|
+
void?: AuthorizationVoid;
|
|
5448
|
+
/** Scheduled action for this transaction */
|
|
5449
|
+
scheduledAction?: V1ScheduledAction;
|
|
5707
5450
|
}
|
|
5708
|
-
interface
|
|
5709
|
-
/**
|
|
5710
|
-
|
|
5711
|
-
|
|
5712
|
-
|
|
5713
|
-
|
|
5714
|
-
|
|
5715
|
-
/**
|
|
5716
|
-
|
|
5717
|
-
/**
|
|
5718
|
-
|
|
5451
|
+
interface AuthorizationCapture {
|
|
5452
|
+
/**
|
|
5453
|
+
* Capture ID.
|
|
5454
|
+
* @format GUID
|
|
5455
|
+
* @readonly
|
|
5456
|
+
*/
|
|
5457
|
+
id?: string | null;
|
|
5458
|
+
/** Status of this capture action */
|
|
5459
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5460
|
+
/**
|
|
5461
|
+
* Amount of this capture
|
|
5462
|
+
* @immutable
|
|
5463
|
+
*/
|
|
5464
|
+
amount?: Price;
|
|
5465
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5466
|
+
createdDate?: Date | null;
|
|
5467
|
+
/** In case of status is FAILED may contain failure details */
|
|
5468
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5719
5469
|
}
|
|
5720
|
-
|
|
5721
|
-
|
|
5722
|
-
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5470
|
+
declare enum AuthorizationCaptureStatus {
|
|
5471
|
+
/** Capture operation still in progress. */
|
|
5472
|
+
PENDING = "PENDING",
|
|
5473
|
+
/** Capture operation succeeded. */
|
|
5474
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5475
|
+
/** Capture operation failed. */
|
|
5476
|
+
FAILED = "FAILED"
|
|
5726
5477
|
}
|
|
5727
|
-
|
|
5728
|
-
|
|
5729
|
-
|
|
5730
|
-
|
|
5478
|
+
/** @enumType */
|
|
5479
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5480
|
+
interface AuthorizationActionFailureDetails {
|
|
5481
|
+
/** @maxLength 100 */
|
|
5482
|
+
failureCode?: string;
|
|
5483
|
+
}
|
|
5484
|
+
interface AuthorizationVoid {
|
|
5485
|
+
/** Status of this void action */
|
|
5486
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5487
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5488
|
+
voidedDate?: Date | null;
|
|
5489
|
+
/** In case of status is FAILED may contain failure details */
|
|
5490
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5491
|
+
/** Reason of void action */
|
|
5492
|
+
reason?: ReasonWithLiterals;
|
|
5493
|
+
}
|
|
5494
|
+
declare enum AuthorizationVoidStatus {
|
|
5495
|
+
/** Void operation still in progress. */
|
|
5496
|
+
PENDING = "PENDING",
|
|
5497
|
+
/** Void operation succeeded. */
|
|
5498
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5499
|
+
/** Void operation failed. */
|
|
5500
|
+
FAILED = "FAILED"
|
|
5731
5501
|
}
|
|
5732
5502
|
/** @enumType */
|
|
5733
|
-
type
|
|
5734
|
-
|
|
5735
|
-
|
|
5736
|
-
|
|
5737
|
-
|
|
5738
|
-
|
|
5739
|
-
|
|
5740
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5741
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
5742
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5743
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
5744
|
-
FORBIDDEN = "FORBIDDEN",
|
|
5745
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5746
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5747
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5503
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5504
|
+
/** Reason the authorization was voided. */
|
|
5505
|
+
declare enum Reason {
|
|
5506
|
+
/** Authorization was voided by user. */
|
|
5507
|
+
MANUAL = "MANUAL",
|
|
5508
|
+
/** Authorization passed execution date. */
|
|
5509
|
+
SCHEDULED = "SCHEDULED"
|
|
5748
5510
|
}
|
|
5749
5511
|
/** @enumType */
|
|
5750
|
-
type
|
|
5751
|
-
|
|
5752
|
-
|
|
5753
|
-
|
|
5754
|
-
|
|
5755
|
-
|
|
5512
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5513
|
+
interface V1ScheduledAction {
|
|
5514
|
+
/** Type of the action. */
|
|
5515
|
+
actionType?: ActionTypeWithLiterals;
|
|
5516
|
+
/** The date and time of the action. */
|
|
5517
|
+
executionDate?: Date | null;
|
|
5518
|
+
}
|
|
5519
|
+
declare enum ActionType {
|
|
5520
|
+
VOID = "VOID",
|
|
5521
|
+
CAPTURE = "CAPTURE"
|
|
5756
5522
|
}
|
|
5757
5523
|
/** @enumType */
|
|
5758
|
-
type
|
|
5759
|
-
interface
|
|
5524
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5525
|
+
interface Chargeback {
|
|
5760
5526
|
/**
|
|
5761
|
-
*
|
|
5762
|
-
* @
|
|
5763
|
-
* @
|
|
5527
|
+
* Chargeback ID.
|
|
5528
|
+
* @format GUID
|
|
5529
|
+
* @readonly
|
|
5530
|
+
* @immutable
|
|
5764
5531
|
*/
|
|
5765
|
-
|
|
5766
|
-
/** Information about the user who initiated the payment. */
|
|
5767
|
-
chargedBy?: ChargedBy;
|
|
5532
|
+
id?: string;
|
|
5768
5533
|
/**
|
|
5769
|
-
*
|
|
5534
|
+
* 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.
|
|
5535
|
+
* @readonly
|
|
5536
|
+
* @immutable
|
|
5537
|
+
*/
|
|
5538
|
+
createdDate?: Date | null;
|
|
5539
|
+
/**
|
|
5540
|
+
* 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.
|
|
5541
|
+
* @readonly
|
|
5542
|
+
*/
|
|
5543
|
+
updatedDate?: Date | null;
|
|
5544
|
+
/**
|
|
5545
|
+
* Amount.
|
|
5546
|
+
* @readonly
|
|
5547
|
+
* @immutable
|
|
5548
|
+
*/
|
|
5549
|
+
amount?: Price;
|
|
5550
|
+
/**
|
|
5551
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5552
|
+
* @readonly
|
|
5553
|
+
*/
|
|
5554
|
+
reversalAmount?: Price;
|
|
5555
|
+
/**
|
|
5556
|
+
* Status.
|
|
5770
5557
|
*
|
|
5771
|
-
* Default:
|
|
5772
|
-
* @internal
|
|
5558
|
+
* Default: `"APPROVED"`.
|
|
5773
5559
|
*/
|
|
5774
|
-
|
|
5775
|
-
}
|
|
5776
|
-
interface ChargedBy {
|
|
5560
|
+
status?: ChargebackStatusWithLiterals;
|
|
5777
5561
|
/**
|
|
5778
|
-
*
|
|
5562
|
+
* External chargeback ID.
|
|
5779
5563
|
* @format GUID
|
|
5564
|
+
* @readonly
|
|
5565
|
+
* @immutable
|
|
5780
5566
|
*/
|
|
5781
|
-
|
|
5567
|
+
externalId?: string | null;
|
|
5568
|
+
}
|
|
5569
|
+
declare enum ChargebackStatus {
|
|
5570
|
+
/** Chargeback was approved. */
|
|
5571
|
+
APPROVED = "APPROVED",
|
|
5572
|
+
/** Chargeback was reversed. */
|
|
5573
|
+
REVERSED = "REVERSED"
|
|
5574
|
+
}
|
|
5575
|
+
/** @enumType */
|
|
5576
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5577
|
+
interface PaymentMethodName {
|
|
5782
5578
|
/**
|
|
5783
|
-
*
|
|
5784
|
-
* @
|
|
5785
|
-
* @maxLength 200
|
|
5579
|
+
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
5580
|
+
* @maxLength 150
|
|
5786
5581
|
*/
|
|
5787
|
-
|
|
5788
|
-
|
|
5789
|
-
|
|
5790
|
-
|
|
5791
|
-
|
|
5582
|
+
buyerLanguageName?: string | null;
|
|
5583
|
+
/**
|
|
5584
|
+
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
5585
|
+
*
|
|
5586
|
+
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
5587
|
+
* @maxLength 150
|
|
5588
|
+
*/
|
|
5589
|
+
siteLanguageName?: string | null;
|
|
5590
|
+
/**
|
|
5591
|
+
* User-provided payment method name.
|
|
5592
|
+
*
|
|
5593
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5594
|
+
*/
|
|
5595
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5792
5596
|
}
|
|
5793
|
-
interface
|
|
5597
|
+
interface GiftCardPaymentDetails {
|
|
5794
5598
|
/**
|
|
5795
|
-
*
|
|
5796
|
-
* @minLength 1
|
|
5599
|
+
* Gift card payment ID.
|
|
5797
5600
|
* @maxLength 100
|
|
5798
5601
|
*/
|
|
5799
|
-
|
|
5602
|
+
giftCardPaymentId?: string;
|
|
5800
5603
|
/**
|
|
5801
|
-
*
|
|
5802
|
-
*
|
|
5604
|
+
* Gift card ID.
|
|
5605
|
+
* @internal
|
|
5606
|
+
* @deprecated
|
|
5607
|
+
*/
|
|
5608
|
+
giftCardId?: string;
|
|
5609
|
+
/**
|
|
5610
|
+
* ID of the app that created the gift card.
|
|
5803
5611
|
* @format GUID
|
|
5804
5612
|
*/
|
|
5805
|
-
|
|
5613
|
+
appId?: string;
|
|
5614
|
+
/**
|
|
5615
|
+
* Whether the gift card is voided.
|
|
5616
|
+
* @readonly
|
|
5617
|
+
* @deprecated Whether the gift card is voided.
|
|
5618
|
+
* @replacedBy payment.status
|
|
5619
|
+
* @targetRemovalDate 2026-11-01
|
|
5620
|
+
*/
|
|
5621
|
+
voided?: boolean;
|
|
5806
5622
|
/**
|
|
5807
|
-
*
|
|
5808
|
-
* @
|
|
5809
|
-
* @
|
|
5623
|
+
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
5624
|
+
* @maxLength 30
|
|
5625
|
+
* @immutable
|
|
5810
5626
|
*/
|
|
5811
|
-
|
|
5627
|
+
obfuscatedCode?: string | null;
|
|
5812
5628
|
}
|
|
5813
|
-
interface
|
|
5629
|
+
interface MembershipPaymentDetails {
|
|
5814
5630
|
/**
|
|
5815
|
-
*
|
|
5816
|
-
* @
|
|
5817
|
-
* @maxLength 100
|
|
5631
|
+
* Membership ID.
|
|
5632
|
+
* @maxLength 200
|
|
5818
5633
|
*/
|
|
5819
5634
|
membershipId?: string;
|
|
5820
5635
|
/**
|
|
5821
|
-
* ID of the
|
|
5822
|
-
* @
|
|
5636
|
+
* ID of the line item this membership applies to.
|
|
5637
|
+
* @minLength 1
|
|
5638
|
+
* @maxLength 100
|
|
5823
5639
|
*/
|
|
5824
|
-
|
|
5825
|
-
/** The name of used membership */
|
|
5826
|
-
membershipName?: MembershipName;
|
|
5827
|
-
/** Additional data about this membership */
|
|
5828
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
5829
|
-
/** Catalog and item reference info. */
|
|
5830
|
-
catalogReference?: CatalogReference;
|
|
5831
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5832
|
-
serviceProperties?: ServiceProperties;
|
|
5640
|
+
lineItemId?: string;
|
|
5833
5641
|
/**
|
|
5834
|
-
*
|
|
5835
|
-
*
|
|
5836
|
-
*
|
|
5837
|
-
* @
|
|
5838
|
-
* @maxLength 36
|
|
5642
|
+
* Payment status.
|
|
5643
|
+
* @deprecated Payment status.
|
|
5644
|
+
* @replacedBy payment.status
|
|
5645
|
+
* @targetRemovalDate 2026-11-01
|
|
5839
5646
|
*/
|
|
5840
|
-
|
|
5647
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5648
|
+
/** Membership name. */
|
|
5649
|
+
name?: MembershipName;
|
|
5841
5650
|
/**
|
|
5842
|
-
*
|
|
5651
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5843
5652
|
* @minLength 1
|
|
5844
5653
|
* @maxLength 100
|
|
5845
5654
|
*/
|
|
5846
|
-
|
|
5847
|
-
}
|
|
5848
|
-
interface MembershipName {
|
|
5655
|
+
externalTransactionId?: string | null;
|
|
5849
5656
|
/**
|
|
5850
|
-
*
|
|
5851
|
-
* @
|
|
5657
|
+
* Whether the membership is voided.
|
|
5658
|
+
* @readonly
|
|
5659
|
+
* @deprecated Whether the membership is voided.
|
|
5660
|
+
* @replacedBy payment.status
|
|
5661
|
+
* @targetRemovalDate 2026-11-01
|
|
5852
5662
|
*/
|
|
5853
|
-
|
|
5663
|
+
voided?: boolean;
|
|
5854
5664
|
/**
|
|
5855
|
-
*
|
|
5856
|
-
*
|
|
5857
|
-
* Default: The value of `original`
|
|
5858
|
-
* @maxLength 100
|
|
5665
|
+
* ID of the application providing this payment option.
|
|
5666
|
+
* @format GUID
|
|
5859
5667
|
*/
|
|
5860
|
-
|
|
5668
|
+
providerAppId?: string;
|
|
5669
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5670
|
+
futureMembership?: FutureMembershipDetails;
|
|
5861
5671
|
}
|
|
5862
|
-
|
|
5672
|
+
declare enum MembershipPaymentStatus {
|
|
5673
|
+
/** Payment was charged. */
|
|
5674
|
+
CHARGED = "CHARGED",
|
|
5675
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5676
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5677
|
+
/** Payment is pending. */
|
|
5678
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5679
|
+
/** Payment was voided. */
|
|
5680
|
+
VOIDED = "VOIDED"
|
|
5863
5681
|
}
|
|
5864
|
-
|
|
5682
|
+
/** @enumType */
|
|
5683
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5684
|
+
interface FutureMembershipDetails {
|
|
5865
5685
|
/**
|
|
5866
|
-
*
|
|
5867
|
-
* @
|
|
5868
|
-
* @maxLength 100
|
|
5686
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
5687
|
+
* @format GUID
|
|
5869
5688
|
*/
|
|
5870
|
-
|
|
5689
|
+
lineItemId?: string;
|
|
5871
5690
|
/**
|
|
5872
|
-
*
|
|
5873
|
-
* @
|
|
5874
|
-
* @maxSize 1
|
|
5691
|
+
* ID of the benefit the future membership will grant.
|
|
5692
|
+
* @maxLength 200
|
|
5875
5693
|
*/
|
|
5876
|
-
|
|
5877
|
-
/** Business model of a refund */
|
|
5878
|
-
details?: RefundDetails;
|
|
5879
|
-
/** Side effect details related to refund */
|
|
5880
|
-
sideEffects?: RefundSideEffects;
|
|
5694
|
+
benefitId?: string;
|
|
5881
5695
|
}
|
|
5882
|
-
interface
|
|
5696
|
+
interface WixReceiptInfo {
|
|
5883
5697
|
/**
|
|
5884
|
-
*
|
|
5698
|
+
* Receipt ID
|
|
5885
5699
|
* @format GUID
|
|
5886
5700
|
*/
|
|
5887
|
-
|
|
5888
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5889
|
-
amount?: Price;
|
|
5890
|
-
/**
|
|
5891
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5892
|
-
* 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.
|
|
5893
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5894
|
-
*/
|
|
5895
|
-
externalRefund?: boolean;
|
|
5701
|
+
receiptId?: string;
|
|
5896
5702
|
/**
|
|
5897
|
-
*
|
|
5898
|
-
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
5899
|
-
* and all side effects from request will be executed.
|
|
5900
|
-
* @internal
|
|
5703
|
+
* Display number of receipt
|
|
5901
5704
|
* @minLength 1
|
|
5902
|
-
* @maxLength
|
|
5705
|
+
* @maxLength 40
|
|
5903
5706
|
*/
|
|
5904
|
-
|
|
5707
|
+
displayNumber?: string | null;
|
|
5905
5708
|
}
|
|
5906
|
-
interface
|
|
5907
|
-
/** Inventory restock details as part of this refund. */
|
|
5908
|
-
restockInfo?: RestockInfo;
|
|
5909
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
5910
|
-
sendOrderRefundedEmail?: boolean;
|
|
5709
|
+
interface ExternalReceiptInfo {
|
|
5911
5710
|
/**
|
|
5912
|
-
*
|
|
5913
|
-
* @
|
|
5914
|
-
* @maxLength 1000
|
|
5711
|
+
* External receipt ID
|
|
5712
|
+
* @maxLength 100
|
|
5915
5713
|
*/
|
|
5916
|
-
|
|
5917
|
-
}
|
|
5918
|
-
interface RestockInfo {
|
|
5919
|
-
/** Restock type. */
|
|
5920
|
-
type?: RestockTypeWithLiterals;
|
|
5714
|
+
receiptId?: string | null;
|
|
5921
5715
|
/**
|
|
5922
|
-
*
|
|
5923
|
-
* @
|
|
5924
|
-
* @maxSize 300
|
|
5925
|
-
* @deprecated
|
|
5716
|
+
* ID of the app providing the receipt
|
|
5717
|
+
* @format GUID
|
|
5926
5718
|
*/
|
|
5927
|
-
|
|
5719
|
+
appId?: string | null;
|
|
5928
5720
|
/**
|
|
5929
|
-
*
|
|
5930
|
-
* @
|
|
5721
|
+
* Display number of receipt
|
|
5722
|
+
* @minLength 1
|
|
5723
|
+
* @maxLength 40
|
|
5931
5724
|
*/
|
|
5932
|
-
|
|
5933
|
-
}
|
|
5934
|
-
declare enum RestockType {
|
|
5935
|
-
NO_ITEMS = "NO_ITEMS",
|
|
5936
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
5937
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
5725
|
+
displayNumber?: string | null;
|
|
5938
5726
|
}
|
|
5939
|
-
|
|
5940
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5941
|
-
interface RestockItem {
|
|
5727
|
+
interface CashRoundingDetails {
|
|
5942
5728
|
/**
|
|
5943
|
-
*
|
|
5944
|
-
*
|
|
5729
|
+
* Payment amount before cash rounding was applied.
|
|
5730
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
5731
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
5945
5732
|
*/
|
|
5946
|
-
|
|
5733
|
+
unroundedAmount?: Price;
|
|
5947
5734
|
/**
|
|
5948
|
-
*
|
|
5949
|
-
*
|
|
5950
|
-
* @
|
|
5735
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
5736
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
5737
|
+
* @readonly
|
|
5951
5738
|
*/
|
|
5952
|
-
|
|
5739
|
+
roundingAdjustment?: CashRounding;
|
|
5740
|
+
}
|
|
5741
|
+
declare enum PaymentStatus {
|
|
5742
|
+
/** Payment was charged successfully. */
|
|
5743
|
+
APPROVED = "APPROVED",
|
|
5744
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5745
|
+
PENDING = "PENDING",
|
|
5746
|
+
/** 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. */
|
|
5747
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5748
|
+
/** Payment was canceled before it was charged. */
|
|
5749
|
+
CANCELED = "CANCELED",
|
|
5750
|
+
/** Payment was declined by the payment provider. */
|
|
5751
|
+
DECLINED = "DECLINED",
|
|
5752
|
+
/** Payment was fully refunded. */
|
|
5753
|
+
REFUNDED = "REFUNDED",
|
|
5754
|
+
/** Part of the payment amount was refunded. */
|
|
5755
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5756
|
+
/** 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. */
|
|
5757
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5953
5758
|
/**
|
|
5954
|
-
*
|
|
5955
|
-
*
|
|
5956
|
-
*
|
|
5759
|
+
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
5760
|
+
*
|
|
5761
|
+
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
5957
5762
|
*/
|
|
5958
|
-
|
|
5763
|
+
VOIDED = "VOIDED"
|
|
5959
5764
|
}
|
|
5960
|
-
|
|
5961
|
-
|
|
5962
|
-
|
|
5963
|
-
|
|
5964
|
-
refundId?: string | null;
|
|
5965
|
-
/** Payment ID's that the refund execution had failed for */
|
|
5966
|
-
failedPaymentIds?: ItemMetadata[];
|
|
5765
|
+
/** @enumType */
|
|
5766
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5767
|
+
interface CanceledStatusDetails {
|
|
5768
|
+
reason?: CanceledReasonWithLiterals;
|
|
5967
5769
|
}
|
|
5968
|
-
|
|
5969
|
-
|
|
5970
|
-
|
|
5971
|
-
|
|
5972
|
-
|
|
5973
|
-
|
|
5974
|
-
|
|
5975
|
-
|
|
5976
|
-
|
|
5977
|
-
|
|
5978
|
-
|
|
5979
|
-
|
|
5980
|
-
|
|
5981
|
-
|
|
5982
|
-
|
|
5983
|
-
|
|
5984
|
-
/**
|
|
5985
|
-
|
|
5986
|
-
|
|
5987
|
-
|
|
5988
|
-
refunds?: Refund[];
|
|
5770
|
+
declare enum CanceledReason {
|
|
5771
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5772
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5773
|
+
/** Payment was not completed by user and expired. */
|
|
5774
|
+
EXPIRED = "EXPIRED"
|
|
5775
|
+
}
|
|
5776
|
+
/** @enumType */
|
|
5777
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5778
|
+
interface DeclinedStatusDetails {
|
|
5779
|
+
reason?: DeclinedReasonWithLiterals;
|
|
5780
|
+
}
|
|
5781
|
+
declare enum DeclinedReason {
|
|
5782
|
+
/** Corresponding charge failed. */
|
|
5783
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5784
|
+
/** Payment details expired. */
|
|
5785
|
+
EXPIRED = "EXPIRED",
|
|
5786
|
+
/** Insufficient funds. */
|
|
5787
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5788
|
+
/** Gift card was disabled before charge was attempted. */
|
|
5789
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5989
5790
|
}
|
|
5990
|
-
|
|
5991
|
-
|
|
5992
|
-
|
|
5993
|
-
|
|
5994
|
-
|
|
5995
|
-
|
|
5996
|
-
|
|
5997
|
-
|
|
5998
|
-
|
|
5999
|
-
|
|
6000
|
-
|
|
6001
|
-
|
|
5791
|
+
/** @enumType */
|
|
5792
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
5793
|
+
interface VoidedStatusDetails {
|
|
5794
|
+
reason?: VoidedReasonWithLiterals;
|
|
5795
|
+
}
|
|
5796
|
+
declare enum VoidedReason {
|
|
5797
|
+
/** Payment was voided by merchant request. */
|
|
5798
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5799
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5800
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5801
|
+
}
|
|
5802
|
+
/** @enumType */
|
|
5803
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
5804
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
5805
|
+
/** @internal */
|
|
5806
|
+
canceled?: CanceledStatusDetails;
|
|
5807
|
+
/** @internal */
|
|
5808
|
+
declined?: DeclinedStatusDetails;
|
|
5809
|
+
/** @internal */
|
|
5810
|
+
voided?: VoidedStatusDetails;
|
|
6002
5811
|
/**
|
|
6003
|
-
*
|
|
5812
|
+
* Reason code from the payment gateway.
|
|
6004
5813
|
* @internal
|
|
5814
|
+
* @minLength 1
|
|
5815
|
+
* @maxLength 10
|
|
6005
5816
|
*/
|
|
6006
|
-
|
|
5817
|
+
paymentGatewayReasonCode?: string | null;
|
|
5818
|
+
}
|
|
5819
|
+
/** @oneof */
|
|
5820
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
6007
5821
|
/** @internal */
|
|
6008
5822
|
canceled?: CanceledStatusDetails;
|
|
6009
5823
|
/** @internal */
|
|
6010
5824
|
declined?: DeclinedStatusDetails;
|
|
6011
5825
|
/** @internal */
|
|
6012
5826
|
voided?: VoidedStatusDetails;
|
|
5827
|
+
}
|
|
5828
|
+
interface Refund {
|
|
6013
5829
|
/**
|
|
6014
|
-
*
|
|
5830
|
+
* Refund ID.
|
|
6015
5831
|
* @format GUID
|
|
6016
5832
|
* @readonly
|
|
6017
5833
|
*/
|
|
6018
|
-
id?: string
|
|
6019
|
-
/** 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. */
|
|
6020
|
-
createdDate?: Date | null;
|
|
5834
|
+
id?: string;
|
|
6021
5835
|
/**
|
|
6022
|
-
*
|
|
6023
|
-
* @
|
|
5836
|
+
* List of transactions.
|
|
5837
|
+
* @maxSize 50
|
|
6024
5838
|
*/
|
|
6025
|
-
|
|
6026
|
-
/**
|
|
6027
|
-
|
|
5839
|
+
transactions?: RefundTransaction[];
|
|
5840
|
+
/** Refund business details. */
|
|
5841
|
+
details?: RefundDetails;
|
|
6028
5842
|
/**
|
|
6029
|
-
*
|
|
6030
|
-
*
|
|
6031
|
-
*
|
|
5843
|
+
* 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.
|
|
5844
|
+
* @readonly
|
|
5845
|
+
* @immutable
|
|
6032
5846
|
*/
|
|
6033
|
-
|
|
5847
|
+
createdDate?: Date | null;
|
|
6034
5848
|
/**
|
|
6035
|
-
*
|
|
6036
|
-
* + `true`: This payment supports receipt generation.
|
|
6037
|
-
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5849
|
+
* Aggregated refund summary.
|
|
6038
5850
|
* @readonly
|
|
6039
5851
|
*/
|
|
6040
|
-
|
|
6041
|
-
/** Details about cash rounding applied to this payment, when relevant. */
|
|
6042
|
-
cashRounding?: CashRoundingDetails;
|
|
5852
|
+
summary?: AggregatedRefundSummary;
|
|
6043
5853
|
/**
|
|
6044
|
-
*
|
|
6045
|
-
*
|
|
6046
|
-
*
|
|
5854
|
+
* ID of the app that initiated this refund.
|
|
5855
|
+
* @format GUID
|
|
5856
|
+
* @readonly
|
|
5857
|
+
* @immutable
|
|
6047
5858
|
*/
|
|
6048
|
-
|
|
5859
|
+
requestingServiceAppId?: string | null;
|
|
5860
|
+
}
|
|
5861
|
+
interface RefundTransaction {
|
|
6049
5862
|
/**
|
|
6050
|
-
*
|
|
6051
|
-
* @
|
|
5863
|
+
* ID of the payment associated with this refund.
|
|
5864
|
+
* @format GUID
|
|
5865
|
+
* @immutable
|
|
6052
5866
|
*/
|
|
6053
|
-
|
|
5867
|
+
paymentId?: string;
|
|
6054
5868
|
/**
|
|
6055
|
-
*
|
|
6056
|
-
* @internal
|
|
6057
|
-
* @format GUID
|
|
5869
|
+
* Refund amount.
|
|
6058
5870
|
* @immutable
|
|
6059
5871
|
*/
|
|
6060
|
-
|
|
5872
|
+
amount?: Price;
|
|
5873
|
+
/** Refund status. */
|
|
5874
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5875
|
+
/** Optional details of current refund status. */
|
|
5876
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
6061
5877
|
/**
|
|
6062
|
-
*
|
|
5878
|
+
* Payment gateway's refund ID.
|
|
5879
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
6063
5880
|
* @format GUID
|
|
6064
5881
|
*/
|
|
6065
|
-
|
|
6066
|
-
|
|
6067
|
-
|
|
6068
|
-
interface PaymentPaymentDetailsOneOf {
|
|
6069
|
-
/** Regular payment details. */
|
|
6070
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
6071
|
-
/** Gift card payment details. */
|
|
6072
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
6073
|
-
/** Membership payment details. */
|
|
6074
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
6075
|
-
}
|
|
6076
|
-
/** @oneof */
|
|
6077
|
-
interface PaymentReceiptInfoOneOf {
|
|
5882
|
+
gatewayRefundId?: string | null;
|
|
5883
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5884
|
+
providerRefundId?: string | null;
|
|
6078
5885
|
/**
|
|
6079
|
-
*
|
|
6080
|
-
* @
|
|
5886
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5887
|
+
* @immutable
|
|
6081
5888
|
*/
|
|
6082
|
-
|
|
5889
|
+
externalRefund?: boolean;
|
|
6083
5890
|
/**
|
|
6084
|
-
*
|
|
5891
|
+
* Location where the refund was processed.
|
|
6085
5892
|
* @internal
|
|
5893
|
+
* @format GUID
|
|
5894
|
+
* @immutable
|
|
6086
5895
|
*/
|
|
6087
|
-
|
|
5896
|
+
locationId?: string | null;
|
|
6088
5897
|
}
|
|
6089
|
-
/**
|
|
6090
|
-
|
|
6091
|
-
/**
|
|
6092
|
-
|
|
6093
|
-
/**
|
|
6094
|
-
|
|
6095
|
-
/**
|
|
6096
|
-
|
|
5898
|
+
/** Refund transaction status. */
|
|
5899
|
+
declare enum RefundStatus {
|
|
5900
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5901
|
+
PENDING = "PENDING",
|
|
5902
|
+
/** Refund transaction succeeded. */
|
|
5903
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5904
|
+
/** Refund transaction failed. */
|
|
5905
|
+
FAILED = "FAILED",
|
|
5906
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
5907
|
+
SCHEDULED = "SCHEDULED",
|
|
5908
|
+
/** Refund was initiated on payment provider side. */
|
|
5909
|
+
STARTED = "STARTED"
|
|
6097
5910
|
}
|
|
6098
|
-
|
|
6099
|
-
|
|
6100
|
-
|
|
5911
|
+
/** @enumType */
|
|
5912
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5913
|
+
interface RefundStatusInfo {
|
|
6101
5914
|
/**
|
|
6102
|
-
*
|
|
6103
|
-
*
|
|
5915
|
+
* Reason code for the refund's current status.
|
|
5916
|
+
*
|
|
5917
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5918
|
+
* @minLength 1
|
|
5919
|
+
* @maxLength 10
|
|
6104
5920
|
*/
|
|
6105
|
-
|
|
5921
|
+
paymentGatewayReasonCode?: string | null;
|
|
6106
5922
|
/**
|
|
6107
|
-
*
|
|
6108
|
-
*
|
|
6109
|
-
* @maxLength
|
|
5923
|
+
* Free text explanation of current refund status.
|
|
5924
|
+
* @minLength 1
|
|
5925
|
+
* @maxLength 1000
|
|
6110
5926
|
*/
|
|
6111
|
-
|
|
5927
|
+
description?: string | null;
|
|
5928
|
+
}
|
|
5929
|
+
interface AggregatedRefundSummary {
|
|
5930
|
+
/** Total amount requested for refund. */
|
|
5931
|
+
requestedRefund?: Price;
|
|
5932
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5933
|
+
pendingRefund?: Price;
|
|
5934
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5935
|
+
refunded?: Price;
|
|
5936
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5937
|
+
failedRefundAmount?: Price;
|
|
5938
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5939
|
+
pending?: boolean;
|
|
5940
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5941
|
+
breakdown?: RefundItemsBreakdown;
|
|
5942
|
+
}
|
|
5943
|
+
interface RefundItemsBreakdown {
|
|
6112
5944
|
/**
|
|
6113
|
-
*
|
|
6114
|
-
*
|
|
6115
|
-
* Non-exhaustive list of supported values:
|
|
6116
|
-
* + `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`
|
|
6117
|
-
* @maxLength 150
|
|
6118
|
-
* @deprecated Payment method.
|
|
6119
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
6120
|
-
* Non-exhaustive list of supported values:
|
|
6121
|
-
* + `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`
|
|
6122
|
-
* @replacedBy payment_method_name
|
|
6123
|
-
* @targetRemovalDate 2026-07-01
|
|
5945
|
+
* Refunded line items and the amount refunded for each.
|
|
5946
|
+
* @maxSize 300
|
|
6124
5947
|
*/
|
|
6125
|
-
|
|
5948
|
+
lineItems?: LineItemRefundSummary[];
|
|
5949
|
+
}
|
|
5950
|
+
interface LineItemRefundSummary {
|
|
6126
5951
|
/**
|
|
6127
|
-
*
|
|
6128
|
-
* @
|
|
5952
|
+
* ID of the refunded line item.
|
|
5953
|
+
* @format GUID
|
|
6129
5954
|
*/
|
|
6130
|
-
|
|
6131
|
-
/**
|
|
6132
|
-
|
|
5955
|
+
lineItemId?: string;
|
|
5956
|
+
/** Total refunded amount for the line item. */
|
|
5957
|
+
totalRefundedAmount?: Price;
|
|
5958
|
+
}
|
|
5959
|
+
interface CalculateRefundRequest {
|
|
6133
5960
|
/**
|
|
6134
|
-
*
|
|
6135
|
-
* @
|
|
6136
|
-
* @
|
|
6137
|
-
* @targetRemovalDate 2026-11-01
|
|
5961
|
+
* Order ID
|
|
5962
|
+
* @minLength 1
|
|
5963
|
+
* @maxLength 100
|
|
6138
5964
|
*/
|
|
6139
|
-
|
|
6140
|
-
/** Whether there is a payment agreement that allows for future charges. */
|
|
6141
|
-
savedPaymentMethod?: boolean;
|
|
6142
|
-
/** Authorization details. */
|
|
6143
|
-
authorizationDetails?: AuthorizationDetails;
|
|
5965
|
+
ecomOrderId?: string;
|
|
6144
5966
|
/**
|
|
6145
|
-
*
|
|
6146
|
-
* @
|
|
6147
|
-
* @maxLength 300
|
|
5967
|
+
* Refunded line items and quantity
|
|
5968
|
+
* @maxSize 300
|
|
6148
5969
|
*/
|
|
6149
|
-
|
|
5970
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5971
|
+
/** Should include shipping in refund calculation */
|
|
5972
|
+
refundShipping?: boolean;
|
|
5973
|
+
}
|
|
5974
|
+
interface CalculateRefundItemRequest {
|
|
6150
5975
|
/**
|
|
6151
|
-
*
|
|
6152
|
-
* @
|
|
5976
|
+
* ID of the line item being refunded
|
|
5977
|
+
* @format GUID
|
|
6153
5978
|
*/
|
|
6154
|
-
|
|
5979
|
+
id?: string;
|
|
6155
5980
|
/**
|
|
6156
|
-
*
|
|
6157
|
-
* @
|
|
6158
|
-
* @
|
|
5981
|
+
* How much of that line item is being refunded
|
|
5982
|
+
* @min 1
|
|
5983
|
+
* @max 100000
|
|
6159
5984
|
*/
|
|
6160
|
-
|
|
6161
|
-
|
|
6162
|
-
|
|
5985
|
+
quantity?: number;
|
|
5986
|
+
}
|
|
5987
|
+
interface CalculateRefundResponse {
|
|
5988
|
+
/** Total refundable amount */
|
|
5989
|
+
total?: Price;
|
|
5990
|
+
/** Tax cost of the order */
|
|
5991
|
+
tax?: Price;
|
|
5992
|
+
/** Discount given for this order */
|
|
5993
|
+
discount?: Price;
|
|
5994
|
+
/** Total cost of the order (without tax) */
|
|
5995
|
+
subtotal?: Price;
|
|
5996
|
+
/** Total shipping cost for order */
|
|
5997
|
+
shipping?: Price;
|
|
5998
|
+
/** Previous refund given on that order */
|
|
5999
|
+
previouslyRefundedAmount?: Price;
|
|
6163
6000
|
/**
|
|
6164
|
-
*
|
|
6165
|
-
*
|
|
6166
|
-
* + `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`
|
|
6001
|
+
* The refundable items of that order
|
|
6002
|
+
* @maxSize 300
|
|
6167
6003
|
*/
|
|
6168
|
-
|
|
6169
|
-
}
|
|
6170
|
-
/** @oneof */
|
|
6171
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
6172
|
-
/** Credit card details. */
|
|
6173
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
6174
|
-
}
|
|
6175
|
-
declare enum TransactionStatus {
|
|
6176
|
-
UNDEFINED = "UNDEFINED",
|
|
6177
|
-
APPROVED = "APPROVED",
|
|
6178
|
-
PENDING = "PENDING",
|
|
6179
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6180
|
-
CANCELED = "CANCELED",
|
|
6181
|
-
DECLINED = "DECLINED",
|
|
6182
|
-
REFUNDED = "REFUNDED",
|
|
6183
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6184
|
-
AUTHORIZED = "AUTHORIZED",
|
|
6185
|
-
VOIDED = "VOIDED"
|
|
6004
|
+
items?: CalculateRefundItemResponse[];
|
|
6186
6005
|
}
|
|
6187
|
-
|
|
6188
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6189
|
-
interface CreditCardPaymentMethodDetails {
|
|
6006
|
+
interface CalculateRefundItemResponse {
|
|
6190
6007
|
/**
|
|
6191
|
-
*
|
|
6192
|
-
* @
|
|
6008
|
+
* Line item ID
|
|
6009
|
+
* @format GUID
|
|
6193
6010
|
*/
|
|
6194
|
-
|
|
6011
|
+
id?: string;
|
|
6012
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6013
|
+
price?: Price;
|
|
6014
|
+
}
|
|
6015
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
6195
6016
|
/**
|
|
6196
|
-
*
|
|
6017
|
+
* Wix eCommerce order ID
|
|
6018
|
+
* @minLength 1
|
|
6197
6019
|
* @maxLength 100
|
|
6198
6020
|
*/
|
|
6199
|
-
|
|
6021
|
+
ecomOrderId: string;
|
|
6022
|
+
/**
|
|
6023
|
+
* Payment IDs
|
|
6024
|
+
* @minSize 1
|
|
6025
|
+
* @maxSize 100
|
|
6026
|
+
* @format GUID
|
|
6027
|
+
*/
|
|
6028
|
+
paymentIds: string[];
|
|
6200
6029
|
}
|
|
6201
|
-
interface
|
|
6030
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
6031
|
+
/** All order's transactions after the void was triggered */
|
|
6032
|
+
orderTransactions?: OrderTransactions;
|
|
6033
|
+
}
|
|
6034
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
6202
6035
|
/**
|
|
6203
|
-
*
|
|
6204
|
-
* @
|
|
6036
|
+
* Wix eCommerce order ID
|
|
6037
|
+
* @minLength 1
|
|
6038
|
+
* @maxLength 100
|
|
6205
6039
|
*/
|
|
6206
|
-
|
|
6207
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6208
|
-
authorizedDate?: Date | null;
|
|
6040
|
+
ecomOrderId: string;
|
|
6209
6041
|
/**
|
|
6210
|
-
*
|
|
6211
|
-
*
|
|
6212
|
-
* @maxSize
|
|
6042
|
+
* Capture payments information
|
|
6043
|
+
* @minSize 1
|
|
6044
|
+
* @maxSize 100
|
|
6213
6045
|
*/
|
|
6214
|
-
|
|
6215
|
-
/** Void associated with payment */
|
|
6216
|
-
void?: AuthorizationVoid;
|
|
6217
|
-
/** Scheduled action for this transaction */
|
|
6218
|
-
scheduledAction?: V1ScheduledAction;
|
|
6046
|
+
payments: PaymentCapture[];
|
|
6219
6047
|
}
|
|
6220
|
-
interface
|
|
6048
|
+
interface PaymentCapture {
|
|
6221
6049
|
/**
|
|
6222
|
-
*
|
|
6050
|
+
* Payment ID
|
|
6223
6051
|
* @format GUID
|
|
6224
|
-
* @readonly
|
|
6225
6052
|
*/
|
|
6226
|
-
|
|
6227
|
-
/** Status of this capture action */
|
|
6228
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
6053
|
+
paymentId?: string | null;
|
|
6229
6054
|
/**
|
|
6230
|
-
*
|
|
6231
|
-
*
|
|
6055
|
+
* Capture amount.
|
|
6056
|
+
* If not provided - full authorized amount will be captured.
|
|
6232
6057
|
*/
|
|
6233
6058
|
amount?: Price;
|
|
6234
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6235
|
-
createdDate?: Date | null;
|
|
6236
|
-
/** In case of status is FAILED may contain failure details */
|
|
6237
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6238
6059
|
}
|
|
6239
|
-
|
|
6240
|
-
/**
|
|
6241
|
-
|
|
6242
|
-
/** Capture operation succeeded. */
|
|
6243
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6244
|
-
/** Capture operation failed. */
|
|
6245
|
-
FAILED = "FAILED"
|
|
6060
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
6061
|
+
/** All order's transactions after the capture was triggered */
|
|
6062
|
+
orderTransactions?: OrderTransactions;
|
|
6246
6063
|
}
|
|
6247
|
-
|
|
6248
|
-
|
|
6249
|
-
|
|
6250
|
-
|
|
6251
|
-
|
|
6064
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
6065
|
+
/**
|
|
6066
|
+
* Ecom Order ID.
|
|
6067
|
+
* @minLength 1
|
|
6068
|
+
* @maxLength 100
|
|
6069
|
+
*/
|
|
6070
|
+
ecomOrderId?: string;
|
|
6071
|
+
/** Amount to be charged */
|
|
6072
|
+
amount?: Price;
|
|
6252
6073
|
}
|
|
6253
|
-
interface
|
|
6254
|
-
/**
|
|
6255
|
-
|
|
6256
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6257
|
-
voidedDate?: Date | null;
|
|
6258
|
-
/** In case of status is FAILED may contain failure details */
|
|
6259
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6260
|
-
/** Reason of void action */
|
|
6261
|
-
reason?: ReasonWithLiterals;
|
|
6074
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
6075
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
6076
|
+
paymentGatewayOrderId?: string;
|
|
6262
6077
|
}
|
|
6263
|
-
|
|
6264
|
-
/**
|
|
6265
|
-
|
|
6266
|
-
/** Void operation succeeded. */
|
|
6267
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6268
|
-
/** Void operation failed. */
|
|
6269
|
-
FAILED = "FAILED"
|
|
6078
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
6079
|
+
/** @format GUID */
|
|
6080
|
+
orderId?: string;
|
|
6270
6081
|
}
|
|
6271
|
-
|
|
6272
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
6273
|
-
/** Reason the authorization was voided. */
|
|
6274
|
-
declare enum Reason {
|
|
6275
|
-
/** Authorization was voided by user. */
|
|
6276
|
-
MANUAL = "MANUAL",
|
|
6277
|
-
/** Authorization passed execution date. */
|
|
6278
|
-
SCHEDULED = "SCHEDULED"
|
|
6082
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
6279
6083
|
}
|
|
6280
|
-
|
|
6281
|
-
|
|
6282
|
-
|
|
6283
|
-
|
|
6284
|
-
|
|
6285
|
-
|
|
6286
|
-
executionDate?: Date | null;
|
|
6084
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
6085
|
+
/**
|
|
6086
|
+
* @minLength 1
|
|
6087
|
+
* @maxLength 100
|
|
6088
|
+
*/
|
|
6089
|
+
orderId?: string;
|
|
6287
6090
|
}
|
|
6288
|
-
|
|
6289
|
-
VOID = "VOID",
|
|
6290
|
-
CAPTURE = "CAPTURE"
|
|
6091
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
6291
6092
|
}
|
|
6292
|
-
|
|
6293
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
6294
|
-
interface Chargeback {
|
|
6093
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
6295
6094
|
/**
|
|
6296
|
-
*
|
|
6297
|
-
* @
|
|
6298
|
-
* @readonly
|
|
6299
|
-
* @immutable
|
|
6095
|
+
* @minLength 1
|
|
6096
|
+
* @maxLength 100
|
|
6300
6097
|
*/
|
|
6301
|
-
|
|
6098
|
+
orderId?: string;
|
|
6099
|
+
}
|
|
6100
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
6101
|
+
}
|
|
6102
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
6302
6103
|
/**
|
|
6303
|
-
*
|
|
6304
|
-
* @
|
|
6305
|
-
* @
|
|
6104
|
+
* IDs of orders to send pickup emails for.
|
|
6105
|
+
* @minSize 1
|
|
6106
|
+
* @maxSize 300
|
|
6306
6107
|
*/
|
|
6307
|
-
|
|
6108
|
+
orderIds?: string[];
|
|
6109
|
+
}
|
|
6110
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
6111
|
+
}
|
|
6112
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
6308
6113
|
/**
|
|
6309
|
-
*
|
|
6310
|
-
* @
|
|
6114
|
+
* @minLength 1
|
|
6115
|
+
* @maxLength 100
|
|
6311
6116
|
*/
|
|
6312
|
-
|
|
6117
|
+
orderId?: string;
|
|
6118
|
+
}
|
|
6119
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
6120
|
+
}
|
|
6121
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
6313
6122
|
/**
|
|
6314
|
-
*
|
|
6315
|
-
* @
|
|
6316
|
-
* @
|
|
6123
|
+
* IDs of orders to send pickup emails for.
|
|
6124
|
+
* @minSize 1
|
|
6125
|
+
* @maxSize 300
|
|
6317
6126
|
*/
|
|
6318
|
-
|
|
6127
|
+
orderIds?: string[];
|
|
6128
|
+
}
|
|
6129
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
6130
|
+
}
|
|
6131
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
6319
6132
|
/**
|
|
6320
|
-
*
|
|
6321
|
-
* @
|
|
6133
|
+
* @minLength 1
|
|
6134
|
+
* @maxLength 100
|
|
6135
|
+
*/
|
|
6136
|
+
orderId?: string;
|
|
6137
|
+
}
|
|
6138
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
6139
|
+
}
|
|
6140
|
+
interface SendCancelRefundEmailRequest {
|
|
6141
|
+
/**
|
|
6142
|
+
* The ID of order that is canceled/refunded
|
|
6143
|
+
* @minLength 1
|
|
6144
|
+
* @maxLength 100
|
|
6322
6145
|
*/
|
|
6323
|
-
|
|
6146
|
+
orderId?: string;
|
|
6324
6147
|
/**
|
|
6325
|
-
*
|
|
6326
|
-
*
|
|
6327
|
-
*
|
|
6148
|
+
* Personal note added to the email (optional)
|
|
6149
|
+
* @minLength 1
|
|
6150
|
+
* @maxLength 1000
|
|
6328
6151
|
*/
|
|
6329
|
-
|
|
6152
|
+
customMessage?: string | null;
|
|
6153
|
+
/** Refund amount */
|
|
6154
|
+
refundAmount?: Price;
|
|
6330
6155
|
/**
|
|
6331
|
-
*
|
|
6156
|
+
* Refund ID. (Optional)
|
|
6332
6157
|
* @format GUID
|
|
6333
|
-
* @readonly
|
|
6334
|
-
* @immutable
|
|
6335
6158
|
*/
|
|
6336
|
-
|
|
6159
|
+
refundId?: string | null;
|
|
6337
6160
|
}
|
|
6338
|
-
|
|
6339
|
-
/** Chargeback was approved. */
|
|
6340
|
-
APPROVED = "APPROVED",
|
|
6341
|
-
/** Chargeback was reversed. */
|
|
6342
|
-
REVERSED = "REVERSED"
|
|
6161
|
+
interface SendCancelRefundEmailResponse {
|
|
6343
6162
|
}
|
|
6344
|
-
|
|
6345
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
6346
|
-
interface PaymentMethodName {
|
|
6163
|
+
interface SendRefundEmailRequest {
|
|
6347
6164
|
/**
|
|
6348
|
-
*
|
|
6349
|
-
* @
|
|
6165
|
+
* The ID of order that is refunded
|
|
6166
|
+
* @format GUID
|
|
6350
6167
|
*/
|
|
6351
|
-
|
|
6168
|
+
orderId?: string;
|
|
6352
6169
|
/**
|
|
6353
|
-
*
|
|
6354
|
-
*
|
|
6355
|
-
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
6356
|
-
* @maxLength 150
|
|
6170
|
+
* Refund ID
|
|
6171
|
+
* @format GUID
|
|
6357
6172
|
*/
|
|
6358
|
-
|
|
6173
|
+
refundId?: string;
|
|
6359
6174
|
/**
|
|
6360
|
-
*
|
|
6361
|
-
*
|
|
6362
|
-
*
|
|
6175
|
+
* Personal note added to the email (optional)
|
|
6176
|
+
* @minLength 1
|
|
6177
|
+
* @maxLength 1000
|
|
6363
6178
|
*/
|
|
6364
|
-
|
|
6179
|
+
customMessage?: string | null;
|
|
6365
6180
|
}
|
|
6366
|
-
interface
|
|
6181
|
+
interface SendRefundEmailResponse {
|
|
6182
|
+
}
|
|
6183
|
+
interface SendFulfillmentEmailRequest {
|
|
6184
|
+
/** @format GUID */
|
|
6185
|
+
orderId?: string;
|
|
6186
|
+
/** @format GUID */
|
|
6187
|
+
fulfillerId?: string;
|
|
6188
|
+
}
|
|
6189
|
+
interface SendFulfillmentEmailResponse {
|
|
6190
|
+
}
|
|
6191
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
6367
6192
|
/**
|
|
6368
|
-
*
|
|
6193
|
+
* @minLength 1
|
|
6369
6194
|
* @maxLength 100
|
|
6370
6195
|
*/
|
|
6371
|
-
|
|
6196
|
+
orderId?: string;
|
|
6197
|
+
}
|
|
6198
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
6199
|
+
}
|
|
6200
|
+
interface PreviewEmailByTypeRequest {
|
|
6201
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
6202
|
+
}
|
|
6203
|
+
declare enum PreviewEmailType {
|
|
6204
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
6205
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
6206
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
6207
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
6208
|
+
}
|
|
6209
|
+
/** @enumType */
|
|
6210
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
6211
|
+
interface PreviewEmailByTypeResponse {
|
|
6212
|
+
emailPreview?: string;
|
|
6213
|
+
}
|
|
6214
|
+
interface PreviewRefundEmailRequest {
|
|
6372
6215
|
/**
|
|
6373
|
-
*
|
|
6374
|
-
* @
|
|
6375
|
-
* @deprecated
|
|
6216
|
+
* @minLength 1
|
|
6217
|
+
* @maxLength 100
|
|
6376
6218
|
*/
|
|
6377
|
-
|
|
6219
|
+
orderId?: string;
|
|
6220
|
+
/** Refund amount */
|
|
6221
|
+
refundAmount?: Price;
|
|
6222
|
+
/** Refund business details */
|
|
6223
|
+
details?: RefundDetails;
|
|
6378
6224
|
/**
|
|
6379
|
-
*
|
|
6380
|
-
* @
|
|
6225
|
+
* Personal note added to the email (optional)
|
|
6226
|
+
* @minLength 1
|
|
6227
|
+
* @maxLength 1000
|
|
6381
6228
|
*/
|
|
6382
|
-
|
|
6229
|
+
customMessage?: string | null;
|
|
6383
6230
|
/**
|
|
6384
|
-
*
|
|
6385
|
-
* @
|
|
6386
|
-
* @deprecated Whether the gift card is voided.
|
|
6387
|
-
* @replacedBy payment.status
|
|
6388
|
-
* @targetRemovalDate 2026-11-01
|
|
6231
|
+
* Refund ID. (Optional)
|
|
6232
|
+
* @format GUID
|
|
6389
6233
|
*/
|
|
6390
|
-
|
|
6234
|
+
refundId?: string | null;
|
|
6235
|
+
}
|
|
6236
|
+
interface PreviewRefundEmailResponse {
|
|
6237
|
+
emailPreview?: string;
|
|
6238
|
+
}
|
|
6239
|
+
interface PreviewCancelEmailRequest {
|
|
6391
6240
|
/**
|
|
6392
|
-
*
|
|
6393
|
-
* @maxLength
|
|
6394
|
-
* @immutable
|
|
6241
|
+
* @minLength 1
|
|
6242
|
+
* @maxLength 100
|
|
6395
6243
|
*/
|
|
6396
|
-
|
|
6397
|
-
}
|
|
6398
|
-
interface MembershipPaymentDetails {
|
|
6244
|
+
orderId?: string;
|
|
6399
6245
|
/**
|
|
6400
|
-
*
|
|
6401
|
-
* @
|
|
6246
|
+
* Personal note added to the email (optional)
|
|
6247
|
+
* @minLength 1
|
|
6248
|
+
* @maxLength 1000
|
|
6402
6249
|
*/
|
|
6403
|
-
|
|
6250
|
+
customMessage?: string | null;
|
|
6251
|
+
}
|
|
6252
|
+
interface PreviewCancelEmailResponse {
|
|
6253
|
+
emailPreview?: string;
|
|
6254
|
+
}
|
|
6255
|
+
interface PreviewCancelRefundEmailRequest {
|
|
6404
6256
|
/**
|
|
6405
|
-
* ID of the line item this membership applies to.
|
|
6406
6257
|
* @minLength 1
|
|
6407
6258
|
* @maxLength 100
|
|
6408
6259
|
*/
|
|
6409
|
-
|
|
6260
|
+
orderId?: string;
|
|
6410
6261
|
/**
|
|
6411
|
-
*
|
|
6412
|
-
* @
|
|
6413
|
-
* @
|
|
6414
|
-
* @targetRemovalDate 2026-11-01
|
|
6262
|
+
* Personal note added to the email (optional)
|
|
6263
|
+
* @minLength 1
|
|
6264
|
+
* @maxLength 1000
|
|
6415
6265
|
*/
|
|
6416
|
-
|
|
6417
|
-
/**
|
|
6418
|
-
|
|
6266
|
+
customMessage?: string | null;
|
|
6267
|
+
/** Refund amount */
|
|
6268
|
+
refundAmount?: Price;
|
|
6419
6269
|
/**
|
|
6420
|
-
*
|
|
6421
|
-
* @
|
|
6422
|
-
* @maxLength 100
|
|
6270
|
+
* Refund ID. (Optional)
|
|
6271
|
+
* @format GUID
|
|
6423
6272
|
*/
|
|
6424
|
-
|
|
6273
|
+
refundId?: string | null;
|
|
6274
|
+
}
|
|
6275
|
+
interface PreviewCancelRefundEmailResponse {
|
|
6276
|
+
emailPreview?: string;
|
|
6277
|
+
}
|
|
6278
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
6279
|
+
}
|
|
6280
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
6281
|
+
emailPreview?: string;
|
|
6282
|
+
}
|
|
6283
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
6284
|
+
}
|
|
6285
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
6286
|
+
emailPreview?: string;
|
|
6287
|
+
}
|
|
6288
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
6289
|
+
}
|
|
6290
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
6291
|
+
emailPreview?: string;
|
|
6292
|
+
}
|
|
6293
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
6294
|
+
}
|
|
6295
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
6296
|
+
emailPreview?: string;
|
|
6297
|
+
}
|
|
6298
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
6299
|
+
}
|
|
6300
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
6301
|
+
emailPreview?: string;
|
|
6302
|
+
}
|
|
6303
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
6304
|
+
/** Emitted on a meta site creation. */
|
|
6305
|
+
siteCreated?: SiteCreated;
|
|
6306
|
+
/** Emitted on a meta site transfer completion. */
|
|
6307
|
+
siteTransferred?: SiteTransferred;
|
|
6308
|
+
/** Emitted on a meta site deletion. */
|
|
6309
|
+
siteDeleted?: SiteDeleted;
|
|
6310
|
+
/** Emitted on a meta site restoration. */
|
|
6311
|
+
siteUndeleted?: SiteUndeleted;
|
|
6312
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6313
|
+
sitePublished?: SitePublished;
|
|
6314
|
+
/** Emitted on a meta site unpublish. */
|
|
6315
|
+
siteUnpublished?: SiteUnpublished;
|
|
6316
|
+
/** Emitted when meta site is marked as template. */
|
|
6317
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6318
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6319
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6320
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6321
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6322
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6323
|
+
serviceRemoved?: ServiceRemoved;
|
|
6324
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6325
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6326
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6327
|
+
hardDeleted?: SiteHardDeleted;
|
|
6328
|
+
/** Emitted on a namespace change. */
|
|
6329
|
+
namespaceChanged?: NamespaceChanged;
|
|
6330
|
+
/** Emitted when Studio is attached. */
|
|
6331
|
+
studioAssigned?: StudioAssigned;
|
|
6332
|
+
/** Emitted when Studio is detached. */
|
|
6333
|
+
studioUnassigned?: StudioUnassigned;
|
|
6425
6334
|
/**
|
|
6426
|
-
*
|
|
6427
|
-
*
|
|
6428
|
-
*
|
|
6429
|
-
*
|
|
6430
|
-
*
|
|
6335
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6336
|
+
* the actual URL.
|
|
6337
|
+
*
|
|
6338
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6339
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6431
6340
|
*/
|
|
6432
|
-
|
|
6341
|
+
urlChanged?: SiteUrlChanged;
|
|
6342
|
+
/** Site is marked as PurgedExternally */
|
|
6343
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6344
|
+
/** Emitted when Odeditor is attached. */
|
|
6345
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6346
|
+
/** Emitted when Odeditor is detached. */
|
|
6347
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6348
|
+
/** Emitted when Picasso is attached. */
|
|
6349
|
+
picassoAssigned?: PicassoAssigned;
|
|
6350
|
+
/** Emitted when Picasso is detached. */
|
|
6351
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6352
|
+
/** Emitted when Wixel is attached. */
|
|
6353
|
+
wixelAssigned?: WixelAssigned;
|
|
6354
|
+
/** Emitted when Wixel is detached. */
|
|
6355
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6356
|
+
/** Emitted when StudioTwo is attached. */
|
|
6357
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6358
|
+
/** Emitted when StudioTwo is detached. */
|
|
6359
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6360
|
+
/** Emitted when media from user domain is enabled. */
|
|
6361
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6362
|
+
/** Emitted when media from user domain is disabled. */
|
|
6363
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6364
|
+
/** Emitted when Editorless is attached. */
|
|
6365
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6366
|
+
/** Emitted when Editorless is detached. */
|
|
6367
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6433
6368
|
/**
|
|
6434
|
-
*
|
|
6369
|
+
* A meta site id.
|
|
6435
6370
|
* @format GUID
|
|
6436
6371
|
*/
|
|
6437
|
-
|
|
6438
|
-
/**
|
|
6439
|
-
|
|
6440
|
-
|
|
6441
|
-
|
|
6442
|
-
/** Payment was charged. */
|
|
6443
|
-
CHARGED = "CHARGED",
|
|
6444
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
6445
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6446
|
-
/** Payment is pending. */
|
|
6447
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
6448
|
-
/** Payment was voided. */
|
|
6449
|
-
VOIDED = "VOIDED"
|
|
6450
|
-
}
|
|
6451
|
-
/** @enumType */
|
|
6452
|
-
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
6453
|
-
interface FutureMembershipDetails {
|
|
6372
|
+
metaSiteId?: string;
|
|
6373
|
+
/** A meta site version. Monotonically increasing. */
|
|
6374
|
+
version?: string;
|
|
6375
|
+
/** A timestamp of the event. */
|
|
6376
|
+
timestamp?: string;
|
|
6454
6377
|
/**
|
|
6455
|
-
*
|
|
6456
|
-
*
|
|
6378
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
6379
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
6380
|
+
* @maxSize 4000
|
|
6457
6381
|
*/
|
|
6458
|
-
|
|
6382
|
+
assets?: Asset[];
|
|
6383
|
+
}
|
|
6384
|
+
/** @oneof */
|
|
6385
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
6386
|
+
/** Emitted on a meta site creation. */
|
|
6387
|
+
siteCreated?: SiteCreated;
|
|
6388
|
+
/** Emitted on a meta site transfer completion. */
|
|
6389
|
+
siteTransferred?: SiteTransferred;
|
|
6390
|
+
/** Emitted on a meta site deletion. */
|
|
6391
|
+
siteDeleted?: SiteDeleted;
|
|
6392
|
+
/** Emitted on a meta site restoration. */
|
|
6393
|
+
siteUndeleted?: SiteUndeleted;
|
|
6394
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6395
|
+
sitePublished?: SitePublished;
|
|
6396
|
+
/** Emitted on a meta site unpublish. */
|
|
6397
|
+
siteUnpublished?: SiteUnpublished;
|
|
6398
|
+
/** Emitted when meta site is marked as template. */
|
|
6399
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6400
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6401
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6402
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6403
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6404
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6405
|
+
serviceRemoved?: ServiceRemoved;
|
|
6406
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6407
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6408
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6409
|
+
hardDeleted?: SiteHardDeleted;
|
|
6410
|
+
/** Emitted on a namespace change. */
|
|
6411
|
+
namespaceChanged?: NamespaceChanged;
|
|
6412
|
+
/** Emitted when Studio is attached. */
|
|
6413
|
+
studioAssigned?: StudioAssigned;
|
|
6414
|
+
/** Emitted when Studio is detached. */
|
|
6415
|
+
studioUnassigned?: StudioUnassigned;
|
|
6459
6416
|
/**
|
|
6460
|
-
*
|
|
6461
|
-
*
|
|
6417
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6418
|
+
* the actual URL.
|
|
6419
|
+
*
|
|
6420
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6421
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6462
6422
|
*/
|
|
6463
|
-
|
|
6423
|
+
urlChanged?: SiteUrlChanged;
|
|
6424
|
+
/** Site is marked as PurgedExternally */
|
|
6425
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6426
|
+
/** Emitted when Odeditor is attached. */
|
|
6427
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6428
|
+
/** Emitted when Odeditor is detached. */
|
|
6429
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6430
|
+
/** Emitted when Picasso is attached. */
|
|
6431
|
+
picassoAssigned?: PicassoAssigned;
|
|
6432
|
+
/** Emitted when Picasso is detached. */
|
|
6433
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6434
|
+
/** Emitted when Wixel is attached. */
|
|
6435
|
+
wixelAssigned?: WixelAssigned;
|
|
6436
|
+
/** Emitted when Wixel is detached. */
|
|
6437
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6438
|
+
/** Emitted when StudioTwo is attached. */
|
|
6439
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6440
|
+
/** Emitted when StudioTwo is detached. */
|
|
6441
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6442
|
+
/** Emitted when media from user domain is enabled. */
|
|
6443
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6444
|
+
/** Emitted when media from user domain is disabled. */
|
|
6445
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6446
|
+
/** Emitted when Editorless is attached. */
|
|
6447
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6448
|
+
/** Emitted when Editorless is detached. */
|
|
6449
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6464
6450
|
}
|
|
6465
|
-
interface
|
|
6451
|
+
interface Asset {
|
|
6466
6452
|
/**
|
|
6467
|
-
*
|
|
6468
|
-
* @
|
|
6453
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
6454
|
+
* @maxLength 36
|
|
6469
6455
|
*/
|
|
6470
|
-
|
|
6456
|
+
appDefId?: string;
|
|
6471
6457
|
/**
|
|
6472
|
-
*
|
|
6473
|
-
* @
|
|
6474
|
-
* @maxLength 40
|
|
6458
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
6459
|
+
* @maxLength 200
|
|
6475
6460
|
*/
|
|
6476
|
-
|
|
6461
|
+
instanceId?: string;
|
|
6462
|
+
/** An application state. */
|
|
6463
|
+
state?: StateWithLiterals;
|
|
6477
6464
|
}
|
|
6478
|
-
|
|
6465
|
+
declare enum State {
|
|
6466
|
+
UNKNOWN = "UNKNOWN",
|
|
6467
|
+
ENABLED = "ENABLED",
|
|
6468
|
+
DISABLED = "DISABLED",
|
|
6469
|
+
PENDING = "PENDING",
|
|
6470
|
+
DEMO = "DEMO"
|
|
6471
|
+
}
|
|
6472
|
+
/** @enumType */
|
|
6473
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
6474
|
+
interface SiteCreated {
|
|
6479
6475
|
/**
|
|
6480
|
-
*
|
|
6481
|
-
* @maxLength
|
|
6476
|
+
* A template identifier (empty if not created from a template).
|
|
6477
|
+
* @maxLength 36
|
|
6482
6478
|
*/
|
|
6483
|
-
|
|
6479
|
+
originTemplateId?: string;
|
|
6484
6480
|
/**
|
|
6485
|
-
*
|
|
6481
|
+
* An account id of the owner.
|
|
6486
6482
|
* @format GUID
|
|
6487
6483
|
*/
|
|
6488
|
-
|
|
6489
|
-
/**
|
|
6490
|
-
|
|
6491
|
-
* @minLength 1
|
|
6492
|
-
* @maxLength 40
|
|
6493
|
-
*/
|
|
6494
|
-
displayNumber?: string | null;
|
|
6495
|
-
}
|
|
6496
|
-
interface CashRoundingDetails {
|
|
6497
|
-
/**
|
|
6498
|
-
* Payment amount before cash rounding was applied.
|
|
6499
|
-
* When provided, balance and status calculations use this value instead of `amount`
|
|
6500
|
-
* to prevent false overpayment or underpayment due to rounding.
|
|
6501
|
-
*/
|
|
6502
|
-
unroundedAmount?: Price;
|
|
6484
|
+
ownerId?: string;
|
|
6485
|
+
/** A context in which meta site was created. */
|
|
6486
|
+
context?: SiteCreatedContextWithLiterals;
|
|
6503
6487
|
/**
|
|
6504
|
-
*
|
|
6505
|
-
*
|
|
6506
|
-
*
|
|
6488
|
+
* A meta site id from which this site was created.
|
|
6489
|
+
*
|
|
6490
|
+
* In case of a creation from a template it's a template id.
|
|
6491
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
6492
|
+
* @format GUID
|
|
6507
6493
|
*/
|
|
6508
|
-
|
|
6509
|
-
}
|
|
6510
|
-
declare enum PaymentStatus {
|
|
6511
|
-
/** Payment was charged successfully. */
|
|
6512
|
-
APPROVED = "APPROVED",
|
|
6513
|
-
/** Payment is being processed and hasn't been confirmed yet. */
|
|
6514
|
-
PENDING = "PENDING",
|
|
6515
|
-
/** 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. */
|
|
6516
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6517
|
-
/** Payment was canceled before it was charged. */
|
|
6518
|
-
CANCELED = "CANCELED",
|
|
6519
|
-
/** Payment was declined by the payment provider. */
|
|
6520
|
-
DECLINED = "DECLINED",
|
|
6521
|
-
/** Payment was fully refunded. */
|
|
6522
|
-
REFUNDED = "REFUNDED",
|
|
6523
|
-
/** Part of the payment amount was refunded. */
|
|
6524
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6525
|
-
/** 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. */
|
|
6526
|
-
AUTHORIZED = "AUTHORIZED",
|
|
6494
|
+
originMetaSiteId?: string | null;
|
|
6527
6495
|
/**
|
|
6528
|
-
*
|
|
6529
|
-
*
|
|
6530
|
-
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
6496
|
+
* A meta site name (URL slug).
|
|
6497
|
+
* @maxLength 20
|
|
6531
6498
|
*/
|
|
6532
|
-
|
|
6533
|
-
|
|
6534
|
-
|
|
6535
|
-
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6536
|
-
interface CanceledStatusDetails {
|
|
6537
|
-
reason?: CanceledReasonWithLiterals;
|
|
6538
|
-
}
|
|
6539
|
-
declare enum CanceledReason {
|
|
6540
|
-
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
6541
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
6542
|
-
/** Payment was not completed by user and expired. */
|
|
6543
|
-
EXPIRED = "EXPIRED"
|
|
6544
|
-
}
|
|
6545
|
-
/** @enumType */
|
|
6546
|
-
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
6547
|
-
interface DeclinedStatusDetails {
|
|
6548
|
-
reason?: DeclinedReasonWithLiterals;
|
|
6549
|
-
}
|
|
6550
|
-
declare enum DeclinedReason {
|
|
6551
|
-
/** Corresponding charge failed. */
|
|
6552
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6553
|
-
/** Payment details expired. */
|
|
6554
|
-
EXPIRED = "EXPIRED",
|
|
6555
|
-
/** Insufficient funds. */
|
|
6556
|
-
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6557
|
-
/** Gift card was disabled before charge was attempted. */
|
|
6558
|
-
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
6559
|
-
}
|
|
6560
|
-
/** @enumType */
|
|
6561
|
-
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6562
|
-
interface VoidedStatusDetails {
|
|
6563
|
-
reason?: VoidedReasonWithLiterals;
|
|
6499
|
+
siteName?: string;
|
|
6500
|
+
/** A namespace. */
|
|
6501
|
+
namespace?: NamespaceWithLiterals;
|
|
6564
6502
|
}
|
|
6565
|
-
declare enum
|
|
6566
|
-
/**
|
|
6567
|
-
|
|
6568
|
-
/**
|
|
6569
|
-
|
|
6503
|
+
declare enum SiteCreatedContext {
|
|
6504
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
6505
|
+
OTHER = "OTHER",
|
|
6506
|
+
/** A meta site was created from template. */
|
|
6507
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
6508
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
6509
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
6510
|
+
/** A copy of existing meta site. */
|
|
6511
|
+
DUPLICATE = "DUPLICATE",
|
|
6512
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
6513
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
6514
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
6515
|
+
FLASH = "FLASH"
|
|
6570
6516
|
}
|
|
6571
6517
|
/** @enumType */
|
|
6572
|
-
type
|
|
6573
|
-
|
|
6574
|
-
|
|
6575
|
-
|
|
6576
|
-
|
|
6577
|
-
|
|
6578
|
-
|
|
6579
|
-
|
|
6518
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
6519
|
+
declare enum Namespace {
|
|
6520
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
6521
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
6522
|
+
WIX = "WIX",
|
|
6523
|
+
/** 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. */
|
|
6524
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
6525
|
+
/** 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. */
|
|
6526
|
+
ALBUMS = "ALBUMS",
|
|
6527
|
+
/** 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. */
|
|
6528
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
6529
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6530
|
+
HOTELS = "HOTELS",
|
|
6531
|
+
/** 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. */
|
|
6532
|
+
CLUBS = "CLUBS",
|
|
6533
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6534
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
6580
6535
|
/**
|
|
6581
|
-
*
|
|
6582
|
-
*
|
|
6583
|
-
* @minLength 1
|
|
6584
|
-
* @maxLength 10
|
|
6536
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6537
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
6585
6538
|
*/
|
|
6586
|
-
|
|
6587
|
-
|
|
6588
|
-
|
|
6589
|
-
|
|
6590
|
-
|
|
6591
|
-
|
|
6592
|
-
|
|
6593
|
-
|
|
6594
|
-
|
|
6595
|
-
voided?: VoidedStatusDetails;
|
|
6596
|
-
}
|
|
6597
|
-
interface Refund {
|
|
6539
|
+
DEV_SITE = "DEV_SITE",
|
|
6540
|
+
/** 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. */
|
|
6541
|
+
LOGOS = "LOGOS",
|
|
6542
|
+
/** 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. */
|
|
6543
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
6544
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6545
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
6546
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6547
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
6598
6548
|
/**
|
|
6599
|
-
*
|
|
6600
|
-
*
|
|
6601
|
-
*
|
|
6549
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
6550
|
+
*
|
|
6551
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
6602
6552
|
*/
|
|
6603
|
-
|
|
6553
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
6604
6554
|
/**
|
|
6605
|
-
*
|
|
6606
|
-
*
|
|
6555
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
6556
|
+
* Will be accessible from Site List and will not have a website app.
|
|
6557
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
6607
6558
|
*/
|
|
6608
|
-
|
|
6609
|
-
/**
|
|
6610
|
-
|
|
6559
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
6560
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
6561
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
6562
|
+
/** It is to be used in the Business First efforts. */
|
|
6563
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
6564
|
+
/** Bookings business flow with no site. */
|
|
6565
|
+
ANYWHERE = "ANYWHERE",
|
|
6566
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
6567
|
+
HEADLESS = "HEADLESS",
|
|
6611
6568
|
/**
|
|
6612
|
-
*
|
|
6613
|
-
*
|
|
6614
|
-
* @immutable
|
|
6569
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
6570
|
+
* The site will be used for account level CSM feature for enterprise
|
|
6615
6571
|
*/
|
|
6616
|
-
|
|
6572
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
6573
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
6574
|
+
RISE = "RISE",
|
|
6617
6575
|
/**
|
|
6618
|
-
*
|
|
6619
|
-
*
|
|
6576
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
6577
|
+
* There's a blank site behind the scene but it's blank).
|
|
6578
|
+
* The Mobile company will be the owner of this namespace.
|
|
6620
6579
|
*/
|
|
6621
|
-
|
|
6580
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
6581
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
6582
|
+
NOWNIA = "NOWNIA",
|
|
6622
6583
|
/**
|
|
6623
|
-
*
|
|
6624
|
-
*
|
|
6625
|
-
* @readonly
|
|
6626
|
-
* @immutable
|
|
6584
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
6585
|
+
* The Partners company owns this namespace.
|
|
6627
6586
|
*/
|
|
6628
|
-
|
|
6629
|
-
|
|
6630
|
-
|
|
6587
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
6588
|
+
/** Codux Headless Sites */
|
|
6589
|
+
CODUX = "CODUX",
|
|
6590
|
+
/** Bobb - AI Design Creator. */
|
|
6591
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
6631
6592
|
/**
|
|
6632
|
-
*
|
|
6633
|
-
*
|
|
6634
|
-
* @immutable
|
|
6593
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
6594
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
6635
6595
|
*/
|
|
6636
|
-
|
|
6596
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
6597
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6598
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
6599
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6600
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
6601
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
6602
|
+
MIMIR = "MIMIR",
|
|
6603
|
+
/** Wix Twins platform. */
|
|
6604
|
+
TWINS = "TWINS",
|
|
6605
|
+
/** Wix Nano. */
|
|
6606
|
+
NANO = "NANO",
|
|
6607
|
+
/** Base44 headless sites. */
|
|
6608
|
+
BASE44 = "BASE44",
|
|
6609
|
+
/** Wix Channels Sites */
|
|
6610
|
+
CHANNELS = "CHANNELS",
|
|
6611
|
+
/** Nautilus platform. */
|
|
6612
|
+
NAUTILUS = "NAUTILUS",
|
|
6637
6613
|
/**
|
|
6638
|
-
*
|
|
6639
|
-
*
|
|
6614
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
6615
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
6640
6616
|
*/
|
|
6641
|
-
|
|
6642
|
-
/**
|
|
6643
|
-
|
|
6644
|
-
/** Optional details of current refund status. */
|
|
6645
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
6617
|
+
SYMPHONY = "SYMPHONY",
|
|
6618
|
+
/** Nautilus platform app. */
|
|
6619
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
6646
6620
|
/**
|
|
6647
|
-
*
|
|
6648
|
-
*
|
|
6649
|
-
* @format GUID
|
|
6621
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
6622
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
6650
6623
|
*/
|
|
6651
|
-
|
|
6652
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
6653
|
-
providerRefundId?: string | null;
|
|
6624
|
+
VIBU = "VIBU",
|
|
6654
6625
|
/**
|
|
6655
|
-
*
|
|
6656
|
-
*
|
|
6626
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
6627
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
6628
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
6629
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6657
6630
|
*/
|
|
6658
|
-
|
|
6631
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
6659
6632
|
/**
|
|
6660
|
-
*
|
|
6661
|
-
*
|
|
6633
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
6634
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
6635
|
+
*/
|
|
6636
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
6637
|
+
}
|
|
6638
|
+
/** @enumType */
|
|
6639
|
+
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';
|
|
6640
|
+
/** Site transferred to another user. */
|
|
6641
|
+
interface SiteTransferred {
|
|
6642
|
+
/**
|
|
6643
|
+
* A previous owner id (user that transfers meta site).
|
|
6662
6644
|
* @format GUID
|
|
6663
|
-
* @immutable
|
|
6664
6645
|
*/
|
|
6665
|
-
|
|
6646
|
+
oldOwnerId?: string;
|
|
6647
|
+
/**
|
|
6648
|
+
* A new owner id (user that accepts meta site).
|
|
6649
|
+
* @format GUID
|
|
6650
|
+
*/
|
|
6651
|
+
newOwnerId?: string;
|
|
6666
6652
|
}
|
|
6667
|
-
/**
|
|
6668
|
-
|
|
6669
|
-
/**
|
|
6670
|
-
|
|
6671
|
-
/** Refund transaction succeeded. */
|
|
6672
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6673
|
-
/** Refund transaction failed. */
|
|
6674
|
-
FAILED = "FAILED",
|
|
6675
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
6676
|
-
SCHEDULED = "SCHEDULED",
|
|
6677
|
-
/** Refund was initiated on payment provider side. */
|
|
6678
|
-
STARTED = "STARTED"
|
|
6653
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
6654
|
+
interface SiteDeleted {
|
|
6655
|
+
/** A deletion context. */
|
|
6656
|
+
deleteContext?: DeleteContext;
|
|
6679
6657
|
}
|
|
6680
|
-
|
|
6681
|
-
|
|
6682
|
-
|
|
6658
|
+
interface DeleteContext {
|
|
6659
|
+
/** When the meta site was deleted. */
|
|
6660
|
+
dateDeleted?: Date | null;
|
|
6661
|
+
/** A status. */
|
|
6662
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
6683
6663
|
/**
|
|
6684
|
-
*
|
|
6685
|
-
*
|
|
6686
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
6687
|
-
* @minLength 1
|
|
6688
|
-
* @maxLength 10
|
|
6664
|
+
* A reason (flow).
|
|
6665
|
+
* @maxLength 255
|
|
6689
6666
|
*/
|
|
6690
|
-
|
|
6667
|
+
deleteOrigin?: string;
|
|
6691
6668
|
/**
|
|
6692
|
-
*
|
|
6693
|
-
* @
|
|
6694
|
-
* @maxLength 1000
|
|
6669
|
+
* A service that deleted it.
|
|
6670
|
+
* @maxLength 255
|
|
6695
6671
|
*/
|
|
6696
|
-
|
|
6672
|
+
initiatorId?: string | null;
|
|
6697
6673
|
}
|
|
6698
|
-
|
|
6699
|
-
|
|
6700
|
-
|
|
6701
|
-
|
|
6702
|
-
|
|
6703
|
-
|
|
6704
|
-
refunded?: Price;
|
|
6705
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6706
|
-
failedRefundAmount?: Price;
|
|
6707
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6708
|
-
pending?: boolean;
|
|
6709
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6710
|
-
breakdown?: RefundItemsBreakdown;
|
|
6674
|
+
declare enum DeleteStatus {
|
|
6675
|
+
UNKNOWN = "UNKNOWN",
|
|
6676
|
+
TRASH = "TRASH",
|
|
6677
|
+
DELETED = "DELETED",
|
|
6678
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
6679
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
6711
6680
|
}
|
|
6712
|
-
|
|
6681
|
+
/** @enumType */
|
|
6682
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
6683
|
+
/** Restoration of the meta site. */
|
|
6684
|
+
interface SiteUndeleted {
|
|
6685
|
+
}
|
|
6686
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
6687
|
+
interface SitePublished {
|
|
6688
|
+
}
|
|
6689
|
+
interface SiteUnpublished {
|
|
6690
|
+
/**
|
|
6691
|
+
* A list of URLs previously associated with the meta site.
|
|
6692
|
+
* @maxLength 4000
|
|
6693
|
+
* @maxSize 10000
|
|
6694
|
+
*/
|
|
6695
|
+
urls?: string[];
|
|
6696
|
+
}
|
|
6697
|
+
interface SiteMarkedAsTemplate {
|
|
6698
|
+
}
|
|
6699
|
+
interface SiteMarkedAsWixSite {
|
|
6700
|
+
}
|
|
6701
|
+
/**
|
|
6702
|
+
* Represents a service provisioned a site.
|
|
6703
|
+
*
|
|
6704
|
+
* Note on `origin_instance_id`:
|
|
6705
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
6706
|
+
* This is because of the following scenario:
|
|
6707
|
+
*
|
|
6708
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
6709
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
6710
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
6711
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
6712
|
+
* your site remains consistent with what you initially received and does not include any
|
|
6713
|
+
* changes made to the original template afterward.
|
|
6714
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
6715
|
+
*/
|
|
6716
|
+
interface ServiceProvisioned {
|
|
6713
6717
|
/**
|
|
6714
|
-
*
|
|
6715
|
-
* @
|
|
6718
|
+
* Either UUID or EmbeddedServiceType.
|
|
6719
|
+
* @maxLength 36
|
|
6716
6720
|
*/
|
|
6717
|
-
|
|
6718
|
-
}
|
|
6719
|
-
interface LineItemRefundSummary {
|
|
6721
|
+
appDefId?: string;
|
|
6720
6722
|
/**
|
|
6721
|
-
*
|
|
6722
|
-
* @
|
|
6723
|
+
* Not only UUID. Something here could be something weird.
|
|
6724
|
+
* @maxLength 36
|
|
6723
6725
|
*/
|
|
6724
|
-
|
|
6725
|
-
/** Total refunded amount for the line item. */
|
|
6726
|
-
totalRefundedAmount?: Price;
|
|
6727
|
-
}
|
|
6728
|
-
interface CalculateRefundRequest {
|
|
6726
|
+
instanceId?: string;
|
|
6729
6727
|
/**
|
|
6730
|
-
*
|
|
6731
|
-
* @
|
|
6732
|
-
* @maxLength 100
|
|
6728
|
+
* An instance id from which this instance is originated.
|
|
6729
|
+
* @maxLength 36
|
|
6733
6730
|
*/
|
|
6734
|
-
|
|
6731
|
+
originInstanceId?: string;
|
|
6735
6732
|
/**
|
|
6736
|
-
*
|
|
6737
|
-
* @
|
|
6733
|
+
* A version.
|
|
6734
|
+
* @maxLength 500
|
|
6738
6735
|
*/
|
|
6739
|
-
|
|
6740
|
-
/** Should include shipping in refund calculation */
|
|
6741
|
-
refundShipping?: boolean;
|
|
6742
|
-
}
|
|
6743
|
-
interface CalculateRefundItemRequest {
|
|
6736
|
+
version?: string | null;
|
|
6744
6737
|
/**
|
|
6745
|
-
*
|
|
6738
|
+
* The origin meta site id
|
|
6746
6739
|
* @format GUID
|
|
6747
6740
|
*/
|
|
6748
|
-
|
|
6741
|
+
originMetaSiteId?: string | null;
|
|
6742
|
+
}
|
|
6743
|
+
interface ServiceRemoved {
|
|
6749
6744
|
/**
|
|
6750
|
-
*
|
|
6751
|
-
* @
|
|
6752
|
-
* @max 100000
|
|
6745
|
+
* Either UUID or EmbeddedServiceType.
|
|
6746
|
+
* @maxLength 36
|
|
6753
6747
|
*/
|
|
6754
|
-
|
|
6755
|
-
}
|
|
6756
|
-
interface CalculateRefundResponse {
|
|
6757
|
-
/** Total refundable amount */
|
|
6758
|
-
total?: Price;
|
|
6759
|
-
/** Tax cost of the order */
|
|
6760
|
-
tax?: Price;
|
|
6761
|
-
/** Discount given for this order */
|
|
6762
|
-
discount?: Price;
|
|
6763
|
-
/** Total cost of the order (without tax) */
|
|
6764
|
-
subtotal?: Price;
|
|
6765
|
-
/** Total shipping cost for order */
|
|
6766
|
-
shipping?: Price;
|
|
6767
|
-
/** Previous refund given on that order */
|
|
6768
|
-
previouslyRefundedAmount?: Price;
|
|
6748
|
+
appDefId?: string;
|
|
6769
6749
|
/**
|
|
6770
|
-
*
|
|
6771
|
-
* @
|
|
6750
|
+
* Not only UUID. Something here could be something weird.
|
|
6751
|
+
* @maxLength 36
|
|
6772
6752
|
*/
|
|
6773
|
-
|
|
6774
|
-
}
|
|
6775
|
-
interface CalculateRefundItemResponse {
|
|
6753
|
+
instanceId?: string;
|
|
6776
6754
|
/**
|
|
6777
|
-
*
|
|
6778
|
-
* @
|
|
6755
|
+
* A version.
|
|
6756
|
+
* @maxLength 500
|
|
6779
6757
|
*/
|
|
6780
|
-
|
|
6781
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6782
|
-
price?: Price;
|
|
6758
|
+
version?: string | null;
|
|
6783
6759
|
}
|
|
6784
|
-
|
|
6760
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
6761
|
+
interface SiteRenamed {
|
|
6785
6762
|
/**
|
|
6786
|
-
*
|
|
6787
|
-
* @
|
|
6788
|
-
* @maxLength 100
|
|
6763
|
+
* A new meta site name (URL slug).
|
|
6764
|
+
* @maxLength 20
|
|
6789
6765
|
*/
|
|
6790
|
-
|
|
6766
|
+
newSiteName?: string;
|
|
6791
6767
|
/**
|
|
6792
|
-
*
|
|
6793
|
-
* @
|
|
6794
|
-
* @maxSize 100
|
|
6795
|
-
* @format GUID
|
|
6768
|
+
* A previous meta site name (URL slug).
|
|
6769
|
+
* @maxLength 255
|
|
6796
6770
|
*/
|
|
6797
|
-
|
|
6771
|
+
oldSiteName?: string;
|
|
6798
6772
|
}
|
|
6799
|
-
|
|
6800
|
-
|
|
6801
|
-
|
|
6773
|
+
/**
|
|
6774
|
+
* Hard deletion of the meta site.
|
|
6775
|
+
*
|
|
6776
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
6777
|
+
*/
|
|
6778
|
+
interface SiteHardDeleted {
|
|
6779
|
+
/** A deletion context. */
|
|
6780
|
+
deleteContext?: DeleteContext;
|
|
6802
6781
|
}
|
|
6803
|
-
interface
|
|
6804
|
-
/**
|
|
6805
|
-
|
|
6806
|
-
|
|
6807
|
-
|
|
6808
|
-
|
|
6809
|
-
|
|
6782
|
+
interface NamespaceChanged {
|
|
6783
|
+
/** A previous namespace. */
|
|
6784
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
6785
|
+
/** A new namespace. */
|
|
6786
|
+
newNamespace?: NamespaceWithLiterals;
|
|
6787
|
+
}
|
|
6788
|
+
/** Assigned Studio editor */
|
|
6789
|
+
interface StudioAssigned {
|
|
6790
|
+
}
|
|
6791
|
+
/** Unassigned Studio editor */
|
|
6792
|
+
interface StudioUnassigned {
|
|
6793
|
+
}
|
|
6794
|
+
/**
|
|
6795
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
6796
|
+
*
|
|
6797
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
6798
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
6799
|
+
*
|
|
6800
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
6801
|
+
*/
|
|
6802
|
+
interface SiteUrlChanged {
|
|
6803
|
+
}
|
|
6804
|
+
/**
|
|
6805
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
6806
|
+
* Consumed by other teams to remove relevant data.
|
|
6807
|
+
*/
|
|
6808
|
+
interface SitePurgedExternally {
|
|
6810
6809
|
/**
|
|
6811
|
-
*
|
|
6812
|
-
* @minSize 1
|
|
6810
|
+
* @maxLength 2048
|
|
6813
6811
|
* @maxSize 100
|
|
6812
|
+
* @deprecated
|
|
6813
|
+
* @targetRemovalDate 2025-04-15
|
|
6814
6814
|
*/
|
|
6815
|
-
|
|
6815
|
+
appDefId?: string[];
|
|
6816
6816
|
}
|
|
6817
|
-
|
|
6818
|
-
|
|
6819
|
-
* Payment ID
|
|
6820
|
-
* @format GUID
|
|
6821
|
-
*/
|
|
6822
|
-
paymentId?: string | null;
|
|
6823
|
-
/**
|
|
6824
|
-
* Capture amount.
|
|
6825
|
-
* If not provided - full authorized amount will be captured.
|
|
6826
|
-
*/
|
|
6827
|
-
amount?: Price;
|
|
6817
|
+
/** Assigned Odeditor */
|
|
6818
|
+
interface OdeditorAssigned {
|
|
6828
6819
|
}
|
|
6829
|
-
|
|
6830
|
-
|
|
6831
|
-
orderTransactions?: OrderTransactions;
|
|
6820
|
+
/** Unassigned Odeditor */
|
|
6821
|
+
interface OdeditorUnassigned {
|
|
6832
6822
|
}
|
|
6833
|
-
|
|
6834
|
-
|
|
6835
|
-
* Ecom Order ID.
|
|
6836
|
-
* @minLength 1
|
|
6837
|
-
* @maxLength 100
|
|
6838
|
-
*/
|
|
6839
|
-
ecomOrderId?: string;
|
|
6840
|
-
/** Amount to be charged */
|
|
6841
|
-
amount?: Price;
|
|
6823
|
+
/** Assigned Picasso editor */
|
|
6824
|
+
interface PicassoAssigned {
|
|
6842
6825
|
}
|
|
6843
|
-
|
|
6844
|
-
|
|
6845
|
-
paymentGatewayOrderId?: string;
|
|
6826
|
+
/** Unassigned Picasso */
|
|
6827
|
+
interface PicassoUnassigned {
|
|
6846
6828
|
}
|
|
6847
|
-
|
|
6848
|
-
|
|
6849
|
-
metasiteId?: string;
|
|
6850
|
-
/**
|
|
6851
|
-
* @minLength 1
|
|
6852
|
-
* @maxLength 100
|
|
6853
|
-
* @maxSize 100
|
|
6854
|
-
*/
|
|
6855
|
-
orderIds?: string[];
|
|
6829
|
+
/** Assigned Wixel */
|
|
6830
|
+
interface WixelAssigned {
|
|
6856
6831
|
}
|
|
6857
|
-
|
|
6832
|
+
/** Unassigned Wixel */
|
|
6833
|
+
interface WixelUnassigned {
|
|
6858
6834
|
}
|
|
6859
|
-
|
|
6860
|
-
|
|
6861
|
-
|
|
6835
|
+
/** Assigned StudioTwo */
|
|
6836
|
+
interface StudioTwoAssigned {
|
|
6837
|
+
}
|
|
6838
|
+
/** Unassigned StudioTwo */
|
|
6839
|
+
interface StudioTwoUnassigned {
|
|
6840
|
+
}
|
|
6841
|
+
/** Media from user domain is enabled. */
|
|
6842
|
+
interface UserDomainMediaEnabled {
|
|
6843
|
+
}
|
|
6844
|
+
/** Media from user domain is disabled. */
|
|
6845
|
+
interface UserDomainMediaDisabled {
|
|
6846
|
+
}
|
|
6847
|
+
/** Assigned Editorless */
|
|
6848
|
+
interface EditorlessAssigned {
|
|
6849
|
+
}
|
|
6850
|
+
/** Unassigned Editorless */
|
|
6851
|
+
interface EditorlessUnassigned {
|
|
6852
|
+
}
|
|
6853
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
6854
|
+
}
|
|
6855
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
6856
|
+
hasCustomConfigurations?: boolean;
|
|
6857
|
+
}
|
|
6858
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
6859
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
6860
|
+
sendCustomEmailConfigs?: boolean;
|
|
6861
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
6862
|
+
origin?: OriginWithLiterals;
|
|
6863
|
+
}
|
|
6864
|
+
declare enum Origin {
|
|
6865
|
+
OPT_IN = "OPT_IN",
|
|
6866
|
+
MIGRATION = "MIGRATION"
|
|
6867
|
+
}
|
|
6868
|
+
/** @enumType */
|
|
6869
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
6870
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
6871
|
+
success?: boolean;
|
|
6872
|
+
}
|
|
6873
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
6874
|
+
}
|
|
6875
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
6876
|
+
inPopulation?: boolean;
|
|
6877
|
+
}
|
|
6878
|
+
/**
|
|
6879
|
+
* Cycle price override as applied to a single billing cycle: the regular price and the price the
|
|
6880
|
+
* override set for that cycle.
|
|
6881
|
+
*/
|
|
6882
|
+
interface CyclePriceOverride {
|
|
6862
6883
|
/**
|
|
6863
|
-
*
|
|
6864
|
-
*
|
|
6884
|
+
* Billing cycle this order covers. `1` for the order created at checkout.
|
|
6885
|
+
* Same value as `subscriptionInfo.cycleNumber`.
|
|
6886
|
+
* @min 1
|
|
6887
|
+
* @max 999
|
|
6865
6888
|
*/
|
|
6866
|
-
|
|
6889
|
+
cycle?: number;
|
|
6890
|
+
/** Regular (recurring) unit price of the line item. */
|
|
6891
|
+
basePrice?: Price;
|
|
6892
|
+
/** Unit price the cycle price override set for this cycle, before line item discounts (coupons). */
|
|
6893
|
+
overriddenPrice?: Price;
|
|
6867
6894
|
}
|
|
6868
6895
|
interface DiffmatokyPayload {
|
|
6869
6896
|
left?: string;
|
|
@@ -9097,4 +9124,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
|
|
|
9097
9124
|
declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
|
|
9098
9125
|
declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
|
|
9099
9126
|
|
|
9100
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|
|
9127
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|