@wix/auto_sdk_ecom_draft-orders 1.0.30 → 1.0.32
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/src/ecom-v1-draft-order-draft-orders.types.d.ts +95 -37
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +99 -41
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +95 -37
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +99 -41
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +95 -37
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +99 -41
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +95 -37
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +99 -41
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -74,9 +74,9 @@ export interface DraftOrder {
|
|
|
74
74
|
* Draft order status.
|
|
75
75
|
* @readonly
|
|
76
76
|
*/
|
|
77
|
-
status?:
|
|
77
|
+
status?: EditingStatusWithLiterals;
|
|
78
78
|
/** Weight measurement unit. Defaults to the site's weight unit. */
|
|
79
|
-
weightUnit?:
|
|
79
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
80
80
|
/**
|
|
81
81
|
* Currency used for pricing.
|
|
82
82
|
* @format CURRENCY
|
|
@@ -275,7 +275,7 @@ export interface OrderLineItem {
|
|
|
275
275
|
*
|
|
276
276
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
277
277
|
*/
|
|
278
|
-
paymentOption?:
|
|
278
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
279
279
|
/**
|
|
280
280
|
* Deprecated. Use `taxInfo` instead.
|
|
281
281
|
* This field will be removed on September 30, 2024.
|
|
@@ -447,6 +447,8 @@ export declare enum DescriptionLineType {
|
|
|
447
447
|
/** Color type. */
|
|
448
448
|
COLOR = "COLOR"
|
|
449
449
|
}
|
|
450
|
+
/** @enumType */
|
|
451
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
450
452
|
export interface FocalPoint {
|
|
451
453
|
/** X-coordinate of the focal point. */
|
|
452
454
|
x?: number;
|
|
@@ -470,14 +472,14 @@ export interface PhysicalProperties {
|
|
|
470
472
|
}
|
|
471
473
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
472
474
|
/** Preset item type. */
|
|
473
|
-
preset?:
|
|
475
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
474
476
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
475
477
|
custom?: string;
|
|
476
478
|
}
|
|
477
479
|
/** @oneof */
|
|
478
480
|
export interface ItemTypeItemTypeDataOneOf {
|
|
479
481
|
/** Preset item type. */
|
|
480
|
-
preset?:
|
|
482
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
481
483
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
482
484
|
custom?: string;
|
|
483
485
|
}
|
|
@@ -488,6 +490,8 @@ export declare enum ItemTypeItemType {
|
|
|
488
490
|
GIFT_CARD = "GIFT_CARD",
|
|
489
491
|
SERVICE = "SERVICE"
|
|
490
492
|
}
|
|
493
|
+
/** @enumType */
|
|
494
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
491
495
|
/** Type of selected payment option for catalog item */
|
|
492
496
|
export declare enum PaymentOptionType {
|
|
493
497
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -501,6 +505,8 @@ export declare enum PaymentOptionType {
|
|
|
501
505
|
/** 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`. */
|
|
502
506
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
503
507
|
}
|
|
508
|
+
/** @enumType */
|
|
509
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
504
510
|
export interface ItemTaxFullDetails {
|
|
505
511
|
/** Taxable amount of this line item. */
|
|
506
512
|
taxableAmount?: Price;
|
|
@@ -566,7 +572,7 @@ export interface LineItemTaxBreakdown {
|
|
|
566
572
|
*/
|
|
567
573
|
taxName?: string | null;
|
|
568
574
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
569
|
-
jurisdictionType?:
|
|
575
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
570
576
|
/** Non-taxable amount of the line item price. */
|
|
571
577
|
nonTaxableAmount?: Price;
|
|
572
578
|
/** Taxable amount of the line item price. */
|
|
@@ -581,6 +587,8 @@ export declare enum JurisdictionType {
|
|
|
581
587
|
CITY = "CITY",
|
|
582
588
|
SPECIAL = "SPECIAL"
|
|
583
589
|
}
|
|
590
|
+
/** @enumType */
|
|
591
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
584
592
|
export interface DigitalFile {
|
|
585
593
|
/**
|
|
586
594
|
* ID of the secure file in media.
|
|
@@ -684,7 +692,7 @@ export interface SubscriptionDescription {
|
|
|
684
692
|
}
|
|
685
693
|
export interface SubscriptionSettings {
|
|
686
694
|
/** Frequency of recurring payment. */
|
|
687
|
-
frequency?:
|
|
695
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
688
696
|
/**
|
|
689
697
|
* Interval of recurring payment.
|
|
690
698
|
* @min 1
|
|
@@ -716,9 +724,11 @@ export declare enum SubscriptionFrequency {
|
|
|
716
724
|
MONTH = "MONTH",
|
|
717
725
|
YEAR = "YEAR"
|
|
718
726
|
}
|
|
727
|
+
/** @enumType */
|
|
728
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
719
729
|
export interface FreeTrialPeriod {
|
|
720
730
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
721
|
-
frequency?:
|
|
731
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
722
732
|
/**
|
|
723
733
|
* interval of period
|
|
724
734
|
* @min 1
|
|
@@ -728,7 +738,7 @@ export interface FreeTrialPeriod {
|
|
|
728
738
|
}
|
|
729
739
|
export interface BillingAdjustment {
|
|
730
740
|
/** The type of adjustment. */
|
|
731
|
-
type?:
|
|
741
|
+
type?: AdjustmentTypeWithLiterals;
|
|
732
742
|
/** Summary of the prorated adjustment amount. */
|
|
733
743
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
734
744
|
}
|
|
@@ -739,6 +749,8 @@ export declare enum AdjustmentType {
|
|
|
739
749
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
740
750
|
CREDIT = "CREDIT"
|
|
741
751
|
}
|
|
752
|
+
/** @enumType */
|
|
753
|
+
export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
742
754
|
export interface BillingAdjustmentPriceSummary {
|
|
743
755
|
/** Subtotal of adjustment, before tax. */
|
|
744
756
|
subtotal?: Price;
|
|
@@ -775,12 +787,12 @@ export interface LocationAndQuantity {
|
|
|
775
787
|
}
|
|
776
788
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
777
789
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
778
|
-
addressType?:
|
|
790
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
779
791
|
}
|
|
780
792
|
/** @oneof */
|
|
781
793
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
782
794
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
783
|
-
addressType?:
|
|
795
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
784
796
|
}
|
|
785
797
|
export declare enum TaxableAddressType {
|
|
786
798
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -788,6 +800,8 @@ export declare enum TaxableAddressType {
|
|
|
788
800
|
BILLING = "BILLING",
|
|
789
801
|
SHIPPING = "SHIPPING"
|
|
790
802
|
}
|
|
803
|
+
/** @enumType */
|
|
804
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
791
805
|
export interface ExtendedFields {
|
|
792
806
|
/**
|
|
793
807
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -1042,7 +1056,7 @@ export interface VatId {
|
|
|
1042
1056
|
* + `CPF`: for individual tax payers
|
|
1043
1057
|
* + `CNPJ`: for corporations
|
|
1044
1058
|
*/
|
|
1045
|
-
type?:
|
|
1059
|
+
type?: VatTypeWithLiterals;
|
|
1046
1060
|
}
|
|
1047
1061
|
/** tax info types */
|
|
1048
1062
|
export declare enum VatType {
|
|
@@ -1052,11 +1066,13 @@ export declare enum VatType {
|
|
|
1052
1066
|
/** CNPJ - for corporations */
|
|
1053
1067
|
CNPJ = "CNPJ"
|
|
1054
1068
|
}
|
|
1069
|
+
/** @enumType */
|
|
1070
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1055
1071
|
export interface V1PickupDetails {
|
|
1056
1072
|
/** Pickup address. */
|
|
1057
1073
|
address?: PickupAddress;
|
|
1058
1074
|
/** Pickup method */
|
|
1059
|
-
pickupMethod?:
|
|
1075
|
+
pickupMethod?: PickupDetailsPickupMethodWithLiterals;
|
|
1060
1076
|
}
|
|
1061
1077
|
/** Physical address */
|
|
1062
1078
|
export interface PickupAddress {
|
|
@@ -1108,6 +1124,8 @@ export declare enum PickupDetailsPickupMethod {
|
|
|
1108
1124
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1109
1125
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1110
1126
|
}
|
|
1127
|
+
/** @enumType */
|
|
1128
|
+
export type PickupDetailsPickupMethodWithLiterals = PickupDetailsPickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1111
1129
|
export interface V1DeliveryTimeSlot {
|
|
1112
1130
|
/** Delivery slot starting time. */
|
|
1113
1131
|
from?: Date | null;
|
|
@@ -1195,7 +1213,7 @@ export interface AdditionalFeeDetails {
|
|
|
1195
1213
|
* + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
|
|
1196
1214
|
* + `CUSTOM`: This additional fee was created by the Create Custom Additional Fees method.
|
|
1197
1215
|
*/
|
|
1198
|
-
source?:
|
|
1216
|
+
source?: SourceTypeWithLiterals;
|
|
1199
1217
|
/** Whether this additional fee is applied to the order. */
|
|
1200
1218
|
applied?: boolean;
|
|
1201
1219
|
}
|
|
@@ -1263,6 +1281,8 @@ export declare enum SourceType {
|
|
|
1263
1281
|
/** Added manually to draft order. */
|
|
1264
1282
|
CUSTOM = "CUSTOM"
|
|
1265
1283
|
}
|
|
1284
|
+
/** @enumType */
|
|
1285
|
+
export type SourceTypeWithLiterals = SourceType | 'ORIGINAL_ORDER' | 'AUTOMATIC' | 'CUSTOM';
|
|
1266
1286
|
export interface DiscountDetails {
|
|
1267
1287
|
/** Discount details. */
|
|
1268
1288
|
discount?: AppliedDiscount;
|
|
@@ -1273,7 +1293,7 @@ export interface DiscountDetails {
|
|
|
1273
1293
|
* + `ORIGINAL_ORDER`: This discount is part of the original order.
|
|
1274
1294
|
* + `CUSTOM`: This discount was created by the Create Custom Discounts method.
|
|
1275
1295
|
*/
|
|
1276
|
-
source?:
|
|
1296
|
+
source?: SourceTypeWithLiterals;
|
|
1277
1297
|
/** Whether this discount is applied to the order. */
|
|
1278
1298
|
applied?: boolean;
|
|
1279
1299
|
}
|
|
@@ -1290,7 +1310,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1290
1310
|
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1291
1311
|
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1292
1312
|
*/
|
|
1293
|
-
discountType?:
|
|
1313
|
+
discountType?: AppliedDiscountDiscountTypeWithLiterals;
|
|
1294
1314
|
/**
|
|
1295
1315
|
* IDs of line items discount applies to.
|
|
1296
1316
|
* Deprecated. Use `line_item_discounts` instead.
|
|
@@ -1331,6 +1351,8 @@ export declare enum AppliedDiscountDiscountType {
|
|
|
1331
1351
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1332
1352
|
SHIPPING = "SHIPPING"
|
|
1333
1353
|
}
|
|
1354
|
+
/** @enumType */
|
|
1355
|
+
export type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1334
1356
|
/** Coupon */
|
|
1335
1357
|
export interface Coupon {
|
|
1336
1358
|
/** Coupon ID. */
|
|
@@ -1347,7 +1369,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1347
1369
|
* Pre-defined discount reason (optional).
|
|
1348
1370
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1349
1371
|
*/
|
|
1350
|
-
discountReason?:
|
|
1372
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1351
1373
|
/**
|
|
1352
1374
|
* Discount description as free text (optional).
|
|
1353
1375
|
* @maxLength 200
|
|
@@ -1369,7 +1391,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1369
1391
|
* Pre-defined discount reason (optional).
|
|
1370
1392
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1371
1393
|
*/
|
|
1372
|
-
discountReason?:
|
|
1394
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1373
1395
|
/**
|
|
1374
1396
|
* Discount description as free text (optional).
|
|
1375
1397
|
* @maxLength 200
|
|
@@ -1381,6 +1403,8 @@ export declare enum DiscountReason {
|
|
|
1381
1403
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1382
1404
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1383
1405
|
}
|
|
1406
|
+
/** @enumType */
|
|
1407
|
+
export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1384
1408
|
export interface DiscountRule {
|
|
1385
1409
|
/**
|
|
1386
1410
|
* Discount rule ID
|
|
@@ -1450,6 +1474,8 @@ export declare enum EditingStatus {
|
|
|
1450
1474
|
*/
|
|
1451
1475
|
COMMITTED = "COMMITTED"
|
|
1452
1476
|
}
|
|
1477
|
+
/** @enumType */
|
|
1478
|
+
export type EditingStatusWithLiterals = EditingStatus | 'DRAFT' | 'COMMITTED';
|
|
1453
1479
|
export declare enum WeightUnit {
|
|
1454
1480
|
/** Weight unit can't be classified due to an error. */
|
|
1455
1481
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
@@ -1458,6 +1484,8 @@ export declare enum WeightUnit {
|
|
|
1458
1484
|
/** Pounds. */
|
|
1459
1485
|
LB = "LB"
|
|
1460
1486
|
}
|
|
1487
|
+
/** @enumType */
|
|
1488
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1461
1489
|
export interface PriceSummary {
|
|
1462
1490
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1463
1491
|
subtotal?: Price;
|
|
@@ -1625,7 +1653,7 @@ export interface OrderTaxBreakdown {
|
|
|
1625
1653
|
*/
|
|
1626
1654
|
jurisdiction?: string;
|
|
1627
1655
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1628
|
-
jurisdictionType?:
|
|
1656
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1629
1657
|
/**
|
|
1630
1658
|
* The rate at which this tax detail was calculated.
|
|
1631
1659
|
* @format DECIMAL_VALUE
|
|
@@ -1778,7 +1806,7 @@ export interface PickupDetails {
|
|
|
1778
1806
|
/** Pickup address. */
|
|
1779
1807
|
address?: Address;
|
|
1780
1808
|
/** Pickup method. */
|
|
1781
|
-
pickupMethod?:
|
|
1809
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1782
1810
|
}
|
|
1783
1811
|
export declare enum PickupMethod {
|
|
1784
1812
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
@@ -1787,6 +1815,8 @@ export declare enum PickupMethod {
|
|
|
1787
1815
|
/** Pickup point. */
|
|
1788
1816
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1789
1817
|
}
|
|
1818
|
+
/** @enumType */
|
|
1819
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1790
1820
|
export interface DeliveryTimeSlot {
|
|
1791
1821
|
/** Delivery time slot start time. */
|
|
1792
1822
|
from?: Date | null;
|
|
@@ -1901,10 +1931,12 @@ export declare enum RuleType {
|
|
|
1901
1931
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1902
1932
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1903
1933
|
}
|
|
1934
|
+
/** @enumType */
|
|
1935
|
+
export type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
|
|
1904
1936
|
export interface FieldViolation {
|
|
1905
1937
|
field?: string;
|
|
1906
1938
|
description?: string;
|
|
1907
|
-
violatedRule?:
|
|
1939
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
1908
1940
|
/** applicable when violated_rule=OTHER */
|
|
1909
1941
|
ruleName?: string | null;
|
|
1910
1942
|
data?: Record<string, any> | null;
|
|
@@ -2052,7 +2084,7 @@ export interface SecuredMedia {
|
|
|
2052
2084
|
*/
|
|
2053
2085
|
fileName?: string;
|
|
2054
2086
|
/** File type. */
|
|
2055
|
-
fileType?:
|
|
2087
|
+
fileType?: FileTypeWithLiterals;
|
|
2056
2088
|
}
|
|
2057
2089
|
export declare enum FileType {
|
|
2058
2090
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -2062,6 +2094,8 @@ export declare enum FileType {
|
|
|
2062
2094
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
2063
2095
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
2064
2096
|
}
|
|
2097
|
+
/** @enumType */
|
|
2098
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
2065
2099
|
export interface AddLineItemsToDraftOrderResponse {
|
|
2066
2100
|
/** Draft order calculated with the latest changes. */
|
|
2067
2101
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
@@ -2163,7 +2197,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
2163
2197
|
*/
|
|
2164
2198
|
percentage?: string | null;
|
|
2165
2199
|
/** Discount type. */
|
|
2166
|
-
discountType?:
|
|
2200
|
+
discountType?: DiscountTypeWithLiterals;
|
|
2167
2201
|
/**
|
|
2168
2202
|
* ID of line item discount applies to.
|
|
2169
2203
|
* @format GUID
|
|
@@ -2216,6 +2250,8 @@ export declare enum DiscountType {
|
|
|
2216
2250
|
/** Discount applies to shipping fee. */
|
|
2217
2251
|
SHIPPING = "SHIPPING"
|
|
2218
2252
|
}
|
|
2253
|
+
/** @enumType */
|
|
2254
|
+
export type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_TYPE' | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
2219
2255
|
export interface CreateCustomDiscountsResponse {
|
|
2220
2256
|
/** Draft order calculated with the latest changes. */
|
|
2221
2257
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
@@ -2439,7 +2475,7 @@ export interface GetOrderDraftabilityStatusResponse {
|
|
|
2439
2475
|
* Reasons why a draft order cannot be created from the order.
|
|
2440
2476
|
* @maxSize 5
|
|
2441
2477
|
*/
|
|
2442
|
-
nonDraftableReasons?:
|
|
2478
|
+
nonDraftableReasons?: NonDraftableReasonWithLiterals[];
|
|
2443
2479
|
}
|
|
2444
2480
|
export declare enum NonDraftableReason {
|
|
2445
2481
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -2464,6 +2500,8 @@ export declare enum NonDraftableReason {
|
|
|
2464
2500
|
/** Modifications of orders with subscription items are not supported. */
|
|
2465
2501
|
SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
|
|
2466
2502
|
}
|
|
2503
|
+
/** @enumType */
|
|
2504
|
+
export type NonDraftableReasonWithLiterals = NonDraftableReason | 'UNSPECIFIED' | 'PARTIALLY_OR_FULLY_REFUNDED' | 'UNSUPPORTED_CHANNEL_TYPE' | 'ORDER_STATUS_IS_NOT_SUPPORTED' | 'ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT' | 'ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT' | 'ORDER_NOT_FOUND' | 'SUBSCRIPTION_LINE_ITEM_EXISTS';
|
|
2467
2505
|
export interface CommitDraftOrderRequest {
|
|
2468
2506
|
/**
|
|
2469
2507
|
* Draft order ID.
|
|
@@ -2517,25 +2555,25 @@ export interface Order {
|
|
|
2517
2555
|
/** Buyer information. */
|
|
2518
2556
|
buyerInfo?: BuyerInfo;
|
|
2519
2557
|
/** Order payment status. */
|
|
2520
|
-
paymentStatus?:
|
|
2558
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
2521
2559
|
/**
|
|
2522
2560
|
* Order fulfillment status.
|
|
2523
2561
|
* @readonly
|
|
2524
2562
|
*/
|
|
2525
|
-
fulfillmentStatus?:
|
|
2563
|
+
fulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
2526
2564
|
/**
|
|
2527
2565
|
* Language for communication with the buyer. Defaults to the site language.
|
|
2528
2566
|
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
2529
2567
|
*/
|
|
2530
2568
|
buyerLanguage?: string | null;
|
|
2531
2569
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
2532
|
-
weightUnit?:
|
|
2570
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
2533
2571
|
/**
|
|
2534
2572
|
* 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.
|
|
2535
2573
|
* @format CURRENCY
|
|
2536
2574
|
*/
|
|
2537
2575
|
currency?: string | null;
|
|
2538
|
-
/**
|
|
2576
|
+
/** Currency conversion details. For use with multi-currency sites. */
|
|
2539
2577
|
currencyConversionDetails?: CurrencyConversionDetails;
|
|
2540
2578
|
/**
|
|
2541
2579
|
* Whether tax is included in line item prices.
|
|
@@ -2563,7 +2601,7 @@ export interface Order {
|
|
|
2563
2601
|
*/
|
|
2564
2602
|
buyerNote?: string | null;
|
|
2565
2603
|
/** Order status. */
|
|
2566
|
-
status?:
|
|
2604
|
+
status?: OrderStatusWithLiterals;
|
|
2567
2605
|
/** Whether order is archived. */
|
|
2568
2606
|
archived?: boolean | null;
|
|
2569
2607
|
/**
|
|
@@ -2591,7 +2629,7 @@ export interface Order {
|
|
|
2591
2629
|
*/
|
|
2592
2630
|
activities?: Activity[];
|
|
2593
2631
|
/** Order attribution source. */
|
|
2594
|
-
attributionSource?:
|
|
2632
|
+
attributionSource?: AttributionSourceWithLiterals;
|
|
2595
2633
|
/**
|
|
2596
2634
|
* ID of the order's initiator.
|
|
2597
2635
|
* @readonly
|
|
@@ -2698,6 +2736,8 @@ export declare enum PaymentStatus {
|
|
|
2698
2736
|
*/
|
|
2699
2737
|
DECLINED = "DECLINED"
|
|
2700
2738
|
}
|
|
2739
|
+
/** @enumType */
|
|
2740
|
+
export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
2701
2741
|
export declare enum FulfillmentStatus {
|
|
2702
2742
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2703
2743
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
@@ -2709,16 +2749,20 @@ export declare enum FulfillmentStatus {
|
|
|
2709
2749
|
/** Some, but not all, of the order items are fulfilled. */
|
|
2710
2750
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2711
2751
|
}
|
|
2752
|
+
/** @enumType */
|
|
2753
|
+
export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
2712
2754
|
export interface CurrencyConversionDetails {
|
|
2713
2755
|
/**
|
|
2714
|
-
*
|
|
2756
|
+
* 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.
|
|
2757
|
+
*
|
|
2758
|
+
* This currency is used to calculate the pricing before conversion to the buyer's payment currency.
|
|
2715
2759
|
* @readonly
|
|
2716
2760
|
* @immutable
|
|
2717
2761
|
* @format CURRENCY
|
|
2718
2762
|
*/
|
|
2719
2763
|
originalCurrency?: string | null;
|
|
2720
2764
|
/**
|
|
2721
|
-
* The rate used
|
|
2765
|
+
* The rate used for converting the original currency to the currency used for payment.
|
|
2722
2766
|
* @readonly
|
|
2723
2767
|
* @immutable
|
|
2724
2768
|
* @decimalValue options { gt:0, lte:1000000000000000 }
|
|
@@ -2750,6 +2794,8 @@ export declare enum OrderStatus {
|
|
|
2750
2794
|
*/
|
|
2751
2795
|
REJECTED = "REJECTED"
|
|
2752
2796
|
}
|
|
2797
|
+
/** @enumType */
|
|
2798
|
+
export type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
2753
2799
|
export interface Activity extends ActivityContentOneOf {
|
|
2754
2800
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2755
2801
|
customActivity?: CustomActivity;
|
|
@@ -2829,7 +2875,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2829
2875
|
*/
|
|
2830
2876
|
_createdDate?: Date | null;
|
|
2831
2877
|
/** Activity type. */
|
|
2832
|
-
type?:
|
|
2878
|
+
type?: ActivityTypeWithLiterals;
|
|
2833
2879
|
}
|
|
2834
2880
|
/** @oneof */
|
|
2835
2881
|
export interface ActivityContentOneOf {
|
|
@@ -3026,7 +3072,7 @@ export interface LineItemQuantityChange {
|
|
|
3026
3072
|
*/
|
|
3027
3073
|
diff?: number;
|
|
3028
3074
|
/** Type of quantity change: increase or decrease. */
|
|
3029
|
-
deltaType?:
|
|
3075
|
+
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
3030
3076
|
}
|
|
3031
3077
|
export declare enum LineItemQuantityChangeType {
|
|
3032
3078
|
/** Quantity increased. */
|
|
@@ -3034,6 +3080,8 @@ export declare enum LineItemQuantityChangeType {
|
|
|
3034
3080
|
/** Quantity decreased. */
|
|
3035
3081
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
3036
3082
|
}
|
|
3083
|
+
/** @enumType */
|
|
3084
|
+
export type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
3037
3085
|
export interface LineItemPriceChange {
|
|
3038
3086
|
/** Item price before update. */
|
|
3039
3087
|
originalPrice?: Price;
|
|
@@ -3464,10 +3512,14 @@ export declare enum ActivityType {
|
|
|
3464
3512
|
/** @documentationMaturity preview */
|
|
3465
3513
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3466
3514
|
}
|
|
3515
|
+
/** @enumType */
|
|
3516
|
+
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';
|
|
3467
3517
|
export declare enum AttributionSource {
|
|
3468
3518
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3469
3519
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3470
3520
|
}
|
|
3521
|
+
/** @enumType */
|
|
3522
|
+
export type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
3471
3523
|
export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3472
3524
|
/**
|
|
3473
3525
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
@@ -3517,7 +3569,7 @@ export interface V1CreatedByStringOneOf {
|
|
|
3517
3569
|
}
|
|
3518
3570
|
export interface ChannelInfo {
|
|
3519
3571
|
/** Sales channel that submitted the order. */
|
|
3520
|
-
type?:
|
|
3572
|
+
type?: ChannelTypeWithLiterals;
|
|
3521
3573
|
/**
|
|
3522
3574
|
* Reference to an order ID from an external system.
|
|
3523
3575
|
* @maxLength 100
|
|
@@ -3563,6 +3615,8 @@ export declare enum ChannelType {
|
|
|
3563
3615
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
3564
3616
|
FAIRE_COM = "FAIRE_COM"
|
|
3565
3617
|
}
|
|
3618
|
+
/** @enumType */
|
|
3619
|
+
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';
|
|
3566
3620
|
export interface CustomField {
|
|
3567
3621
|
/** Custom field value. */
|
|
3568
3622
|
value?: any;
|
|
@@ -3744,12 +3798,14 @@ export interface Sorting {
|
|
|
3744
3798
|
*/
|
|
3745
3799
|
fieldName?: string;
|
|
3746
3800
|
/** Sort order. */
|
|
3747
|
-
order?:
|
|
3801
|
+
order?: SortOrderWithLiterals;
|
|
3748
3802
|
}
|
|
3749
3803
|
export declare enum SortOrder {
|
|
3750
3804
|
ASC = "ASC",
|
|
3751
3805
|
DESC = "DESC"
|
|
3752
3806
|
}
|
|
3807
|
+
/** @enumType */
|
|
3808
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3753
3809
|
export interface CursorPaging {
|
|
3754
3810
|
/**
|
|
3755
3811
|
* Maximum number of items to return in the results.
|
|
@@ -3938,7 +3994,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3938
3994
|
*/
|
|
3939
3995
|
appId?: string;
|
|
3940
3996
|
/** @readonly */
|
|
3941
|
-
identityType?:
|
|
3997
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3942
3998
|
}
|
|
3943
3999
|
/** @oneof */
|
|
3944
4000
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3970,6 +4026,8 @@ export declare enum WebhookIdentityType {
|
|
|
3970
4026
|
WIX_USER = "WIX_USER",
|
|
3971
4027
|
APP = "APP"
|
|
3972
4028
|
}
|
|
4029
|
+
/** @enumType */
|
|
4030
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3973
4031
|
export interface BaseEventMetadata {
|
|
3974
4032
|
/**
|
|
3975
4033
|
* App instance ID.
|
|
@@ -4685,22 +4743,22 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4685
4743
|
* @param value - Value to compare against.
|
|
4686
4744
|
* @documentationMaturity preview
|
|
4687
4745
|
*/
|
|
4688
|
-
ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4746
|
+
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4689
4747
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4690
4748
|
* @param value - Value to compare against.
|
|
4691
4749
|
* @documentationMaturity preview
|
|
4692
4750
|
*/
|
|
4693
|
-
gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4751
|
+
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4694
4752
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4695
4753
|
* @param value - Value to compare against.
|
|
4696
4754
|
* @documentationMaturity preview
|
|
4697
4755
|
*/
|
|
4698
|
-
le: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4756
|
+
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4699
4757
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4700
4758
|
* @param value - Value to compare against.
|
|
4701
4759
|
* @documentationMaturity preview
|
|
4702
4760
|
*/
|
|
4703
|
-
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4761
|
+
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4704
4762
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
4705
4763
|
* @param string - String to compare against. Case-insensitive.
|
|
4706
4764
|
* @documentationMaturity preview
|