@wix/auto_sdk_ecom_orders 1.0.47 → 1.0.49
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/index.typings.d.ts +6 -2
- package/build/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/cjs/src/ecom-v1-order-orders.public.d.ts +4 -3
- package/build/cjs/src/ecom-v1-order-orders.public.js +1 -1
- package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.types.d.ts +163 -61
- package/build/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.universal.d.ts +335 -73
- package/build/cjs/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/es/index.typings.d.ts +6 -2
- package/build/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/es/src/ecom-v1-order-orders.public.d.ts +4 -3
- package/build/es/src/ecom-v1-order-orders.public.js +1 -1
- package/build/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.types.d.ts +163 -61
- package/build/es/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.universal.d.ts +335 -73
- package/build/es/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +6 -2
- package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +5 -4
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +163 -61
- package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +336 -74
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/es/index.typings.d.ts +6 -2
- package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +5 -4
- package/build/internal/es/src/ecom-v1-order-orders.public.js +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +163 -61
- package/build/internal/es/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +336 -74
- package/build/internal/es/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
|
+
import { Search as SearchSdkType, NonNullablePaths, SearchSpec } from '@wix/sdk-types';
|
|
2
2
|
export interface Order {
|
|
3
3
|
/**
|
|
4
4
|
* Order ID.
|
|
@@ -32,19 +32,19 @@ export interface Order {
|
|
|
32
32
|
/** Buyer information. */
|
|
33
33
|
buyerInfo?: BuyerInfo;
|
|
34
34
|
/** Order payment status. */
|
|
35
|
-
paymentStatus?:
|
|
35
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
36
36
|
/**
|
|
37
37
|
* Order fulfillment status.
|
|
38
38
|
* @readonly
|
|
39
39
|
*/
|
|
40
|
-
fulfillmentStatus?:
|
|
40
|
+
fulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
41
41
|
/**
|
|
42
42
|
* Language for communication with the buyer. Defaults to the site language.
|
|
43
43
|
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
44
44
|
*/
|
|
45
45
|
buyerLanguage?: string | null;
|
|
46
46
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
47
|
-
weightUnit?:
|
|
47
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
48
48
|
/**
|
|
49
49
|
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
50
50
|
* @format CURRENCY
|
|
@@ -78,7 +78,7 @@ export interface Order {
|
|
|
78
78
|
*/
|
|
79
79
|
buyerNote?: string | null;
|
|
80
80
|
/** Order status. */
|
|
81
|
-
status?:
|
|
81
|
+
status?: OrderStatusWithLiterals;
|
|
82
82
|
/** Whether order is archived. */
|
|
83
83
|
archived?: boolean | null;
|
|
84
84
|
/**
|
|
@@ -106,7 +106,7 @@ export interface Order {
|
|
|
106
106
|
*/
|
|
107
107
|
activities?: Activity[];
|
|
108
108
|
/** Order attribution source. */
|
|
109
|
-
attributionSource?:
|
|
109
|
+
attributionSource?: AttributionSourceWithLiterals;
|
|
110
110
|
/**
|
|
111
111
|
* ID of the order's initiator.
|
|
112
112
|
* @readonly
|
|
@@ -248,7 +248,7 @@ export interface OrderLineItem {
|
|
|
248
248
|
*
|
|
249
249
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
250
250
|
*/
|
|
251
|
-
paymentOption?:
|
|
251
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
252
252
|
/**
|
|
253
253
|
* Deprecated. Use `taxInfo` instead.
|
|
254
254
|
* This field will be removed on September 30, 2024.
|
|
@@ -434,6 +434,8 @@ export declare enum DescriptionLineType {
|
|
|
434
434
|
/** Color type. */
|
|
435
435
|
COLOR = "COLOR"
|
|
436
436
|
}
|
|
437
|
+
/** @enumType */
|
|
438
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
437
439
|
export interface FocalPoint {
|
|
438
440
|
/** X-coordinate of the focal point. */
|
|
439
441
|
x?: number;
|
|
@@ -457,14 +459,14 @@ export interface PhysicalProperties {
|
|
|
457
459
|
}
|
|
458
460
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
459
461
|
/** Preset item type. */
|
|
460
|
-
preset?:
|
|
462
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
461
463
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
462
464
|
custom?: string;
|
|
463
465
|
}
|
|
464
466
|
/** @oneof */
|
|
465
467
|
export interface ItemTypeItemTypeDataOneOf {
|
|
466
468
|
/** Preset item type. */
|
|
467
|
-
preset?:
|
|
469
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
468
470
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
469
471
|
custom?: string;
|
|
470
472
|
}
|
|
@@ -475,6 +477,8 @@ export declare enum ItemTypeItemType {
|
|
|
475
477
|
GIFT_CARD = "GIFT_CARD",
|
|
476
478
|
SERVICE = "SERVICE"
|
|
477
479
|
}
|
|
480
|
+
/** @enumType */
|
|
481
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
478
482
|
/** Type of selected payment option for catalog item */
|
|
479
483
|
export declare enum PaymentOptionType {
|
|
480
484
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -488,6 +492,8 @@ export declare enum PaymentOptionType {
|
|
|
488
492
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
489
493
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
490
494
|
}
|
|
495
|
+
/** @enumType */
|
|
496
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
491
497
|
export interface ItemTaxFullDetails {
|
|
492
498
|
/** Taxable amount of this line item. */
|
|
493
499
|
taxableAmount?: Price;
|
|
@@ -553,7 +559,7 @@ export interface LineItemTaxBreakdown {
|
|
|
553
559
|
*/
|
|
554
560
|
taxName?: string | null;
|
|
555
561
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
556
|
-
jurisdictionType?:
|
|
562
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
557
563
|
/** Non-taxable amount of the line item price. */
|
|
558
564
|
nonTaxableAmount?: Price;
|
|
559
565
|
/** Taxable amount of the line item price. */
|
|
@@ -568,6 +574,8 @@ export declare enum JurisdictionType {
|
|
|
568
574
|
CITY = "CITY",
|
|
569
575
|
SPECIAL = "SPECIAL"
|
|
570
576
|
}
|
|
577
|
+
/** @enumType */
|
|
578
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
571
579
|
export interface DigitalFile {
|
|
572
580
|
/**
|
|
573
581
|
* ID of the secure file in media.
|
|
@@ -671,7 +679,7 @@ export interface SubscriptionDescription {
|
|
|
671
679
|
}
|
|
672
680
|
export interface SubscriptionSettings {
|
|
673
681
|
/** Frequency of recurring payment. */
|
|
674
|
-
frequency?:
|
|
682
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
675
683
|
/**
|
|
676
684
|
* Interval of recurring payment.
|
|
677
685
|
* @min 1
|
|
@@ -703,9 +711,11 @@ export declare enum SubscriptionFrequency {
|
|
|
703
711
|
MONTH = "MONTH",
|
|
704
712
|
YEAR = "YEAR"
|
|
705
713
|
}
|
|
714
|
+
/** @enumType */
|
|
715
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
706
716
|
export interface FreeTrialPeriod {
|
|
707
717
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
708
|
-
frequency?:
|
|
718
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
709
719
|
/**
|
|
710
720
|
* interval of period
|
|
711
721
|
* @min 1
|
|
@@ -715,7 +725,7 @@ export interface FreeTrialPeriod {
|
|
|
715
725
|
}
|
|
716
726
|
export interface BillingAdjustment {
|
|
717
727
|
/** The type of adjustment. */
|
|
718
|
-
type?:
|
|
728
|
+
type?: AdjustmentTypeWithLiterals;
|
|
719
729
|
/** Summary of the prorated adjustment amount. */
|
|
720
730
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
721
731
|
}
|
|
@@ -726,6 +736,8 @@ export declare enum AdjustmentType {
|
|
|
726
736
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
727
737
|
CREDIT = "CREDIT"
|
|
728
738
|
}
|
|
739
|
+
/** @enumType */
|
|
740
|
+
export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
729
741
|
export interface BillingAdjustmentPriceSummary {
|
|
730
742
|
/** Subtotal of adjustment, before tax. */
|
|
731
743
|
subtotal?: Price;
|
|
@@ -778,12 +790,12 @@ export interface LocationAndQuantity {
|
|
|
778
790
|
}
|
|
779
791
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
780
792
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
781
|
-
addressType?:
|
|
793
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
782
794
|
}
|
|
783
795
|
/** @oneof */
|
|
784
796
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
785
797
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
786
|
-
addressType?:
|
|
798
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
787
799
|
}
|
|
788
800
|
export declare enum TaxableAddressType {
|
|
789
801
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -791,6 +803,8 @@ export declare enum TaxableAddressType {
|
|
|
791
803
|
BILLING = "BILLING",
|
|
792
804
|
SHIPPING = "SHIPPING"
|
|
793
805
|
}
|
|
806
|
+
/** @enumType */
|
|
807
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
794
808
|
export interface ExtendedFields {
|
|
795
809
|
/**
|
|
796
810
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -936,6 +950,8 @@ export declare enum PaymentStatus {
|
|
|
936
950
|
*/
|
|
937
951
|
DECLINED = "DECLINED"
|
|
938
952
|
}
|
|
953
|
+
/** @enumType */
|
|
954
|
+
export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
939
955
|
export declare enum FulfillmentStatus {
|
|
940
956
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
941
957
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
@@ -947,6 +963,8 @@ export declare enum FulfillmentStatus {
|
|
|
947
963
|
/** Some, but not all, of the order items are fulfilled. */
|
|
948
964
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
949
965
|
}
|
|
966
|
+
/** @enumType */
|
|
967
|
+
export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
950
968
|
export declare enum WeightUnit {
|
|
951
969
|
/** Weight unit can't be classified due to an error. */
|
|
952
970
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
@@ -955,6 +973,8 @@ export declare enum WeightUnit {
|
|
|
955
973
|
/** Pounds. */
|
|
956
974
|
LB = "LB"
|
|
957
975
|
}
|
|
976
|
+
/** @enumType */
|
|
977
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
958
978
|
export interface CurrencyConversionDetails {
|
|
959
979
|
/**
|
|
960
980
|
* Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
@@ -1086,7 +1106,7 @@ export interface VatId {
|
|
|
1086
1106
|
* + `CPF`: for individual tax payers
|
|
1087
1107
|
* + `CNPJ`: for corporations
|
|
1088
1108
|
*/
|
|
1089
|
-
type?:
|
|
1109
|
+
type?: VatTypeWithLiterals;
|
|
1090
1110
|
}
|
|
1091
1111
|
/** tax info types */
|
|
1092
1112
|
export declare enum VatType {
|
|
@@ -1096,6 +1116,8 @@ export declare enum VatType {
|
|
|
1096
1116
|
/** CNPJ - for corporations */
|
|
1097
1117
|
CNPJ = "CNPJ"
|
|
1098
1118
|
}
|
|
1119
|
+
/** @enumType */
|
|
1120
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1099
1121
|
export interface V1ShippingInformation {
|
|
1100
1122
|
/**
|
|
1101
1123
|
* App Def Id of external provider which was a source of shipping info
|
|
@@ -1156,7 +1178,7 @@ export interface PickupDetails {
|
|
|
1156
1178
|
/** Pickup address. */
|
|
1157
1179
|
address?: PickupAddress;
|
|
1158
1180
|
/** Pickup method */
|
|
1159
|
-
pickupMethod?:
|
|
1181
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1160
1182
|
}
|
|
1161
1183
|
/** Physical address */
|
|
1162
1184
|
export interface PickupAddress {
|
|
@@ -1208,6 +1230,8 @@ export declare enum PickupMethod {
|
|
|
1208
1230
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1209
1231
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1210
1232
|
}
|
|
1233
|
+
/** @enumType */
|
|
1234
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1211
1235
|
export interface DeliveryTimeSlot {
|
|
1212
1236
|
/** Delivery slot starting time. */
|
|
1213
1237
|
from?: Date | null;
|
|
@@ -1267,6 +1291,8 @@ export declare enum OrderStatus {
|
|
|
1267
1291
|
*/
|
|
1268
1292
|
REJECTED = "REJECTED"
|
|
1269
1293
|
}
|
|
1294
|
+
/** @enumType */
|
|
1295
|
+
export type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
1270
1296
|
export interface TaxSummary {
|
|
1271
1297
|
/**
|
|
1272
1298
|
* Total tax.
|
|
@@ -1311,7 +1337,7 @@ export interface OrderTaxBreakdown {
|
|
|
1311
1337
|
*/
|
|
1312
1338
|
jurisdiction?: string;
|
|
1313
1339
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1314
|
-
jurisdictionType?:
|
|
1340
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1315
1341
|
/**
|
|
1316
1342
|
* The rate at which this tax detail was calculated.
|
|
1317
1343
|
* @format DECIMAL_VALUE
|
|
@@ -1334,7 +1360,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1334
1360
|
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1335
1361
|
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1336
1362
|
*/
|
|
1337
|
-
discountType?:
|
|
1363
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1338
1364
|
/**
|
|
1339
1365
|
* IDs of line items discount applies to.
|
|
1340
1366
|
* Deprecated. Use `line_item_discounts` instead.
|
|
@@ -1375,6 +1401,8 @@ export declare enum DiscountType {
|
|
|
1375
1401
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1376
1402
|
SHIPPING = "SHIPPING"
|
|
1377
1403
|
}
|
|
1404
|
+
/** @enumType */
|
|
1405
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1378
1406
|
/** Coupon */
|
|
1379
1407
|
export interface Coupon {
|
|
1380
1408
|
/** Coupon ID. */
|
|
@@ -1391,7 +1419,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1391
1419
|
* Pre-defined discount reason (optional).
|
|
1392
1420
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1393
1421
|
*/
|
|
1394
|
-
discountReason?:
|
|
1422
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1395
1423
|
/**
|
|
1396
1424
|
* Discount description as free text (optional).
|
|
1397
1425
|
* @maxLength 200
|
|
@@ -1413,7 +1441,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1413
1441
|
* Pre-defined discount reason (optional).
|
|
1414
1442
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1415
1443
|
*/
|
|
1416
|
-
discountReason?:
|
|
1444
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1417
1445
|
/**
|
|
1418
1446
|
* Discount description as free text (optional).
|
|
1419
1447
|
* @maxLength 200
|
|
@@ -1425,6 +1453,8 @@ export declare enum DiscountReason {
|
|
|
1425
1453
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1426
1454
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1427
1455
|
}
|
|
1456
|
+
/** @enumType */
|
|
1457
|
+
export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1428
1458
|
export interface DiscountRule {
|
|
1429
1459
|
/**
|
|
1430
1460
|
* Discount rule ID
|
|
@@ -1538,7 +1568,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
1538
1568
|
*/
|
|
1539
1569
|
_createdDate?: Date | null;
|
|
1540
1570
|
/** Activity type. */
|
|
1541
|
-
type?:
|
|
1571
|
+
type?: ActivityTypeWithLiterals;
|
|
1542
1572
|
}
|
|
1543
1573
|
/** @oneof */
|
|
1544
1574
|
export interface ActivityContentOneOf {
|
|
@@ -1735,7 +1765,7 @@ export interface LineItemQuantityChange {
|
|
|
1735
1765
|
*/
|
|
1736
1766
|
diff?: number;
|
|
1737
1767
|
/** Type of quantity change: increase or decrease. */
|
|
1738
|
-
deltaType?:
|
|
1768
|
+
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
1739
1769
|
}
|
|
1740
1770
|
export declare enum LineItemQuantityChangeType {
|
|
1741
1771
|
/** Quantity increased. */
|
|
@@ -1743,6 +1773,8 @@ export declare enum LineItemQuantityChangeType {
|
|
|
1743
1773
|
/** Quantity decreased. */
|
|
1744
1774
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
1745
1775
|
}
|
|
1776
|
+
/** @enumType */
|
|
1777
|
+
export type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
1746
1778
|
export interface LineItemPriceChange {
|
|
1747
1779
|
/** Item price before update. */
|
|
1748
1780
|
originalPrice?: Price;
|
|
@@ -2173,10 +2205,14 @@ export declare enum ActivityType {
|
|
|
2173
2205
|
/** @documentationMaturity preview */
|
|
2174
2206
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
2175
2207
|
}
|
|
2208
|
+
/** @enumType */
|
|
2209
|
+
export type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
2176
2210
|
export declare enum AttributionSource {
|
|
2177
2211
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2178
2212
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
2179
2213
|
}
|
|
2214
|
+
/** @enumType */
|
|
2215
|
+
export type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
2180
2216
|
export interface CreatedBy extends CreatedByStringOneOf {
|
|
2181
2217
|
/**
|
|
2182
2218
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
@@ -2226,7 +2262,7 @@ export interface CreatedByStringOneOf {
|
|
|
2226
2262
|
}
|
|
2227
2263
|
export interface ChannelInfo {
|
|
2228
2264
|
/** Sales channel that submitted the order. */
|
|
2229
|
-
type?:
|
|
2265
|
+
type?: ChannelTypeWithLiterals;
|
|
2230
2266
|
/**
|
|
2231
2267
|
* Reference to an order ID from an external system.
|
|
2232
2268
|
* @maxLength 100
|
|
@@ -2272,6 +2308,8 @@ export declare enum ChannelType {
|
|
|
2272
2308
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2273
2309
|
FAIRE_COM = "FAIRE_COM"
|
|
2274
2310
|
}
|
|
2311
|
+
/** @enumType */
|
|
2312
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
2275
2313
|
export interface CustomField {
|
|
2276
2314
|
/** Custom field value. */
|
|
2277
2315
|
value?: any;
|
|
@@ -2545,7 +2583,7 @@ export interface RedirectUrls {
|
|
|
2545
2583
|
}
|
|
2546
2584
|
export interface DelayedCaptureSettings {
|
|
2547
2585
|
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2548
|
-
scheduledAction?:
|
|
2586
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
2549
2587
|
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2550
2588
|
delayDuration?: Duration;
|
|
2551
2589
|
}
|
|
@@ -2556,6 +2594,8 @@ export declare enum ScheduledAction {
|
|
|
2556
2594
|
/** Whether payment will be auto-captured when duration passes */
|
|
2557
2595
|
CAPTURE = "CAPTURE"
|
|
2558
2596
|
}
|
|
2597
|
+
/** @enumType */
|
|
2598
|
+
export type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
2559
2599
|
export interface Duration {
|
|
2560
2600
|
/**
|
|
2561
2601
|
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
@@ -2563,7 +2603,7 @@ export interface Duration {
|
|
|
2563
2603
|
*/
|
|
2564
2604
|
count?: number;
|
|
2565
2605
|
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2566
|
-
unit?:
|
|
2606
|
+
unit?: DurationUnitWithLiterals;
|
|
2567
2607
|
}
|
|
2568
2608
|
export declare enum DurationUnit {
|
|
2569
2609
|
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
@@ -2571,6 +2611,8 @@ export declare enum DurationUnit {
|
|
|
2571
2611
|
HOURS = "HOURS",
|
|
2572
2612
|
DAYS = "DAYS"
|
|
2573
2613
|
}
|
|
2614
|
+
/** @enumType */
|
|
2615
|
+
export type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
2574
2616
|
export interface PreparePaymentCollectionResponse {
|
|
2575
2617
|
/** Payment gateway order id which is associated with given payment */
|
|
2576
2618
|
paymentGatewayOrderId?: string;
|
|
@@ -2585,7 +2627,7 @@ export interface GetPaymentCollectabilityStatusRequest {
|
|
|
2585
2627
|
}
|
|
2586
2628
|
export interface GetPaymentCollectabilityStatusResponse {
|
|
2587
2629
|
/** Payment collectability status */
|
|
2588
|
-
status?:
|
|
2630
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2589
2631
|
/** Collectable order amount */
|
|
2590
2632
|
amount?: Price;
|
|
2591
2633
|
}
|
|
@@ -2599,6 +2641,8 @@ export declare enum PaymentCollectabilityStatus {
|
|
|
2599
2641
|
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2600
2642
|
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2601
2643
|
}
|
|
2644
|
+
/** @enumType */
|
|
2645
|
+
export 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';
|
|
2602
2646
|
export interface RecordManuallyCollectedPaymentRequest {
|
|
2603
2647
|
/**
|
|
2604
2648
|
* Order ID.
|
|
@@ -2628,7 +2672,7 @@ export interface PaymentStatusUpdated {
|
|
|
2628
2672
|
/** The order that was updated */
|
|
2629
2673
|
order?: Order;
|
|
2630
2674
|
/** The previous status (before the update) */
|
|
2631
|
-
previousPaymentStatus?:
|
|
2675
|
+
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
2632
2676
|
}
|
|
2633
2677
|
export interface BulkMarkOrdersAsPaidRequest {
|
|
2634
2678
|
/**
|
|
@@ -2707,28 +2751,30 @@ export interface GetRefundabilityStatusResponse {
|
|
|
2707
2751
|
}
|
|
2708
2752
|
export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2709
2753
|
/** Reason why payment is not refundable. */
|
|
2710
|
-
nonRefundableReason?:
|
|
2754
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2711
2755
|
/** Reason why payment is only refundable manually. */
|
|
2712
|
-
manuallyRefundableReason?:
|
|
2756
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2713
2757
|
/** Payment ID. */
|
|
2714
2758
|
paymentId?: string;
|
|
2715
2759
|
/** Payment refundability status. */
|
|
2716
|
-
refundabilityStatus?:
|
|
2760
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
2717
2761
|
/** Link to payment provider dashboard. */
|
|
2718
2762
|
providerLink?: string | null;
|
|
2719
2763
|
}
|
|
2720
2764
|
/** @oneof */
|
|
2721
2765
|
export interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2722
2766
|
/** Reason why payment is not refundable. */
|
|
2723
|
-
nonRefundableReason?:
|
|
2767
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2724
2768
|
/** Reason why payment is only refundable manually. */
|
|
2725
|
-
manuallyRefundableReason?:
|
|
2769
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2726
2770
|
}
|
|
2727
2771
|
export declare enum RefundableStatus {
|
|
2728
2772
|
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2729
2773
|
MANUAL = "MANUAL",
|
|
2730
2774
|
REFUNDABLE = "REFUNDABLE"
|
|
2731
2775
|
}
|
|
2776
|
+
/** @enumType */
|
|
2777
|
+
export type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2732
2778
|
export declare enum NonRefundableReason {
|
|
2733
2779
|
NONE = "NONE",
|
|
2734
2780
|
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
@@ -2744,12 +2790,16 @@ export declare enum NonRefundableReason {
|
|
|
2744
2790
|
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2745
2791
|
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2746
2792
|
}
|
|
2793
|
+
/** @enumType */
|
|
2794
|
+
export 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';
|
|
2747
2795
|
export declare enum ManuallyRefundableReason {
|
|
2748
2796
|
EXPIRED = "EXPIRED",
|
|
2749
2797
|
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2750
2798
|
OFFLINE = "OFFLINE",
|
|
2751
2799
|
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2752
2800
|
}
|
|
2801
|
+
/** @enumType */
|
|
2802
|
+
export type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2753
2803
|
export interface CreatePaymentGatewayOrderRequest {
|
|
2754
2804
|
/**
|
|
2755
2805
|
* Ecom order ID.
|
|
@@ -2981,7 +3031,7 @@ export interface RefundSideEffects {
|
|
|
2981
3031
|
}
|
|
2982
3032
|
export interface RestockInfo {
|
|
2983
3033
|
/** Restock type. */
|
|
2984
|
-
type?:
|
|
3034
|
+
type?: RestockTypeWithLiterals;
|
|
2985
3035
|
/**
|
|
2986
3036
|
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
2987
3037
|
* @maxSize 300
|
|
@@ -2993,6 +3043,8 @@ export declare enum RestockType {
|
|
|
2993
3043
|
ALL_ITEMS = "ALL_ITEMS",
|
|
2994
3044
|
SOME_ITEMS = "SOME_ITEMS"
|
|
2995
3045
|
}
|
|
3046
|
+
/** @enumType */
|
|
3047
|
+
export type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
2996
3048
|
export interface RestockItem {
|
|
2997
3049
|
/**
|
|
2998
3050
|
* ID of the line item being restocked.
|
|
@@ -3124,7 +3176,7 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
|
|
|
3124
3176
|
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
3125
3177
|
offlinePayment?: boolean;
|
|
3126
3178
|
/** Payment status. */
|
|
3127
|
-
status?:
|
|
3179
|
+
status?: TransactionStatusWithLiterals;
|
|
3128
3180
|
/**
|
|
3129
3181
|
* Whether there is a payment agreement that allows for future charges.
|
|
3130
3182
|
* @immutable
|
|
@@ -3156,6 +3208,8 @@ export declare enum TransactionStatus {
|
|
|
3156
3208
|
AUTHORIZED = "AUTHORIZED",
|
|
3157
3209
|
VOIDED = "VOIDED"
|
|
3158
3210
|
}
|
|
3211
|
+
/** @enumType */
|
|
3212
|
+
export type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3159
3213
|
export interface CreditCardPaymentMethodDetails {
|
|
3160
3214
|
/**
|
|
3161
3215
|
* The last 4 digits of the card number.
|
|
@@ -3195,7 +3249,7 @@ export interface AuthorizationCapture {
|
|
|
3195
3249
|
*/
|
|
3196
3250
|
_id?: string | null;
|
|
3197
3251
|
/** Status of this capture action */
|
|
3198
|
-
status?:
|
|
3252
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3199
3253
|
/**
|
|
3200
3254
|
* Amount of this capture
|
|
3201
3255
|
* @immutable
|
|
@@ -3215,19 +3269,21 @@ export declare enum AuthorizationCaptureStatus {
|
|
|
3215
3269
|
/** Capture operation failed. */
|
|
3216
3270
|
FAILED = "FAILED"
|
|
3217
3271
|
}
|
|
3272
|
+
/** @enumType */
|
|
3273
|
+
export type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3218
3274
|
export interface AuthorizationActionFailureDetails {
|
|
3219
3275
|
/** @maxLength 100 */
|
|
3220
3276
|
failureCode?: string;
|
|
3221
3277
|
}
|
|
3222
3278
|
export interface AuthorizationVoid {
|
|
3223
3279
|
/** Status of this void action */
|
|
3224
|
-
status?:
|
|
3280
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
3225
3281
|
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3226
3282
|
voidedDate?: Date | null;
|
|
3227
3283
|
/** In case of status is FAILED may contain failure details */
|
|
3228
3284
|
failureDetails?: AuthorizationActionFailureDetails;
|
|
3229
3285
|
/** Reason of void action */
|
|
3230
|
-
reason?:
|
|
3286
|
+
reason?: ReasonWithLiterals;
|
|
3231
3287
|
}
|
|
3232
3288
|
export declare enum AuthorizationVoidStatus {
|
|
3233
3289
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
@@ -3238,6 +3294,8 @@ export declare enum AuthorizationVoidStatus {
|
|
|
3238
3294
|
/** Void operation failed. */
|
|
3239
3295
|
FAILED = "FAILED"
|
|
3240
3296
|
}
|
|
3297
|
+
/** @enumType */
|
|
3298
|
+
export type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3241
3299
|
/** Reason the authorization was voided. */
|
|
3242
3300
|
export declare enum Reason {
|
|
3243
3301
|
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
@@ -3246,9 +3304,11 @@ export declare enum Reason {
|
|
|
3246
3304
|
/** Authorization passed execution date. */
|
|
3247
3305
|
SCHEDULED = "SCHEDULED"
|
|
3248
3306
|
}
|
|
3307
|
+
/** @enumType */
|
|
3308
|
+
export type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3249
3309
|
export interface V1ScheduledAction {
|
|
3250
3310
|
/** Type of the action. */
|
|
3251
|
-
actionType?:
|
|
3311
|
+
actionType?: ActionTypeWithLiterals;
|
|
3252
3312
|
/** The date and time of the action. */
|
|
3253
3313
|
executionDate?: Date | null;
|
|
3254
3314
|
}
|
|
@@ -3257,6 +3317,8 @@ export declare enum ActionType {
|
|
|
3257
3317
|
VOID = "VOID",
|
|
3258
3318
|
CAPTURE = "CAPTURE"
|
|
3259
3319
|
}
|
|
3320
|
+
/** @enumType */
|
|
3321
|
+
export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3260
3322
|
export interface GiftCardPaymentDetails {
|
|
3261
3323
|
/**
|
|
3262
3324
|
* Gift card payment ID.
|
|
@@ -3296,7 +3358,7 @@ export interface MembershipPaymentDetails {
|
|
|
3296
3358
|
*/
|
|
3297
3359
|
lineItemId?: string;
|
|
3298
3360
|
/** Payment status. */
|
|
3299
|
-
status?:
|
|
3361
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
3300
3362
|
/** Membership name. */
|
|
3301
3363
|
name?: MembershipName;
|
|
3302
3364
|
/**
|
|
@@ -3322,6 +3384,8 @@ export declare enum MembershipPaymentStatus {
|
|
|
3322
3384
|
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3323
3385
|
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3324
3386
|
}
|
|
3387
|
+
/** @enumType */
|
|
3388
|
+
export type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3325
3389
|
export interface WixReceiptInfo {
|
|
3326
3390
|
/**
|
|
3327
3391
|
* Receipt ID
|
|
@@ -3399,7 +3463,7 @@ export interface RefundTransaction {
|
|
|
3399
3463
|
*/
|
|
3400
3464
|
amount?: Price;
|
|
3401
3465
|
/** Refund status. */
|
|
3402
|
-
refundStatus?:
|
|
3466
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
3403
3467
|
/** Optional details of current refund status. */
|
|
3404
3468
|
refundStatusInfo?: RefundStatusInfo;
|
|
3405
3469
|
/**
|
|
@@ -3429,6 +3493,8 @@ export declare enum RefundStatus {
|
|
|
3429
3493
|
/** Refund was initiated on payment provider side. */
|
|
3430
3494
|
STARTED = "STARTED"
|
|
3431
3495
|
}
|
|
3496
|
+
/** @enumType */
|
|
3497
|
+
export type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3432
3498
|
export interface RefundStatusInfo {
|
|
3433
3499
|
/**
|
|
3434
3500
|
* Reason code for the refund's current status.
|
|
@@ -3696,7 +3762,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3696
3762
|
*/
|
|
3697
3763
|
appId?: string;
|
|
3698
3764
|
/** @readonly */
|
|
3699
|
-
identityType?:
|
|
3765
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3700
3766
|
}
|
|
3701
3767
|
/** @oneof */
|
|
3702
3768
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3728,6 +3794,8 @@ export declare enum WebhookIdentityType {
|
|
|
3728
3794
|
WIX_USER = "WIX_USER",
|
|
3729
3795
|
APP = "APP"
|
|
3730
3796
|
}
|
|
3797
|
+
/** @enumType */
|
|
3798
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3731
3799
|
export declare enum TextDetection {
|
|
3732
3800
|
/** No detection was made */
|
|
3733
3801
|
UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
|
|
@@ -3736,6 +3804,8 @@ export declare enum TextDetection {
|
|
|
3736
3804
|
/** The image does not contain text */
|
|
3737
3805
|
NO_TEXT = "NO_TEXT"
|
|
3738
3806
|
}
|
|
3807
|
+
/** @enumType */
|
|
3808
|
+
export type TextDetectionWithLiterals = TextDetection | 'UNKNOWN_TEXT_DETECTION' | 'CONTAINS_TEXT' | 'NO_TEXT';
|
|
3739
3809
|
export declare enum AnimationDetection {
|
|
3740
3810
|
/** No detection was made */
|
|
3741
3811
|
UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
|
|
@@ -3744,11 +3814,13 @@ export declare enum AnimationDetection {
|
|
|
3744
3814
|
/** The image does not contain animation */
|
|
3745
3815
|
NO_ANIMATION = "NO_ANIMATION"
|
|
3746
3816
|
}
|
|
3817
|
+
/** @enumType */
|
|
3818
|
+
export type AnimationDetectionWithLiterals = AnimationDetection | 'UNKNOWN_ANIMATION_DETECTION' | 'CONTAINS_ANIMATION' | 'NO_ANIMATION';
|
|
3747
3819
|
export interface ImageContent {
|
|
3748
3820
|
/** Text detection */
|
|
3749
|
-
text?:
|
|
3821
|
+
text?: TextDetectionWithLiterals;
|
|
3750
3822
|
/** Animation detection */
|
|
3751
|
-
animation?:
|
|
3823
|
+
animation?: AnimationDetectionWithLiterals;
|
|
3752
3824
|
}
|
|
3753
3825
|
export interface SendBuyerConfirmationEmailRequest {
|
|
3754
3826
|
/** @format GUID */
|
|
@@ -3865,7 +3937,7 @@ export interface SendMerchantOrderReceivedPushRequest {
|
|
|
3865
3937
|
export interface SendMerchantOrderReceivedPushResponse {
|
|
3866
3938
|
}
|
|
3867
3939
|
export interface PreviewEmailByTypeRequest {
|
|
3868
|
-
emailType?:
|
|
3940
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
3869
3941
|
}
|
|
3870
3942
|
export declare enum PreviewEmailType {
|
|
3871
3943
|
ORDER_PLACED = "ORDER_PLACED",
|
|
@@ -3873,6 +3945,8 @@ export declare enum PreviewEmailType {
|
|
|
3873
3945
|
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3874
3946
|
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
3875
3947
|
}
|
|
3948
|
+
/** @enumType */
|
|
3949
|
+
export type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
3876
3950
|
export interface PreviewEmailByTypeResponse {
|
|
3877
3951
|
emailPreview?: string;
|
|
3878
3952
|
}
|
|
@@ -4042,7 +4116,7 @@ export interface MetaSite {
|
|
|
4042
4116
|
*/
|
|
4043
4117
|
apps?: App[];
|
|
4044
4118
|
/** Namespace of meta site. */
|
|
4045
|
-
namespace?:
|
|
4119
|
+
namespace?: NamespaceWithLiterals;
|
|
4046
4120
|
/**
|
|
4047
4121
|
* Indicates whether https should be used for viewing a site.
|
|
4048
4122
|
*
|
|
@@ -4143,7 +4217,7 @@ export interface App {
|
|
|
4143
4217
|
* State of this app (see docs for state).
|
|
4144
4218
|
* @readonly
|
|
4145
4219
|
*/
|
|
4146
|
-
state?:
|
|
4220
|
+
state?: StateWithLiterals;
|
|
4147
4221
|
/**
|
|
4148
4222
|
* Identifier of the originating application. For example, if this app was part of a template,
|
|
4149
4223
|
* then an app will get instance_id of that app as origin instance id.
|
|
@@ -4170,6 +4244,8 @@ export declare enum State {
|
|
|
4170
4244
|
/** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
|
|
4171
4245
|
PENDING = "PENDING"
|
|
4172
4246
|
}
|
|
4247
|
+
/** @enumType */
|
|
4248
|
+
export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'TEMPLATE' | 'PENDING';
|
|
4173
4249
|
export declare enum Namespace {
|
|
4174
4250
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4175
4251
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
@@ -4252,6 +4328,8 @@ export declare enum Namespace {
|
|
|
4252
4328
|
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4253
4329
|
MIMIR = "MIMIR"
|
|
4254
4330
|
}
|
|
4331
|
+
/** @enumType */
|
|
4332
|
+
export 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';
|
|
4255
4333
|
export interface SeoData {
|
|
4256
4334
|
/**
|
|
4257
4335
|
* A title.
|
|
@@ -4377,12 +4455,14 @@ export interface Sorting {
|
|
|
4377
4455
|
*/
|
|
4378
4456
|
fieldName?: string;
|
|
4379
4457
|
/** Sort order. */
|
|
4380
|
-
order?:
|
|
4458
|
+
order?: SortOrderWithLiterals;
|
|
4381
4459
|
}
|
|
4382
4460
|
export declare enum SortOrder {
|
|
4383
4461
|
ASC = "ASC",
|
|
4384
4462
|
DESC = "DESC"
|
|
4385
4463
|
}
|
|
4464
|
+
/** @enumType */
|
|
4465
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
4386
4466
|
export interface PlatformPaging {
|
|
4387
4467
|
/**
|
|
4388
4468
|
* Number of items to load.
|
|
@@ -4603,7 +4683,7 @@ export interface VersionedDocumentUpdateOperation {
|
|
|
4603
4683
|
/** documents to create or overwrite */
|
|
4604
4684
|
documents?: InternalDocument[];
|
|
4605
4685
|
/** versioning mode to use instead of default */
|
|
4606
|
-
versioningMode?:
|
|
4686
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4607
4687
|
}
|
|
4608
4688
|
export declare enum VersioningMode {
|
|
4609
4689
|
/** use default versioning mode agreed with search team */
|
|
@@ -4613,6 +4693,8 @@ export declare enum VersioningMode {
|
|
|
4613
4693
|
/** execute only if version is greater or equal to existing */
|
|
4614
4694
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4615
4695
|
}
|
|
4696
|
+
/** @enumType */
|
|
4697
|
+
export type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
4616
4698
|
export interface VersionedDeleteByIdsOperation {
|
|
4617
4699
|
/** ids with version of the documents to delete */
|
|
4618
4700
|
documentIds?: VersionedDocumentId[];
|
|
@@ -4623,7 +4705,7 @@ export interface VersionedDocumentId {
|
|
|
4623
4705
|
/** document version */
|
|
4624
4706
|
version?: string;
|
|
4625
4707
|
/** versioning mode to use instead of default */
|
|
4626
|
-
versioningMode?:
|
|
4708
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4627
4709
|
}
|
|
4628
4710
|
export interface TriggerReindexRequest {
|
|
4629
4711
|
/** @format GUID */
|
|
@@ -4760,7 +4842,7 @@ export interface OrderCreationSettings {
|
|
|
4760
4842
|
* Condition for the order to be approved.
|
|
4761
4843
|
* Default: `DEFAULT`
|
|
4762
4844
|
*/
|
|
4763
|
-
orderApprovalStrategy?:
|
|
4845
|
+
orderApprovalStrategy?: OrderApprovalStrategyWithLiterals;
|
|
4764
4846
|
/** Notification settings to be applied on order creation */
|
|
4765
4847
|
notifications?: OrderCreateNotifications;
|
|
4766
4848
|
}
|
|
@@ -4772,6 +4854,8 @@ export declare enum OrderApprovalStrategy {
|
|
|
4772
4854
|
/** Order is automatically approved when payment method is saved for it. */
|
|
4773
4855
|
PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
|
|
4774
4856
|
}
|
|
4857
|
+
/** @enumType */
|
|
4858
|
+
export type OrderApprovalStrategyWithLiterals = OrderApprovalStrategy | 'DEFAULT' | 'PAYMENT_RECEIVED' | 'PAYMENT_METHOD_SAVED';
|
|
4775
4859
|
export interface OrderCreateNotifications {
|
|
4776
4860
|
/**
|
|
4777
4861
|
* Whether to send notification to the buyer.
|
|
@@ -5031,7 +5115,7 @@ export interface OrderLineItemChangedDetails {
|
|
|
5031
5115
|
* + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
5032
5116
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
5033
5117
|
*/
|
|
5034
|
-
paymentOption?:
|
|
5118
|
+
paymentOption?: DeltaPaymentOptionTypeWithLiterals;
|
|
5035
5119
|
/**
|
|
5036
5120
|
* Deprecated. Use `taxInfo` instead.
|
|
5037
5121
|
* This field will be removed on September 30, 2024.
|
|
@@ -5084,6 +5168,8 @@ export declare enum DeltaPaymentOptionType {
|
|
|
5084
5168
|
*/
|
|
5085
5169
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
5086
5170
|
}
|
|
5171
|
+
/** @enumType */
|
|
5172
|
+
export type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'UNKNOWN_PAYMENT_OPTION' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
|
|
5087
5173
|
export interface ItemChangedDetails {
|
|
5088
5174
|
/**
|
|
5089
5175
|
* The quantity before the change.
|
|
@@ -5141,7 +5227,7 @@ export interface DraftOrderCommitSettings {
|
|
|
5141
5227
|
}
|
|
5142
5228
|
export interface InventoryUpdateDetails {
|
|
5143
5229
|
/** Action to be applied - decrease or restock */
|
|
5144
|
-
actionType?:
|
|
5230
|
+
actionType?: InventoryActionWithLiterals;
|
|
5145
5231
|
/** Order line item id */
|
|
5146
5232
|
lineItemId?: string;
|
|
5147
5233
|
/** The amount to be increased or restocked */
|
|
@@ -5153,6 +5239,8 @@ export declare enum InventoryAction {
|
|
|
5153
5239
|
/** Decrease inventory. Without failing on negative inventory. */
|
|
5154
5240
|
DECREASE = "DECREASE"
|
|
5155
5241
|
}
|
|
5242
|
+
/** @enumType */
|
|
5243
|
+
export type InventoryActionWithLiterals = InventoryAction | 'RESTOCK' | 'DECREASE';
|
|
5156
5244
|
export interface CommitDeltasResponse {
|
|
5157
5245
|
/** Order after deltas are applied */
|
|
5158
5246
|
order?: Order;
|
|
@@ -5858,7 +5946,7 @@ export interface UpdateOrderStatusRequest {
|
|
|
5858
5946
|
*/
|
|
5859
5947
|
orderId: string;
|
|
5860
5948
|
/** New order status. */
|
|
5861
|
-
status:
|
|
5949
|
+
status: OrderStatusWithLiterals;
|
|
5862
5950
|
}
|
|
5863
5951
|
export interface UpdateOrderStatusResponse {
|
|
5864
5952
|
/** Updated order. */
|
|
@@ -5881,9 +5969,9 @@ export interface FulfillmentStatusUpdated {
|
|
|
5881
5969
|
/** The order that was updated */
|
|
5882
5970
|
order?: Order;
|
|
5883
5971
|
/** The previous status (before the update) */
|
|
5884
|
-
previousFulfillmentStatus?:
|
|
5972
|
+
previousFulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
5885
5973
|
/** the new status (after the update) */
|
|
5886
|
-
newFulfillmentStatus?:
|
|
5974
|
+
newFulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
5887
5975
|
/** the action that caused this update */
|
|
5888
5976
|
action?: string;
|
|
5889
5977
|
}
|
|
@@ -6138,7 +6226,7 @@ export interface InvoiceSentEvent {
|
|
|
6138
6226
|
/** @readonly */
|
|
6139
6227
|
data?: InvoiceFields;
|
|
6140
6228
|
/** @readonly */
|
|
6141
|
-
status?:
|
|
6229
|
+
status?: InvoiceStatusWithLiterals;
|
|
6142
6230
|
}
|
|
6143
6231
|
export interface IdAndVersion {
|
|
6144
6232
|
/** @format GUID */
|
|
@@ -6242,7 +6330,7 @@ export interface QuotesAddress {
|
|
|
6242
6330
|
}
|
|
6243
6331
|
export interface AddressDescription {
|
|
6244
6332
|
content?: string;
|
|
6245
|
-
placement?:
|
|
6333
|
+
placement?: PlacementWithLiterals;
|
|
6246
6334
|
}
|
|
6247
6335
|
export declare enum Placement {
|
|
6248
6336
|
Unknown = "Unknown",
|
|
@@ -6250,6 +6338,8 @@ export declare enum Placement {
|
|
|
6250
6338
|
Before = "Before",
|
|
6251
6339
|
After = "After"
|
|
6252
6340
|
}
|
|
6341
|
+
/** @enumType */
|
|
6342
|
+
export type PlacementWithLiterals = Placement | 'Unknown' | 'Replace' | 'Before' | 'After';
|
|
6253
6343
|
export interface Phone {
|
|
6254
6344
|
number?: string;
|
|
6255
6345
|
}
|
|
@@ -6305,6 +6395,8 @@ export declare enum SubdivisionType {
|
|
|
6305
6395
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
6306
6396
|
COUNTRY = "COUNTRY"
|
|
6307
6397
|
}
|
|
6398
|
+
/** @enumType */
|
|
6399
|
+
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
6308
6400
|
/** Subdivision Concordance values */
|
|
6309
6401
|
export interface StandardDetails {
|
|
6310
6402
|
/**
|
|
@@ -6361,7 +6453,7 @@ export interface Source {
|
|
|
6361
6453
|
* App or service type.
|
|
6362
6454
|
* @readonly
|
|
6363
6455
|
*/
|
|
6364
|
-
sourceType?:
|
|
6456
|
+
sourceType?: SourceTypeWithLiterals;
|
|
6365
6457
|
}
|
|
6366
6458
|
export declare enum SourceType {
|
|
6367
6459
|
UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
|
|
@@ -6370,6 +6462,8 @@ export declare enum SourceType {
|
|
|
6370
6462
|
ADMIN = "ADMIN",
|
|
6371
6463
|
OTHER = "OTHER"
|
|
6372
6464
|
}
|
|
6465
|
+
/** @enumType */
|
|
6466
|
+
export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'WIX_APP' | 'EXTERNAL' | 'ADMIN' | 'OTHER';
|
|
6373
6467
|
export interface LineItemMetaData {
|
|
6374
6468
|
metadata?: Record<string, string>;
|
|
6375
6469
|
}
|
|
@@ -6468,7 +6562,7 @@ export interface CustomFieldValue {
|
|
|
6468
6562
|
/** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
|
|
6469
6563
|
namespace?: string | null;
|
|
6470
6564
|
/** The group of the custom field indicates its intended placement in the financial document */
|
|
6471
|
-
group?:
|
|
6565
|
+
group?: CustomFieldGroupWithLiterals;
|
|
6472
6566
|
/** The value of the custom field */
|
|
6473
6567
|
value?: Value;
|
|
6474
6568
|
/**
|
|
@@ -6485,9 +6579,11 @@ export declare enum CustomFieldGroup {
|
|
|
6485
6579
|
FOOTER = "FOOTER",
|
|
6486
6580
|
OTHER = "OTHER"
|
|
6487
6581
|
}
|
|
6582
|
+
/** @enumType */
|
|
6583
|
+
export type CustomFieldGroupWithLiterals = CustomFieldGroup | 'UNKNOWN_CUSTOM_FIELD_GROUP' | 'BUSINESS_DETAILS' | 'CUSTOMER_DETAILS' | 'DOCUMENT' | 'FOOTER' | 'OTHER';
|
|
6488
6584
|
export interface Value {
|
|
6489
6585
|
value?: string;
|
|
6490
|
-
valueType?:
|
|
6586
|
+
valueType?: ValueTypeWithLiterals;
|
|
6491
6587
|
}
|
|
6492
6588
|
export declare enum ValueType {
|
|
6493
6589
|
UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
|
|
@@ -6496,6 +6592,8 @@ export declare enum ValueType {
|
|
|
6496
6592
|
BOOLEAN = "BOOLEAN",
|
|
6497
6593
|
NUMBER = "NUMBER"
|
|
6498
6594
|
}
|
|
6595
|
+
/** @enumType */
|
|
6596
|
+
export type ValueTypeWithLiterals = ValueType | 'UNKNOWN_VALUE_TYPE' | 'STRING' | 'DATE' | 'BOOLEAN' | 'NUMBER';
|
|
6499
6597
|
export interface Deposit {
|
|
6500
6598
|
/**
|
|
6501
6599
|
* The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
|
|
@@ -6512,13 +6610,15 @@ export interface Deposit {
|
|
|
6512
6610
|
*/
|
|
6513
6611
|
percentage?: string;
|
|
6514
6612
|
/** The type of the deposit. The default is FLAT. */
|
|
6515
|
-
type?:
|
|
6613
|
+
type?: DepositTypeWithLiterals;
|
|
6516
6614
|
}
|
|
6517
6615
|
export declare enum DepositType {
|
|
6518
6616
|
UNKNOWN = "UNKNOWN",
|
|
6519
6617
|
FLAT = "FLAT",
|
|
6520
6618
|
PERCENTAGE = "PERCENTAGE"
|
|
6521
6619
|
}
|
|
6620
|
+
/** @enumType */
|
|
6621
|
+
export type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
|
|
6522
6622
|
/**
|
|
6523
6623
|
* InvoiceStatus allowed transitions based on current status:
|
|
6524
6624
|
* Draft -> Deleted, Paid, Partially Paid, Sent
|
|
@@ -6540,6 +6640,8 @@ export declare enum InvoiceStatus {
|
|
|
6540
6640
|
PartiallyPaid = "PartiallyPaid",
|
|
6541
6641
|
PartialAndOverdue = "PartialAndOverdue"
|
|
6542
6642
|
}
|
|
6643
|
+
/** @enumType */
|
|
6644
|
+
export type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
6543
6645
|
export interface TriggerSideEffectsFromLegacyData {
|
|
6544
6646
|
storeId?: string;
|
|
6545
6647
|
orderId?: string;
|
|
@@ -7065,7 +7167,9 @@ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, O
|
|
|
7065
7167
|
* To learn about working with _Search_ endpoints, see
|
|
7066
7168
|
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
|
|
7067
7169
|
* [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
7170
|
+
* @param search - Search options.
|
|
7068
7171
|
* @public
|
|
7172
|
+
* @requiredField search
|
|
7069
7173
|
* @permissionId ECOM.READ_ORDERS
|
|
7070
7174
|
* @permissionScope Manage Stores - all permissions
|
|
7071
7175
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -7086,13 +7190,171 @@ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, O
|
|
|
7086
7190
|
* @applicableIdentity APP
|
|
7087
7191
|
* @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
|
|
7088
7192
|
*/
|
|
7089
|
-
export declare function searchOrders(
|
|
7193
|
+
export declare function searchOrders(search: OrderSearch): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
7090
7194
|
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
7091
7195
|
}[OrderNonNullablePaths]>>;
|
|
7092
|
-
export interface
|
|
7093
|
-
|
|
7094
|
-
|
|
7095
|
-
|
|
7196
|
+
export interface OrderSearchSpec extends SearchSpec {
|
|
7197
|
+
aggregatable: [
|
|
7198
|
+
'_createdDate',
|
|
7199
|
+
'_id',
|
|
7200
|
+
'_updatedDate',
|
|
7201
|
+
'archived',
|
|
7202
|
+
'balanceSummary.authorized.amount',
|
|
7203
|
+
'balanceSummary.pending.amount',
|
|
7204
|
+
'balanceSummary.pendingRefund.amount',
|
|
7205
|
+
'businessLocation._id',
|
|
7206
|
+
'businessLocation.name',
|
|
7207
|
+
'buyerInfo.contactId',
|
|
7208
|
+
'buyerInfo.memberId',
|
|
7209
|
+
'channelInfo.externalOrderId',
|
|
7210
|
+
'channelInfo.type',
|
|
7211
|
+
'checkoutId',
|
|
7212
|
+
'createdBy.userId',
|
|
7213
|
+
'fulfillmentStatus',
|
|
7214
|
+
'fulfillmentStatusesAggregate.statuses',
|
|
7215
|
+
'lineItems.catalogReference.appId',
|
|
7216
|
+
'lineItems.catalogReference.catalogItemId',
|
|
7217
|
+
'lineItems.locations._id',
|
|
7218
|
+
'lineItems.productName.original',
|
|
7219
|
+
'lineItems.subscriptionInfo._id',
|
|
7220
|
+
'number',
|
|
7221
|
+
'paymentStatus',
|
|
7222
|
+
'priceSummary.total.amount',
|
|
7223
|
+
'purchasedDate',
|
|
7224
|
+
'seenByAHuman',
|
|
7225
|
+
'shippingInfo.logistics.deliveryTime',
|
|
7226
|
+
'shippingInfo.logistics.deliveryTimeSlot.from',
|
|
7227
|
+
'shippingInfo.logistics.deliveryTimeSlot.to',
|
|
7228
|
+
'shippingInfo.region.name',
|
|
7229
|
+
'shippingInfo.title',
|
|
7230
|
+
'status'
|
|
7231
|
+
];
|
|
7232
|
+
paging: 'cursor';
|
|
7233
|
+
wql: [
|
|
7234
|
+
{
|
|
7235
|
+
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
7236
|
+
fields: [
|
|
7237
|
+
'channelInfo.type',
|
|
7238
|
+
'fulfillmentStatus',
|
|
7239
|
+
'paymentStatus',
|
|
7240
|
+
'shippingInfo.region.name',
|
|
7241
|
+
'shippingInfo.title',
|
|
7242
|
+
'status'
|
|
7243
|
+
];
|
|
7244
|
+
sort: 'BOTH';
|
|
7245
|
+
},
|
|
7246
|
+
{
|
|
7247
|
+
operators: '*';
|
|
7248
|
+
fields: [
|
|
7249
|
+
'_createdDate',
|
|
7250
|
+
'_updatedDate',
|
|
7251
|
+
'balanceSummary.authorized.amount',
|
|
7252
|
+
'balanceSummary.pending.amount',
|
|
7253
|
+
'balanceSummary.pendingRefund.amount',
|
|
7254
|
+
'billingInfo.contactDetails.firstName',
|
|
7255
|
+
'billingInfo.contactDetails.lastName',
|
|
7256
|
+
'businessLocation._id',
|
|
7257
|
+
'businessLocation.name',
|
|
7258
|
+
'buyerInfo.email',
|
|
7259
|
+
'number',
|
|
7260
|
+
'priceSummary.total.amount',
|
|
7261
|
+
'purchasedDate',
|
|
7262
|
+
'shippingInfo.logistics.deliveryTime',
|
|
7263
|
+
'shippingInfo.logistics.deliveryTimeSlot.from',
|
|
7264
|
+
'shippingInfo.logistics.deliveryTimeSlot.to'
|
|
7265
|
+
];
|
|
7266
|
+
sort: 'BOTH';
|
|
7267
|
+
},
|
|
7268
|
+
{
|
|
7269
|
+
operators: '*';
|
|
7270
|
+
fields: ['archived', 'seenByAHuman'];
|
|
7271
|
+
sort: 'NONE';
|
|
7272
|
+
},
|
|
7273
|
+
{
|
|
7274
|
+
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
7275
|
+
fields: [
|
|
7276
|
+
'_id',
|
|
7277
|
+
'buyerInfo.contactId',
|
|
7278
|
+
'buyerInfo.memberId',
|
|
7279
|
+
'channelInfo.externalOrderId',
|
|
7280
|
+
'checkoutId',
|
|
7281
|
+
'createdBy.userId',
|
|
7282
|
+
'lineItems.subscriptionInfo._id'
|
|
7283
|
+
];
|
|
7284
|
+
sort: 'NONE';
|
|
7285
|
+
},
|
|
7286
|
+
{
|
|
7287
|
+
operators: ['$all', '$any'];
|
|
7288
|
+
fields: [
|
|
7289
|
+
'lineItems.catalogReference.appId',
|
|
7290
|
+
'lineItems.catalogReference.catalogItemId',
|
|
7291
|
+
'lineItems.locations._id'
|
|
7292
|
+
];
|
|
7293
|
+
sort: 'NONE';
|
|
7294
|
+
},
|
|
7295
|
+
{
|
|
7296
|
+
operators: ['$all', '$any'];
|
|
7297
|
+
fields: [
|
|
7298
|
+
'fulfillmentStatusesAggregate.statuses',
|
|
7299
|
+
'lineItems.productName.original'
|
|
7300
|
+
];
|
|
7301
|
+
sort: 'BOTH';
|
|
7302
|
+
}
|
|
7303
|
+
];
|
|
7304
|
+
}
|
|
7305
|
+
export type CommonSearchWithEntityContext = SearchSdkType<Order, OrderSearchSpec>;
|
|
7306
|
+
export type OrderSearch = {
|
|
7307
|
+
/**
|
|
7308
|
+
Cursor paging options.
|
|
7309
|
+
Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
7310
|
+
*/
|
|
7311
|
+
cursorPaging?: {
|
|
7312
|
+
/**
|
|
7313
|
+
Maximum number of items to return in the results.
|
|
7314
|
+
@max: 100
|
|
7315
|
+
*/
|
|
7316
|
+
limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
|
|
7317
|
+
/**
|
|
7318
|
+
Pointer to the next or previous page in the list of results.
|
|
7319
|
+
|
|
7320
|
+
Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
7321
|
+
Not relevant for the first request.
|
|
7322
|
+
@maxLength: 16000
|
|
7323
|
+
*/
|
|
7324
|
+
cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
|
|
7325
|
+
};
|
|
7326
|
+
/**
|
|
7327
|
+
Filter object.
|
|
7328
|
+
|
|
7329
|
+
For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
|
|
7330
|
+
|
|
7331
|
+
`"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
|
|
7332
|
+
|
|
7333
|
+
Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
7334
|
+
*/
|
|
7335
|
+
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
7336
|
+
/**
|
|
7337
|
+
Array of sort objects that specify the order in which results should be sorted.
|
|
7338
|
+
|
|
7339
|
+
For example, the following `sort` array will sort by `createdDate` in descending order:
|
|
7340
|
+
|
|
7341
|
+
`"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
|
|
7342
|
+
|
|
7343
|
+
Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
7344
|
+
@maxSize: 4
|
|
7345
|
+
*/
|
|
7346
|
+
sort?: {
|
|
7347
|
+
/**
|
|
7348
|
+
Name of the field to sort by.
|
|
7349
|
+
@maxLength: 512
|
|
7350
|
+
*/
|
|
7351
|
+
fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
|
|
7352
|
+
/**
|
|
7353
|
+
Sort order.
|
|
7354
|
+
*/
|
|
7355
|
+
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
7356
|
+
}[];
|
|
7357
|
+
};
|
|
7096
7358
|
/**
|
|
7097
7359
|
* Creates an order.
|
|
7098
7360
|
*
|
|
@@ -7219,19 +7481,19 @@ export interface UpdateOrder {
|
|
|
7219
7481
|
/** Buyer information. */
|
|
7220
7482
|
buyerInfo?: BuyerInfo;
|
|
7221
7483
|
/** Order payment status. */
|
|
7222
|
-
paymentStatus?:
|
|
7484
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
7223
7485
|
/**
|
|
7224
7486
|
* Order fulfillment status.
|
|
7225
7487
|
* @readonly
|
|
7226
7488
|
*/
|
|
7227
|
-
fulfillmentStatus?:
|
|
7489
|
+
fulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
7228
7490
|
/**
|
|
7229
7491
|
* Language for communication with the buyer. Defaults to the site language.
|
|
7230
7492
|
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
7231
7493
|
*/
|
|
7232
7494
|
buyerLanguage?: string | null;
|
|
7233
7495
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
7234
|
-
weightUnit?:
|
|
7496
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
7235
7497
|
/**
|
|
7236
7498
|
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
7237
7499
|
* @format CURRENCY
|
|
@@ -7265,7 +7527,7 @@ export interface UpdateOrder {
|
|
|
7265
7527
|
*/
|
|
7266
7528
|
buyerNote?: string | null;
|
|
7267
7529
|
/** Order status. */
|
|
7268
|
-
status?:
|
|
7530
|
+
status?: OrderStatusWithLiterals;
|
|
7269
7531
|
/** Whether order is archived. */
|
|
7270
7532
|
archived?: boolean | null;
|
|
7271
7533
|
/**
|
|
@@ -7293,7 +7555,7 @@ export interface UpdateOrder {
|
|
|
7293
7555
|
*/
|
|
7294
7556
|
activities?: Activity[];
|
|
7295
7557
|
/** Order attribution source. */
|
|
7296
|
-
attributionSource?:
|
|
7558
|
+
attributionSource?: AttributionSourceWithLiterals;
|
|
7297
7559
|
/**
|
|
7298
7560
|
* ID of the order's initiator.
|
|
7299
7561
|
* @readonly
|
|
@@ -7563,7 +7825,7 @@ export interface UpdateOrderLineItem {
|
|
|
7563
7825
|
*
|
|
7564
7826
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
7565
7827
|
*/
|
|
7566
|
-
paymentOption?:
|
|
7828
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
7567
7829
|
/**
|
|
7568
7830
|
* Deprecated. Use `taxInfo` instead.
|
|
7569
7831
|
* This field will be removed on September 30, 2024.
|
|
@@ -7795,7 +8057,7 @@ export interface CancelOrderOptions {
|
|
|
7795
8057
|
* @applicableIdentity APP
|
|
7796
8058
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
7797
8059
|
*/
|
|
7798
|
-
export declare function updateOrderStatus(orderId: string, status:
|
|
8060
|
+
export declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
7799
8061
|
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7800
8062
|
}[OrderNonNullablePaths]>>;
|
|
7801
8063
|
/** @internal
|