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