@wix/auto_sdk_stores_read-only-variants-v-3 1.0.5 → 1.0.6

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.
Files changed (45) hide show
  1. package/build/cjs/index.typings.d.ts +2 -0
  2. package/build/cjs/index.typings.js.map +1 -1
  3. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
  4. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +1 -1
  5. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
  6. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
  7. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +209 -75
  8. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
  9. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +384 -80
  10. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
  11. package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
  12. package/build/es/index.typings.d.ts +2 -0
  13. package/build/es/index.typings.js.map +1 -1
  14. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
  15. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +1 -1
  16. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
  17. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
  18. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +209 -75
  19. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
  20. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +384 -80
  21. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
  22. package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
  23. package/build/internal/cjs/index.typings.d.ts +6 -2
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
  26. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +4 -3
  27. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
  28. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
  29. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +209 -75
  30. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
  31. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +387 -82
  32. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
  33. package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
  34. package/build/internal/es/index.typings.d.ts +6 -2
  35. package/build/internal/es/index.typings.js.map +1 -1
  36. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
  37. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +4 -3
  38. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
  39. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
  40. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +209 -75
  41. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
  42. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +387 -82
  43. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
  44. package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
  45. 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 ReadOnlyVariant extends ReadOnlyVariantTypedPropertiesOneOf {
3
3
  /** Physical properties. Must be passed when `productType: PHYSICAL` */
4
4
  physicalProperties?: V3VariantPhysicalProperties;
@@ -217,7 +217,7 @@ export interface V3ProductMedia extends V3ProductMediaSetByOneOf, V3ProductMedia
217
217
  * Media type.
218
218
  * @readonly
219
219
  */
220
- mediaType?: ProductMediaMediaType;
220
+ mediaType?: ProductMediaMediaTypeWithLiterals;
221
221
  /**
222
222
  * Media thumbnail.
223
223
  * @readonly
@@ -282,6 +282,8 @@ export declare enum ProductMediaMediaType {
282
282
  /** Video media type. */
283
283
  VIDEO = "VIDEO"
284
284
  }
285
+ /** @enumType */
286
+ export type ProductMediaMediaTypeWithLiterals = ProductMediaMediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
285
287
  export interface V3Thumbnail {
286
288
  /**
287
289
  * Thumbnail url.
@@ -357,7 +359,7 @@ export interface V3PricePerUnitSettings {
357
359
  * For example, to define price per 100 grams, set this field to "G".
358
360
  * @readonly
359
361
  */
360
- measurementUnit?: MeasurementUnit;
362
+ measurementUnit?: MeasurementUnitWithLiterals;
361
363
  }
362
364
  export declare enum MeasurementUnit {
363
365
  UNSPECIFIED = "UNSPECIFIED",
@@ -383,6 +385,8 @@ export declare enum MeasurementUnit {
383
385
  YD = "YD",
384
386
  SQFT = "SQFT"
385
387
  }
388
+ /** @enumType */
389
+ export type MeasurementUnitWithLiterals = MeasurementUnit | 'UNSPECIFIED' | 'ML' | 'CL' | 'L' | 'CBM' | 'MG' | 'G' | 'KG' | 'MM' | 'CM' | 'M' | 'SQM' | 'OZ' | 'LB' | 'FLOZ' | 'PT' | 'QT' | 'GAL' | 'IN' | 'FT' | 'YD' | 'SQFT';
386
390
  export interface V3VariantDigitalProperties {
387
391
  /**
388
392
  * Digital file which will be downloaded by customer after successful purchase.
@@ -418,7 +422,7 @@ export interface V3SecuredMedia {
418
422
  * File type.
419
423
  * @readonly
420
424
  */
421
- fileType?: SecuredMediaFileType;
425
+ fileType?: SecuredMediaFileTypeWithLiterals;
422
426
  }
423
427
  export declare enum SecuredMediaFileType {
424
428
  /** Unspecified file type. */
@@ -434,6 +438,8 @@ export declare enum SecuredMediaFileType {
434
438
  /** Secure archive file. */
435
439
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
436
440
  }
441
+ /** @enumType */
442
+ export type SecuredMediaFileTypeWithLiterals = SecuredMediaFileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
437
443
  export interface V3SubscriptionPricesInfo {
438
444
  /**
439
445
  * Subscription prices.
@@ -511,7 +517,7 @@ export interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
511
517
  * product type
512
518
  * @readonly
513
519
  */
514
- productType?: V3ProductType;
520
+ productType?: V3ProductTypeWithLiterals;
515
521
  /**
516
522
  * Product slug.
517
523
  * @format URL_SLUG
@@ -571,6 +577,8 @@ export declare enum V3ProductType {
571
577
  /** Digital product. */
572
578
  DIGITAL = "DIGITAL"
573
579
  }
580
+ /** @enumType */
581
+ export type V3ProductTypeWithLiterals = V3ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
574
582
  export interface V3PhysicalProperties {
575
583
  /**
576
584
  * Weight measurement unit.
@@ -584,7 +592,7 @@ export interface V3WeightMeasurementUnitInfo {
584
592
  * Weight measurement unit.
585
593
  * @readonly
586
594
  */
587
- weightMeasurementUnit?: WeightUnit;
595
+ weightMeasurementUnit?: WeightUnitWithLiterals;
588
596
  }
589
597
  export declare enum WeightUnit {
590
598
  /** Weight unit can't be classified due to an error. */
@@ -594,6 +602,8 @@ export declare enum WeightUnit {
594
602
  /** Pounds. */
595
603
  LB = "LB"
596
604
  }
605
+ /** @enumType */
606
+ export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
597
607
  export interface InternalMetadata {
598
608
  }
599
609
  export declare enum InternalRowState {
@@ -608,6 +618,8 @@ export declare enum InternalRowState {
608
618
  /** Variant is permanently deleted. */
609
619
  PERMANENTLY_DELETED = "PERMANENTLY_DELETED"
610
620
  }
621
+ /** @enumType */
622
+ export type InternalRowStateWithLiterals = InternalRowState | 'UNKNOWN_ROW_STATE' | 'READY' | 'IN_PROCESS' | 'SOFT_DELETED' | 'PERMANENTLY_DELETED';
611
623
  export interface QueryVariantsRequest {
612
624
  /** WQL expression. */
613
625
  query?: CursorQuery;
@@ -615,7 +627,7 @@ export interface QueryVariantsRequest {
615
627
  * A list of requested fields to be included in the response.
616
628
  * @maxSize 100
617
629
  */
618
- fields?: RequestedFields[];
630
+ fields?: RequestedFieldsWithLiterals[];
619
631
  }
620
632
  export interface CursorQuery extends CursorQueryPagingMethodOneOf {
621
633
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
@@ -648,12 +660,14 @@ export interface Sorting {
648
660
  */
649
661
  fieldName?: string;
650
662
  /** Sort order. */
651
- order?: SortOrder;
663
+ order?: SortOrderWithLiterals;
652
664
  }
653
665
  export declare enum SortOrder {
654
666
  ASC = "ASC",
655
667
  DESC = "DESC"
656
668
  }
669
+ /** @enumType */
670
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
657
671
  export interface CursorPaging {
658
672
  /**
659
673
  * Maximum number of items to return in the results.
@@ -678,6 +692,8 @@ export declare enum RequestedFields {
678
692
  SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
679
693
  WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO"
680
694
  }
695
+ /** @enumType */
696
+ export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CURRENCY' | 'MERCHANT_DATA' | 'SUBSCRIPTION_PRICES_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO';
681
697
  export interface QueryVariantsResponse {
682
698
  /** List of ReadOnlyVariants. */
683
699
  variants?: ReadOnlyVariant[];
@@ -716,7 +732,7 @@ export interface SearchVariantsRequest {
716
732
  * A list of requested fields to be included in the response.
717
733
  * @maxSize 100
718
734
  */
719
- fields?: RequestedFields[];
735
+ fields?: RequestedFieldsWithLiterals[];
720
736
  }
721
737
  export interface CursorSearch extends CursorSearchPagingMethodOneOf {
722
738
  /**
@@ -775,7 +791,7 @@ export interface Aggregation extends AggregationKindOneOf {
775
791
  */
776
792
  name?: string | null;
777
793
  /** Type of aggregation, client must provide matching aggregation field below */
778
- type?: AggregationType;
794
+ type?: AggregationTypeWithLiterals;
779
795
  /**
780
796
  * Field to aggregate by, use dot notation to specify json path
781
797
  * @maxLength 200
@@ -807,18 +823,24 @@ export declare enum SortType {
807
823
  /** Should sort by value of the field alphabetically */
808
824
  VALUE = "VALUE"
809
825
  }
826
+ /** @enumType */
827
+ export type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
810
828
  export declare enum SortDirection {
811
829
  /** Should sort in descending order */
812
830
  DESC = "DESC",
813
831
  /** Should sort in ascending order */
814
832
  ASC = "ASC"
815
833
  }
834
+ /** @enumType */
835
+ export type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
816
836
  export declare enum MissingValues {
817
837
  /** Should missing values be excluded from the aggregation results */
818
838
  EXCLUDE = "EXCLUDE",
819
839
  /** Should missing values be included in the aggregation results */
820
840
  INCLUDE = "INCLUDE"
821
841
  }
842
+ /** @enumType */
843
+ export type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
822
844
  export interface IncludeMissingValuesOptions {
823
845
  /**
824
846
  * Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
@@ -835,17 +857,19 @@ export declare enum ScalarType {
835
857
  /** Maximum value */
836
858
  MAX = "MAX"
837
859
  }
860
+ /** @enumType */
861
+ export type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
838
862
  export interface ValueAggregation extends ValueAggregationOptionsOneOf {
839
863
  /** Options for including missing values */
840
864
  includeOptions?: IncludeMissingValuesOptions;
841
865
  /** Should sort by number of matches or value of the field */
842
- sortType?: SortType;
866
+ sortType?: SortTypeWithLiterals;
843
867
  /** Should sort in ascending or descending order */
844
- sortDirection?: SortDirection;
868
+ sortDirection?: SortDirectionWithLiterals;
845
869
  /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
846
870
  limit?: number | null;
847
871
  /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
848
- missingValues?: MissingValues;
872
+ missingValues?: MissingValuesWithLiterals;
849
873
  }
850
874
  /** @oneof */
851
875
  export interface ValueAggregationOptionsOneOf {
@@ -863,6 +887,8 @@ export declare enum NestedAggregationType {
863
887
  /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
864
888
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
865
889
  }
890
+ /** @enumType */
891
+ export type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
866
892
  export interface RangeAggregation {
867
893
  /**
868
894
  * List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
@@ -872,11 +898,11 @@ export interface RangeAggregation {
872
898
  }
873
899
  export interface ScalarAggregation {
874
900
  /** Define the operator for the scalar aggregation */
875
- type?: ScalarType;
901
+ type?: ScalarTypeWithLiterals;
876
902
  }
877
903
  export interface DateHistogramAggregation {
878
904
  /** Interval for date histogram aggregation */
879
- interval?: Interval;
905
+ interval?: IntervalWithLiterals;
880
906
  }
881
907
  export declare enum Interval {
882
908
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
@@ -895,6 +921,8 @@ export declare enum Interval {
895
921
  /** Second interval */
896
922
  SECOND = "SECOND"
897
923
  }
924
+ /** @enumType */
925
+ export type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
898
926
  export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
899
927
  /** Value aggregation */
900
928
  value?: ValueAggregation;
@@ -910,7 +938,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
910
938
  */
911
939
  name?: string | null;
912
940
  /** Type of aggregation, client must provide matching aggregation field below */
913
- type?: NestedAggregationType;
941
+ type?: NestedAggregationTypeWithLiterals;
914
942
  /**
915
943
  * Field to aggregate by, use dont notation to specify json path
916
944
  * @maxLength 200
@@ -941,6 +969,8 @@ export declare enum AggregationType {
941
969
  /** Multi-level aggregation, where each next aggregation is nested within previous one */
942
970
  NESTED = "NESTED"
943
971
  }
972
+ /** @enumType */
973
+ export type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
944
974
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
945
975
  export interface NestedAggregation {
946
976
  /**
@@ -952,7 +982,7 @@ export interface NestedAggregation {
952
982
  }
953
983
  export interface SearchDetails {
954
984
  /** Defines how separate search terms in `expression` are combined */
955
- mode?: Mode;
985
+ mode?: ModeWithLiterals;
956
986
  /**
957
987
  * Search term or expression
958
988
  * @maxLength 100
@@ -973,6 +1003,8 @@ export declare enum Mode {
973
1003
  /** All search terms must be present */
974
1004
  AND = "AND"
975
1005
  }
1006
+ /** @enumType */
1007
+ export type ModeWithLiterals = Mode | 'OR' | 'AND';
976
1008
  export interface SearchVariantsResponse {
977
1009
  /** Variants which satisfy the provided query. */
978
1010
  variants?: ReadOnlyVariant[];
@@ -1018,7 +1050,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
1018
1050
  */
1019
1051
  name?: string;
1020
1052
  /** Type of aggregation that matches result */
1021
- type?: AggregationType;
1053
+ type?: AggregationTypeWithLiterals;
1022
1054
  /**
1023
1055
  * Field to aggregate by, matches the one provided in request
1024
1056
  * @maxLength 200
@@ -1050,7 +1082,7 @@ export interface RangeResults {
1050
1082
  }
1051
1083
  export interface AggregationResultsScalarResult {
1052
1084
  /** Type of scalar aggregation */
1053
- type?: ScalarType;
1085
+ type?: ScalarTypeWithLiterals;
1054
1086
  /** Value of the scalar aggregation */
1055
1087
  value?: number;
1056
1088
  }
@@ -1162,7 +1194,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
1162
1194
  */
1163
1195
  name?: string;
1164
1196
  /** Type of aggregation that must match provided kind as derived from search request */
1165
- type?: AggregationType;
1197
+ type?: AggregationTypeWithLiterals;
1166
1198
  /**
1167
1199
  * Field to aggregate by as derived from search request
1168
1200
  * @maxLength 200
@@ -1191,7 +1223,7 @@ export interface DeprecatedSearchVariantsWithOffsetRequest {
1191
1223
  * A list of requested fields to be included in the response.
1192
1224
  * @maxSize 100
1193
1225
  */
1194
- fields?: RequestedFields[];
1226
+ fields?: RequestedFieldsWithLiterals[];
1195
1227
  }
1196
1228
  export interface PlatformOffsetSearch extends PlatformOffsetSearchPagingMethodOneOf {
1197
1229
  /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
@@ -1217,12 +1249,14 @@ export interface CommonSorting {
1217
1249
  */
1218
1250
  fieldName?: string;
1219
1251
  /** Sort order. */
1220
- order?: CommonSortOrder;
1252
+ order?: CommonSortOrderWithLiterals;
1221
1253
  }
1222
1254
  export declare enum CommonSortOrder {
1223
1255
  ASC = "ASC",
1224
1256
  DESC = "DESC"
1225
1257
  }
1258
+ /** @enumType */
1259
+ export type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
1226
1260
  export interface CommonAggregation extends CommonAggregationKindOneOf {
1227
1261
  /** Value aggregation. */
1228
1262
  value?: AggregationValueAggregation;
@@ -1240,7 +1274,7 @@ export interface CommonAggregation extends CommonAggregationKindOneOf {
1240
1274
  */
1241
1275
  name?: string | null;
1242
1276
  /** Type of aggregation, client must provide matching aggregation field below. */
1243
- type?: CommonAggregationType;
1277
+ type?: CommonAggregationTypeWithLiterals;
1244
1278
  /**
1245
1279
  * Field to aggregate by, use dot notation to specify json path.
1246
1280
  * @maxLength 200
@@ -1279,18 +1313,24 @@ export declare enum ValueAggregationSortType {
1279
1313
  /** Sort by value of the field alphabetically. */
1280
1314
  VALUE = "VALUE"
1281
1315
  }
1316
+ /** @enumType */
1317
+ export type ValueAggregationSortTypeWithLiterals = ValueAggregationSortType | 'COUNT' | 'VALUE';
1282
1318
  export declare enum ValueAggregationSortDirection {
1283
1319
  /** Sort in descending order. */
1284
1320
  DESC = "DESC",
1285
1321
  /** Sort in ascending order. */
1286
1322
  ASC = "ASC"
1287
1323
  }
1324
+ /** @enumType */
1325
+ export type ValueAggregationSortDirectionWithLiterals = ValueAggregationSortDirection | 'DESC' | 'ASC';
1288
1326
  export declare enum ValueAggregationMissingValues {
1289
1327
  /** Exclude missing values from the aggregation results. */
1290
1328
  EXCLUDE = "EXCLUDE",
1291
1329
  /** Include missing values in the aggregation results. */
1292
1330
  INCLUDE = "INCLUDE"
1293
1331
  }
1332
+ /** @enumType */
1333
+ export type ValueAggregationMissingValuesWithLiterals = ValueAggregationMissingValues | 'EXCLUDE' | 'INCLUDE';
1294
1334
  export interface ValueAggregationIncludeMissingValuesOptions {
1295
1335
  /**
1296
1336
  * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
@@ -1307,17 +1347,19 @@ export declare enum CommonScalarType {
1307
1347
  /** Maximum value. */
1308
1348
  MAX = "MAX"
1309
1349
  }
1350
+ /** @enumType */
1351
+ export type CommonScalarTypeWithLiterals = CommonScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1310
1352
  export interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
1311
1353
  /** Options for including missing values. */
1312
1354
  includeOptions?: ValueAggregationIncludeMissingValuesOptions;
1313
1355
  /** Whether to sort by number of matches or value of the field. */
1314
- sortType?: ValueAggregationSortType;
1356
+ sortType?: ValueAggregationSortTypeWithLiterals;
1315
1357
  /** Whether to sort in ascending or descending order. */
1316
- sortDirection?: ValueAggregationSortDirection;
1358
+ sortDirection?: ValueAggregationSortDirectionWithLiterals;
1317
1359
  /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
1318
1360
  limit?: number | null;
1319
1361
  /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
1320
- missingValues?: ValueAggregationMissingValues;
1362
+ missingValues?: ValueAggregationMissingValuesWithLiterals;
1321
1363
  }
1322
1364
  /** @oneof */
1323
1365
  export interface AggregationValueAggregationOptionsOneOf {
@@ -1335,6 +1377,8 @@ export declare enum NestedAggregationNestedAggregationType {
1335
1377
  /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
1336
1378
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1337
1379
  }
1380
+ /** @enumType */
1381
+ export type NestedAggregationNestedAggregationTypeWithLiterals = NestedAggregationNestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1338
1382
  export interface AggregationRangeAggregation {
1339
1383
  /**
1340
1384
  * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
@@ -1344,11 +1388,11 @@ export interface AggregationRangeAggregation {
1344
1388
  }
1345
1389
  export interface AggregationScalarAggregation {
1346
1390
  /** Define the operator for the scalar aggregation. */
1347
- type?: CommonScalarType;
1391
+ type?: CommonScalarTypeWithLiterals;
1348
1392
  }
1349
1393
  export interface AggregationDateHistogramAggregation {
1350
1394
  /** Interval for date histogram aggregation. */
1351
- interval?: DateHistogramAggregationInterval;
1395
+ interval?: DateHistogramAggregationIntervalWithLiterals;
1352
1396
  }
1353
1397
  export declare enum DateHistogramAggregationInterval {
1354
1398
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
@@ -1367,6 +1411,8 @@ export declare enum DateHistogramAggregationInterval {
1367
1411
  /** Second interval */
1368
1412
  SECOND = "SECOND"
1369
1413
  }
1414
+ /** @enumType */
1415
+ export type DateHistogramAggregationIntervalWithLiterals = DateHistogramAggregationInterval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1370
1416
  export interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
1371
1417
  /** Value aggregation. */
1372
1418
  value?: AggregationValueAggregation;
@@ -1382,7 +1428,7 @@ export interface NestedAggregationNestedAggregationItem extends NestedAggregatio
1382
1428
  */
1383
1429
  name?: string | null;
1384
1430
  /** Type of aggregation, client must provide matching aggregation field below. */
1385
- type?: NestedAggregationNestedAggregationType;
1431
+ type?: NestedAggregationNestedAggregationTypeWithLiterals;
1386
1432
  /**
1387
1433
  * Field to aggregate by, use dot notation to specify json path.
1388
1434
  * @maxLength 200
@@ -1413,6 +1459,8 @@ export declare enum CommonAggregationType {
1413
1459
  /** Multi-level aggregation, where each next aggregation is nested within previous one. */
1414
1460
  NESTED = "NESTED"
1415
1461
  }
1462
+ /** @enumType */
1463
+ export type CommonAggregationTypeWithLiterals = CommonAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1416
1464
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
1417
1465
  export interface AggregationNestedAggregation {
1418
1466
  /**
@@ -1443,7 +1491,7 @@ export interface GroupByAggregationKindOneOf {
1443
1491
  }
1444
1492
  export interface CommonSearchDetails {
1445
1493
  /** Defines how separate search terms in `expression` are combined. */
1446
- mode?: SearchDetailsMode;
1494
+ mode?: SearchDetailsModeWithLiterals;
1447
1495
  /**
1448
1496
  * Search term or expression.
1449
1497
  * @maxLength 100
@@ -1464,6 +1512,8 @@ export declare enum SearchDetailsMode {
1464
1512
  /** All search terms must be present. */
1465
1513
  AND = "AND"
1466
1514
  }
1515
+ /** @enumType */
1516
+ export type SearchDetailsModeWithLiterals = SearchDetailsMode | 'OR' | 'AND';
1467
1517
  export interface PlatformPaging {
1468
1518
  /**
1469
1519
  * Number of items to load.
@@ -1667,7 +1717,7 @@ export interface Product extends ProductTypedPropertiesOneOf {
1667
1717
  * When passing `productType: PHYSICAL`, you must also pass `physicalProperties`.
1668
1718
  * @immutable
1669
1719
  */
1670
- productType?: ProductType;
1720
+ productType?: ProductTypeWithLiterals;
1671
1721
  /**
1672
1722
  * A unique human-friendly identifier for the product.
1673
1723
  * Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.
@@ -1800,7 +1850,7 @@ export interface Node extends NodeDataOneOf {
1800
1850
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
1801
1851
  layoutCellData?: LayoutCellData;
1802
1852
  /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
1803
- type?: NodeType;
1853
+ type?: NodeTypeWithLiterals;
1804
1854
  /** Node ID. */
1805
1855
  id?: string;
1806
1856
  /** A list of child nodes. */
@@ -1901,6 +1951,8 @@ export declare enum NodeType {
1901
1951
  LAYOUT = "LAYOUT",
1902
1952
  LAYOUT_CELL = "LAYOUT_CELL"
1903
1953
  }
1954
+ /** @enumType */
1955
+ export type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
1904
1956
  export interface NodeStyle {
1905
1957
  /** The top padding value in pixels. */
1906
1958
  paddingTop?: string | null;
@@ -1913,7 +1965,7 @@ export interface ButtonData {
1913
1965
  /** Styling for the button's container. */
1914
1966
  containerData?: PluginContainerData;
1915
1967
  /** The button type. */
1916
- type?: Type;
1968
+ type?: TypeWithLiterals;
1917
1969
  /** Styling for the button. */
1918
1970
  styles?: Styles;
1919
1971
  /** The text to display on the button. */
@@ -1954,7 +2006,7 @@ export interface PluginContainerData {
1954
2006
  /** The width of the node when it's displayed. */
1955
2007
  width?: PluginContainerDataWidth;
1956
2008
  /** The node's alignment within its container. */
1957
- alignment?: PluginContainerDataAlignment;
2009
+ alignment?: PluginContainerDataAlignmentWithLiterals;
1958
2010
  /** Spoiler cover settings for the node. */
1959
2011
  spoiler?: Spoiler;
1960
2012
  /** The height of the node when it's displayed. */
@@ -1972,6 +2024,8 @@ export declare enum WidthType {
1972
2024
  /** coast-to-coast display */
1973
2025
  FULL_WIDTH = "FULL_WIDTH"
1974
2026
  }
2027
+ /** @enumType */
2028
+ export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
1975
2029
  export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1976
2030
  /**
1977
2031
  * One of the following predefined width options:
@@ -1980,7 +2034,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
1980
2034
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1981
2035
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1982
2036
  */
1983
- size?: WidthType;
2037
+ size?: WidthTypeWithLiterals;
1984
2038
  /** A custom width value in pixels. */
1985
2039
  custom?: string | null;
1986
2040
  }
@@ -1993,7 +2047,7 @@ export interface PluginContainerDataWidthDataOneOf {
1993
2047
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1994
2048
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1995
2049
  */
1996
- size?: WidthType;
2050
+ size?: WidthTypeWithLiterals;
1997
2051
  /** A custom width value in pixels. */
1998
2052
  custom?: string | null;
1999
2053
  }
@@ -2005,6 +2059,8 @@ export declare enum PluginContainerDataAlignment {
2005
2059
  /** Right Alignment */
2006
2060
  RIGHT = "RIGHT"
2007
2061
  }
2062
+ /** @enumType */
2063
+ export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
2008
2064
  export interface Spoiler {
2009
2065
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
2010
2066
  enabled?: boolean | null;
@@ -2023,6 +2079,8 @@ export declare enum Type {
2023
2079
  /** Triggers custom action that is defined in plugin configuration by the consumer */
2024
2080
  ACTION = "ACTION"
2025
2081
  }
2082
+ /** @enumType */
2083
+ export type TypeWithLiterals = Type | 'LINK' | 'ACTION';
2026
2084
  export interface Styles {
2027
2085
  /**
2028
2086
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -2088,7 +2146,7 @@ export interface Link extends LinkDataOneOf {
2088
2146
  * `PARENT` - Opens the linked document in the link's parent frame.
2089
2147
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
2090
2148
  */
2091
- target?: Target;
2149
+ target?: TargetWithLiterals;
2092
2150
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
2093
2151
  rel?: Rel;
2094
2152
  /** A serialized object used for a custom or external link panel. */
@@ -2111,6 +2169,8 @@ export declare enum Target {
2111
2169
  /** Opens the linked document in the full body of the window */
2112
2170
  TOP = "TOP"
2113
2171
  }
2172
+ /** @enumType */
2173
+ export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
2114
2174
  export interface Rel {
2115
2175
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
2116
2176
  nofollow?: boolean | null;
@@ -2127,7 +2187,7 @@ export interface CodeBlockData {
2127
2187
  }
2128
2188
  export interface TextStyle {
2129
2189
  /** Text alignment. Defaults to `AUTO`. */
2130
- textAlignment?: TextAlignment;
2190
+ textAlignment?: TextAlignmentWithLiterals;
2131
2191
  /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
2132
2192
  lineHeight?: string | null;
2133
2193
  }
@@ -2143,15 +2203,17 @@ export declare enum TextAlignment {
2143
2203
  /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
2144
2204
  JUSTIFY = "JUSTIFY"
2145
2205
  }
2206
+ /** @enumType */
2207
+ export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
2146
2208
  export interface DividerData {
2147
2209
  /** Styling for the divider's container. */
2148
2210
  containerData?: PluginContainerData;
2149
2211
  /** Divider line style. */
2150
- lineStyle?: LineStyle;
2212
+ lineStyle?: LineStyleWithLiterals;
2151
2213
  /** Divider width. */
2152
- width?: Width;
2214
+ width?: WidthWithLiterals;
2153
2215
  /** Divider alignment. */
2154
- alignment?: Alignment;
2216
+ alignment?: AlignmentWithLiterals;
2155
2217
  }
2156
2218
  export declare enum LineStyle {
2157
2219
  /** Single Line */
@@ -2163,6 +2225,8 @@ export declare enum LineStyle {
2163
2225
  /** Dotted Line */
2164
2226
  DOTTED = "DOTTED"
2165
2227
  }
2228
+ /** @enumType */
2229
+ export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
2166
2230
  export declare enum Width {
2167
2231
  /** Large line */
2168
2232
  LARGE = "LARGE",
@@ -2171,6 +2235,8 @@ export declare enum Width {
2171
2235
  /** Small line */
2172
2236
  SMALL = "SMALL"
2173
2237
  }
2238
+ /** @enumType */
2239
+ export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
2174
2240
  export declare enum Alignment {
2175
2241
  /** Center alignment */
2176
2242
  CENTER = "CENTER",
@@ -2179,6 +2245,8 @@ export declare enum Alignment {
2179
2245
  /** Right alignment */
2180
2246
  RIGHT = "RIGHT"
2181
2247
  }
2248
+ /** @enumType */
2249
+ export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
2182
2250
  export interface FileData {
2183
2251
  /** Styling for the file's container. */
2184
2252
  containerData?: PluginContainerData;
@@ -2210,6 +2278,8 @@ export declare enum ViewMode {
2210
2278
  /** Mini PDF view */
2211
2279
  MINI = "MINI"
2212
2280
  }
2281
+ /** @enumType */
2282
+ export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
2213
2283
  export interface FileSource extends FileSourceDataOneOf {
2214
2284
  /** The absolute URL for the file's source. */
2215
2285
  url?: string | null;
@@ -2242,7 +2312,7 @@ export interface PDFSettings {
2242
2312
  * `FULL` : A full page view of the PDF is displayed.
2243
2313
  * `MINI` : A mini view of the PDF is displayed.
2244
2314
  */
2245
- viewMode?: ViewMode;
2315
+ viewMode?: ViewModeWithLiterals;
2246
2316
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
2247
2317
  disableDownload?: boolean | null;
2248
2318
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
@@ -2329,18 +2399,24 @@ export declare enum LayoutType {
2329
2399
  /** Fullsize images type */
2330
2400
  FULLSIZE = "FULLSIZE"
2331
2401
  }
2402
+ /** @enumType */
2403
+ export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
2332
2404
  export declare enum Orientation {
2333
2405
  /** Rows Orientation */
2334
2406
  ROWS = "ROWS",
2335
2407
  /** Columns Orientation */
2336
2408
  COLUMNS = "COLUMNS"
2337
2409
  }
2410
+ /** @enumType */
2411
+ export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
2338
2412
  export declare enum Crop {
2339
2413
  /** Crop to fill */
2340
2414
  FILL = "FILL",
2341
2415
  /** Crop to fit */
2342
2416
  FIT = "FIT"
2343
2417
  }
2418
+ /** @enumType */
2419
+ export type CropWithLiterals = Crop | 'FILL' | 'FIT';
2344
2420
  export declare enum ThumbnailsAlignment {
2345
2421
  /** Top alignment */
2346
2422
  TOP = "TOP",
@@ -2353,13 +2429,15 @@ export declare enum ThumbnailsAlignment {
2353
2429
  /** No thumbnail */
2354
2430
  NONE = "NONE"
2355
2431
  }
2432
+ /** @enumType */
2433
+ export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
2356
2434
  export interface Layout {
2357
2435
  /** Gallery layout type. */
2358
- type?: LayoutType;
2436
+ type?: LayoutTypeWithLiterals;
2359
2437
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
2360
2438
  horizontalScroll?: boolean | null;
2361
2439
  /** Gallery orientation. */
2362
- orientation?: Orientation;
2440
+ orientation?: OrientationWithLiterals;
2363
2441
  /** The number of columns to display on full size screens. */
2364
2442
  numberOfColumns?: number | null;
2365
2443
  /** The number of columns to display on mobile screens. */
@@ -2371,13 +2449,13 @@ export interface ItemStyle {
2371
2449
  /** Item ratio */
2372
2450
  ratio?: number | null;
2373
2451
  /** Sets how item images are cropped. */
2374
- crop?: Crop;
2452
+ crop?: CropWithLiterals;
2375
2453
  /** The spacing between items in pixels. */
2376
2454
  spacing?: number | null;
2377
2455
  }
2378
2456
  export interface Thumbnails {
2379
2457
  /** Thumbnail alignment. */
2380
- placement?: ThumbnailsAlignment;
2458
+ placement?: ThumbnailsAlignmentWithLiterals;
2381
2459
  /** Spacing between thumbnails in pixels. */
2382
2460
  spacing?: number | null;
2383
2461
  }
@@ -2393,7 +2471,7 @@ export interface GIFData {
2393
2471
  /** Width in pixels. */
2394
2472
  width?: number;
2395
2473
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
2396
- gifType?: GIFType;
2474
+ gifType?: GIFTypeWithLiterals;
2397
2475
  }
2398
2476
  export interface GIF {
2399
2477
  /**
@@ -2416,6 +2494,8 @@ export declare enum GIFType {
2416
2494
  NORMAL = "NORMAL",
2417
2495
  STICKER = "STICKER"
2418
2496
  }
2497
+ /** @enumType */
2498
+ export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
2419
2499
  export interface HeadingData {
2420
2500
  /** Heading level from 1-6. */
2421
2501
  level?: number;
@@ -2437,7 +2517,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
2437
2517
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
2438
2518
  containerData?: PluginContainerData;
2439
2519
  /** The type of HTML code. */
2440
- source?: Source;
2520
+ source?: SourceWithLiterals;
2441
2521
  /** If container height is aligned with its content height. Defaults to `true`. */
2442
2522
  autoHeight?: boolean | null;
2443
2523
  }
@@ -2457,6 +2537,8 @@ export declare enum Source {
2457
2537
  HTML = "HTML",
2458
2538
  ADSENSE = "ADSENSE"
2459
2539
  }
2540
+ /** @enumType */
2541
+ export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
2460
2542
  export interface ImageData {
2461
2543
  /** Styling for the image's container. */
2462
2544
  containerData?: PluginContainerData;
@@ -2521,6 +2603,8 @@ export declare enum Position {
2521
2603
  /** Thumbnail hidden and not displayed */
2522
2604
  HIDDEN = "HIDDEN"
2523
2605
  }
2606
+ /** @enumType */
2607
+ export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
2524
2608
  export interface LinkPreviewDataStyles {
2525
2609
  /**
2526
2610
  * Background color as a hexadecimal value.
@@ -2552,7 +2636,7 @@ export interface LinkPreviewDataStyles {
2552
2636
  */
2553
2637
  borderColor?: string | null;
2554
2638
  /** Position of thumbnail. Defaults to `START`. */
2555
- thumbnailPosition?: Position;
2639
+ thumbnailPosition?: PositionWithLiterals;
2556
2640
  }
2557
2641
  export interface MapData {
2558
2642
  /** Styling for the map's container. */
@@ -2582,7 +2666,7 @@ export interface MapSettings {
2582
2666
  /** Initial zoom value. */
2583
2667
  initialZoom?: number | null;
2584
2668
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2585
- mapType?: MapType;
2669
+ mapType?: MapTypeWithLiterals;
2586
2670
  }
2587
2671
  export declare enum MapType {
2588
2672
  /** Roadmap map type */
@@ -2594,6 +2678,8 @@ export declare enum MapType {
2594
2678
  /** Terrain map type */
2595
2679
  TERRAIN = "TERRAIN"
2596
2680
  }
2681
+ /** @enumType */
2682
+ export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
2597
2683
  export interface ParagraphData {
2598
2684
  /** Styling for the paragraph text. */
2599
2685
  textStyle?: TextStyle;
@@ -2620,17 +2706,21 @@ export declare enum ViewRole {
2620
2706
  /** Anyone can see the results, even if one didn't vote */
2621
2707
  EVERYONE = "EVERYONE"
2622
2708
  }
2709
+ /** @enumType */
2710
+ export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
2623
2711
  export declare enum VoteRole {
2624
2712
  /** Logged in member */
2625
2713
  SITE_MEMBERS = "SITE_MEMBERS",
2626
2714
  /** Anyone */
2627
2715
  ALL = "ALL"
2628
2716
  }
2717
+ /** @enumType */
2718
+ export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
2629
2719
  export interface Permissions {
2630
2720
  /** Sets who can view the poll results. */
2631
- view?: ViewRole;
2721
+ view?: ViewRoleWithLiterals;
2632
2722
  /** Sets who can vote. */
2633
- vote?: VoteRole;
2723
+ vote?: VoteRoleWithLiterals;
2634
2724
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2635
2725
  allowMultipleVotes?: boolean | null;
2636
2726
  }
@@ -2656,17 +2746,21 @@ export declare enum PollLayoutType {
2656
2746
  /** Grid */
2657
2747
  GRID = "GRID"
2658
2748
  }
2749
+ /** @enumType */
2750
+ export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
2659
2751
  export declare enum PollLayoutDirection {
2660
2752
  /** Left-to-right */
2661
2753
  LTR = "LTR",
2662
2754
  /** Right-to-left */
2663
2755
  RTL = "RTL"
2664
2756
  }
2757
+ /** @enumType */
2758
+ export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
2665
2759
  export interface PollLayout {
2666
2760
  /** The layout for displaying the voting options. */
2667
- type?: PollLayoutType;
2761
+ type?: PollLayoutTypeWithLiterals;
2668
2762
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
2669
- direction?: PollLayoutDirection;
2763
+ direction?: PollLayoutDirectionWithLiterals;
2670
2764
  /** Sets whether to display the main poll image. Defaults to `false`. */
2671
2765
  enableImage?: boolean | null;
2672
2766
  }
@@ -2682,6 +2776,8 @@ export declare enum BackgroundType {
2682
2776
  /** Gradiant background type */
2683
2777
  GRADIENT = "GRADIENT"
2684
2778
  }
2779
+ /** @enumType */
2780
+ export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
2685
2781
  export interface Gradient {
2686
2782
  /** The gradient angle in degrees. */
2687
2783
  angle?: number | null;
@@ -2707,7 +2803,7 @@ export interface Background extends BackgroundBackgroundOneOf {
2707
2803
  /** Details for a gradient background. */
2708
2804
  gradient?: Gradient;
2709
2805
  /** Background type. For each option, include the relevant details. */
2710
- type?: BackgroundType;
2806
+ type?: BackgroundTypeWithLiterals;
2711
2807
  }
2712
2808
  /** @oneof */
2713
2809
  export interface BackgroundBackgroundOneOf {
@@ -2786,7 +2882,7 @@ export interface Decoration extends DecorationDataOneOf {
2786
2882
  /** Data for a strikethrough decoration. Defaults to `true`. */
2787
2883
  strikethroughData?: boolean | null;
2788
2884
  /** The type of decoration to apply. */
2789
- type?: DecorationType;
2885
+ type?: DecorationTypeWithLiterals;
2790
2886
  }
2791
2887
  /** @oneof */
2792
2888
  export interface DecorationDataOneOf {
@@ -2824,6 +2920,8 @@ export declare enum DecorationType {
2824
2920
  EXTERNAL = "EXTERNAL",
2825
2921
  STRIKETHROUGH = "STRIKETHROUGH"
2826
2922
  }
2923
+ /** @enumType */
2924
+ export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
2827
2925
  export interface AnchorData {
2828
2926
  /** The target node's ID. */
2829
2927
  anchor?: string;
@@ -2848,7 +2946,7 @@ export interface MentionData {
2848
2946
  }
2849
2947
  export interface FontSizeData {
2850
2948
  /** The units used for the font size. */
2851
- unit?: FontType;
2949
+ unit?: FontTypeWithLiterals;
2852
2950
  /** Font size value. */
2853
2951
  value?: number | null;
2854
2952
  }
@@ -2856,6 +2954,8 @@ export declare enum FontType {
2856
2954
  PX = "PX",
2857
2955
  EM = "EM"
2858
2956
  }
2957
+ /** @enumType */
2958
+ export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
2859
2959
  export interface SpoilerData {
2860
2960
  /** Spoiler ID. */
2861
2961
  id?: string | null;
@@ -2866,7 +2966,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2866
2966
  /** Data for embedded Wix Events content. */
2867
2967
  eventData?: EventData;
2868
2968
  /** The type of Wix App content being embedded. */
2869
- type?: AppType;
2969
+ type?: AppTypeWithLiterals;
2870
2970
  /** The ID of the embedded content. */
2871
2971
  itemId?: string | null;
2872
2972
  /** The name of the embedded content. */
@@ -2893,6 +2993,8 @@ export declare enum AppType {
2893
2993
  EVENT = "EVENT",
2894
2994
  BOOKING = "BOOKING"
2895
2995
  }
2996
+ /** @enumType */
2997
+ export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
2896
2998
  export interface BookingData {
2897
2999
  /** Booking duration in minutes. */
2898
3000
  durations?: string | null;
@@ -2971,9 +3073,9 @@ export interface CollapsibleListData {
2971
3073
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
2972
3074
  expandOnlyOne?: boolean | null;
2973
3075
  /** Sets which items are expanded when the page loads. */
2974
- initialExpandedItems?: InitialExpandedItems;
3076
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
2975
3077
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
2976
- direction?: Direction;
3078
+ direction?: DirectionWithLiterals;
2977
3079
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
2978
3080
  isQapageData?: boolean | null;
2979
3081
  }
@@ -2985,12 +3087,16 @@ export declare enum InitialExpandedItems {
2985
3087
  /** All items collapsed initally */
2986
3088
  NONE = "NONE"
2987
3089
  }
3090
+ /** @enumType */
3091
+ export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
2988
3092
  export declare enum Direction {
2989
3093
  /** Left-to-right */
2990
3094
  LTR = "LTR",
2991
3095
  /** Right-to-left */
2992
3096
  RTL = "RTL"
2993
3097
  }
3098
+ /** @enumType */
3099
+ export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
2994
3100
  export interface TableData {
2995
3101
  /** Styling for the table's container. */
2996
3102
  containerData?: PluginContainerData;
@@ -3028,9 +3134,11 @@ export declare enum VerticalAlignment {
3028
3134
  /** Bottom alignment */
3029
3135
  BOTTOM = "BOTTOM"
3030
3136
  }
3137
+ /** @enumType */
3138
+ export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
3031
3139
  export interface CellStyle {
3032
3140
  /** Vertical alignment for the cell's text. */
3033
- verticalAlignment?: VerticalAlignment;
3141
+ verticalAlignment?: VerticalAlignmentWithLiterals;
3034
3142
  /**
3035
3143
  * Cell background color as a hexadecimal value.
3036
3144
  * @format COLOR_HEX
@@ -3069,6 +3177,8 @@ export declare enum NullValue {
3069
3177
  /** Null value. */
3070
3178
  NULL_VALUE = "NULL_VALUE"
3071
3179
  }
3180
+ /** @enumType */
3181
+ export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
3072
3182
  /**
3073
3183
  * `ListValue` is a wrapper around a repeated field of values.
3074
3184
  *
@@ -3214,7 +3324,7 @@ export interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaO
3214
3324
  * Media type.
3215
3325
  * @readonly
3216
3326
  */
3217
- mediaType?: MediaType;
3327
+ mediaType?: MediaTypeWithLiterals;
3218
3328
  /**
3219
3329
  * Media thumbnail.
3220
3330
  * > **Note:** Returned only when you pass `"THUMBNAIL"` to the `fields` array in Products API requests.
@@ -3277,6 +3387,8 @@ export declare enum MediaType {
3277
3387
  /** Video media type. */
3278
3388
  VIDEO = "VIDEO"
3279
3389
  }
3390
+ /** @enumType */
3391
+ export type MediaTypeWithLiterals = MediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
3280
3392
  export interface Thumbnail {
3281
3393
  /**
3282
3394
  * Thumbnail url.
@@ -3375,7 +3487,7 @@ export interface ConnectedOption extends ConnectedOptionOptionSettingsOneOf {
3375
3487
  */
3376
3488
  name?: string | null;
3377
3489
  /** Option render type. */
3378
- optionRenderType?: ProductOptionRenderType;
3490
+ optionRenderType?: ProductOptionRenderTypeWithLiterals;
3379
3491
  }
3380
3492
  /** @oneof */
3381
3493
  export interface ConnectedOptionOptionSettingsOneOf {
@@ -3390,6 +3502,8 @@ export declare enum ProductOptionRenderType {
3390
3502
  /** Swatch choices. */
3391
3503
  SWATCH_CHOICES = "SWATCH_CHOICES"
3392
3504
  }
3505
+ /** @enumType */
3506
+ export type ProductOptionRenderTypeWithLiterals = ProductOptionRenderType | 'UNKNOWN_OPTION_RENDER_TYPE' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
3393
3507
  export interface ChoicesSettings {
3394
3508
  /**
3395
3509
  * List of available choices for the option.
@@ -3419,7 +3533,7 @@ export interface ConnectedOptionChoice extends ConnectedOptionChoiceValueOneOf {
3419
3533
  */
3420
3534
  linkedMedia?: ProductMedia[];
3421
3535
  /** The type of this choice. */
3422
- choiceType?: ChoiceType;
3536
+ choiceType?: ChoiceTypeWithLiterals;
3423
3537
  /**
3424
3538
  * Choice name.
3425
3539
  * @minLength 1
@@ -3460,6 +3574,8 @@ export declare enum ChoiceType {
3460
3574
  /** Image choice. */
3461
3575
  IMAGE = "IMAGE"
3462
3576
  }
3577
+ /** @enumType */
3578
+ export type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
3463
3579
  export interface MultipleColors {
3464
3580
  /**
3465
3581
  * List of color codes.
@@ -3488,7 +3604,7 @@ export interface ConnectedModifier extends ConnectedModifierModifierSettingsOneO
3488
3604
  */
3489
3605
  name?: string | null;
3490
3606
  /** Modifier render type. */
3491
- modifierRenderType?: ModifierRenderType;
3607
+ modifierRenderType?: ModifierRenderTypeWithLiterals;
3492
3608
  /** Whether customer input is required for this modifier. */
3493
3609
  mandatory?: boolean;
3494
3610
  }
@@ -3509,6 +3625,8 @@ export declare enum ModifierRenderType {
3509
3625
  /** Swatch choices. */
3510
3626
  SWATCH_CHOICES = "SWATCH_CHOICES"
3511
3627
  }
3628
+ /** @enumType */
3629
+ export type ModifierRenderTypeWithLiterals = ModifierRenderType | 'UNKNOWN_MODIFIER_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
3512
3630
  export interface FreeTextSettings {
3513
3631
  /** Minimum number of characters. */
3514
3632
  minCharCount?: number;
@@ -3556,7 +3674,7 @@ export interface ConnectedModifierChoice extends ConnectedModifierChoiceValueOne
3556
3674
  */
3557
3675
  linkedMedia?: ProductMedia[];
3558
3676
  /** Choice type. */
3559
- choiceType?: ChoiceType;
3677
+ choiceType?: ChoiceTypeWithLiterals;
3560
3678
  /**
3561
3679
  * Modifier key. Used for eCommerce integration.
3562
3680
  * @readonly
@@ -3704,17 +3822,17 @@ export interface Inventory {
3704
3822
  * Current availability status.
3705
3823
  * @readonly
3706
3824
  */
3707
- availabilityStatus?: AvailabilityStatus;
3825
+ availabilityStatus?: AvailabilityStatusWithLiterals;
3708
3826
  /**
3709
3827
  * Current preorder status.
3710
3828
  * @readonly
3711
3829
  */
3712
- preorderStatus?: PreorderStatus;
3830
+ preorderStatus?: PreorderStatusWithLiterals;
3713
3831
  /**
3714
3832
  * Preorder availability status.
3715
3833
  * @readonly
3716
3834
  */
3717
- preorderAvailability?: ProductPreorderAvailability;
3835
+ preorderAvailability?: ProductPreorderAvailabilityWithLiterals;
3718
3836
  }
3719
3837
  export declare enum AvailabilityStatus {
3720
3838
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
@@ -3725,6 +3843,8 @@ export declare enum AvailabilityStatus {
3725
3843
  /** Some variants are out of stock and some are in stock and available for purchase. */
3726
3844
  PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
3727
3845
  }
3846
+ /** @enumType */
3847
+ export type AvailabilityStatusWithLiterals = AvailabilityStatus | 'UNKNOWN_AVAILABILITY_STATUS' | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
3728
3848
  export declare enum PreorderStatus {
3729
3849
  UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
3730
3850
  /** All variants are enabled for preorder. */
@@ -3734,6 +3854,8 @@ export declare enum PreorderStatus {
3734
3854
  /** Some variants are disabled and some are enabled for preorder. */
3735
3855
  PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
3736
3856
  }
3857
+ /** @enumType */
3858
+ export type PreorderStatusWithLiterals = PreorderStatus | 'UNKNOWN_PREORDER_STATUS' | 'ENABLED' | 'DISABLED' | 'PARTIALLY_ENABLED';
3737
3859
  export declare enum ProductPreorderAvailability {
3738
3860
  UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
3739
3861
  /** All the product variants are available for preorder. */
@@ -3743,6 +3865,8 @@ export declare enum ProductPreorderAvailability {
3743
3865
  /** Some of the product variants are available for preorder. */
3744
3866
  SOME_VARIANTS = "SOME_VARIANTS"
3745
3867
  }
3868
+ /** @enumType */
3869
+ export type ProductPreorderAvailabilityWithLiterals = ProductPreorderAvailability | 'UNKNOWN_PREORDER_AVAILABILITY_STATUS' | 'ALL_VARIANTS' | 'NO_VARIANTS' | 'SOME_VARIANTS';
3746
3870
  export declare enum ProductType {
3747
3871
  /** Not implemented. */
3748
3872
  UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
@@ -3751,6 +3875,8 @@ export declare enum ProductType {
3751
3875
  /** Digital product. */
3752
3876
  DIGITAL = "DIGITAL"
3753
3877
  }
3878
+ /** @enumType */
3879
+ export type ProductTypeWithLiterals = ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
3754
3880
  export interface PhysicalProperties {
3755
3881
  /**
3756
3882
  * Price per unit settings.
@@ -3796,7 +3922,7 @@ export interface PricePerUnitSettings {
3796
3922
  * Measurement unit.
3797
3923
  * For example, to define price per 100 grams, set this field to "G".
3798
3924
  */
3799
- measurementUnit?: MeasurementUnit;
3925
+ measurementUnit?: MeasurementUnitWithLiterals;
3800
3926
  }
3801
3927
  export interface WeightRange {
3802
3928
  /**
@@ -3837,7 +3963,7 @@ export interface WeightMeasurementUnitInfo {
3837
3963
  * Weight measurement unit.
3838
3964
  * @readonly
3839
3965
  */
3840
- weightMeasurementUnit?: WeightUnit;
3966
+ weightMeasurementUnit?: WeightUnitWithLiterals;
3841
3967
  }
3842
3968
  export interface BreadcrumbsInfo {
3843
3969
  /**
@@ -3984,7 +4110,7 @@ export interface OptionChoiceNames {
3984
4110
  */
3985
4111
  choiceName?: string;
3986
4112
  /** Render type. */
3987
- renderType?: ProductOptionRenderType;
4113
+ renderType?: ProductOptionRenderTypeWithLiterals;
3988
4114
  }
3989
4115
  export interface PriceInfo {
3990
4116
  /** Variant price. Must be greater or equal to 0. */
@@ -4074,7 +4200,7 @@ export interface SecuredMedia {
4074
4200
  * File type.
4075
4201
  * @readonly
4076
4202
  */
4077
- fileType?: FileType;
4203
+ fileType?: FileTypeWithLiterals;
4078
4204
  }
4079
4205
  export declare enum FileType {
4080
4206
  /** Unspecified file type. */
@@ -4090,6 +4216,8 @@ export declare enum FileType {
4090
4216
  /** Secure archive file. */
4091
4217
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
4092
4218
  }
4219
+ /** @enumType */
4220
+ export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
4093
4221
  export interface SubscriptionPricesInfo {
4094
4222
  /**
4095
4223
  * Subscription prices.
@@ -4197,7 +4325,7 @@ export interface Subscription extends SubscriptionCyclesOneOf {
4197
4325
  * Frequency of recurring payment.
4198
4326
  * For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
4199
4327
  */
4200
- frequency?: SubscriptionFrequency;
4328
+ frequency?: SubscriptionFrequencyWithLiterals;
4201
4329
  /**
4202
4330
  * Interval of recurring payment. Default: `1`. For example, if `frequency: MONTH`, `billingCycles: 3` and `interval: 2`; payment will be made every 2 months for a total of 6 months.
4203
4331
  * @min 1
@@ -4229,6 +4357,8 @@ export declare enum SubscriptionFrequency {
4229
4357
  MONTH = "MONTH",
4230
4358
  YEAR = "YEAR"
4231
4359
  }
4360
+ /** @enumType */
4361
+ export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
4232
4362
  export interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf {
4233
4363
  /**
4234
4364
  * Amount to discount from the variant discounted_price.
@@ -4242,7 +4372,7 @@ export interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf
4242
4372
  */
4243
4373
  percentOff?: number;
4244
4374
  /** Discount type. */
4245
- type?: DiscountType;
4375
+ type?: DiscountTypeWithLiterals;
4246
4376
  }
4247
4377
  /** @oneof */
4248
4378
  export interface SubscriptionDiscountDiscountOneOf {
@@ -4265,6 +4395,8 @@ export declare enum DiscountType {
4265
4395
  /** Discount by a percentage. */
4266
4396
  PERCENT = "PERCENT"
4267
4397
  }
4398
+ /** @enumType */
4399
+ export type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_DISCOUNT' | 'AMOUNT' | 'PERCENT';
4268
4400
  export interface VariantSummary {
4269
4401
  /**
4270
4402
  * The total number of variants for the product.
@@ -4425,7 +4557,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
4425
4557
  */
4426
4558
  appId?: string;
4427
4559
  /** @readonly */
4428
- identityType?: WebhookIdentityType;
4560
+ identityType?: WebhookIdentityTypeWithLiterals;
4429
4561
  }
4430
4562
  /** @oneof */
4431
4563
  export interface IdentificationDataIdOneOf {
@@ -4457,6 +4589,8 @@ export declare enum WebhookIdentityType {
4457
4589
  WIX_USER = "WIX_USER",
4458
4590
  APP = "APP"
4459
4591
  }
4592
+ /** @enumType */
4593
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
4460
4594
  type ReadOnlyVariantNonNullablePaths = `physicalProperties.pricePerUnit.settings.quantity` | `physicalProperties.pricePerUnit.settings.measurementUnit` | `physicalProperties.pricePerUnit.value` | `digitalProperties.digitalFile._id` | `digitalProperties.digitalFile.fileName` | `digitalProperties.digitalFile.fileType` | `_id` | `optionChoices` | `optionChoices.${number}.optionChoiceIds.optionId` | `optionChoices.${number}.optionChoiceIds.choiceId` | `optionChoices.${number}.optionChoiceNames.optionName` | `optionChoices.${number}.optionChoiceNames.choiceName` | `optionChoices.${number}.optionChoiceNames.renderType` | `price.actualPrice.amount` | `revenueDetails.cost.amount` | `revenueDetails.profitMargin` | `media._id` | `media.url` | `media.mediaType` | `media.thumbnail.url` | `media.thumbnail.height` | `media.thumbnail.width` | `media.uploadId` | `subscriptionPricesInfo.subscriptionPrices` | `subscriptionPricesInfo.subscriptionPrices.${number}.subscriptionId` | `subscriptionPricesInfo.subscriptionPrices.${number}.price.amount` | `subscriptionPricesInfo.subscriptionPrices.${number}.pricePerUnit.value` | `inventoryStatus.inStock` | `inventoryStatus.preorderEnabled` | `productData.physicalProperties.weightMeasurementUnitInfo.weightMeasurementUnit` | `productData.productId` | `productData.productType`;
4461
4595
  /**
4462
4596
  * Retrieves a list of ReadOnlyVariants, given the provided [paging, filtering, and sorting][1].
@@ -4512,7 +4646,7 @@ export interface QueryVariantsOptions {
4512
4646
  * A list of requested fields to be included in the response.
4513
4647
  * @maxSize 100
4514
4648
  */
4515
- fields?: RequestedFields[] | undefined;
4649
+ fields?: RequestedFieldsWithLiterals[] | undefined;
4516
4650
  }
4517
4651
  interface QueryCursorResult {
4518
4652
  cursors: Cursors;
@@ -4576,8 +4710,10 @@ export interface VariantsQueryBuilder {
4576
4710
  * >**Notes:**
4577
4711
  * + If you don't have permissions to read non visible products then variants related to non-visible products will be filtered out from response.
4578
4712
  * In such case non visible variants also will be filtered out.
4713
+ * @param search - WQL expression
4579
4714
  * @internal
4580
4715
  * @documentationMaturity preview
4716
+ * @requiredField search
4581
4717
  * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ
4582
4718
  * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN
4583
4719
  * @permissionScope Manage Stores - all permissions
@@ -4618,16 +4754,185 @@ export interface VariantsQueryBuilder {
4618
4754
  * @applicableIdentity VISITOR
4619
4755
  * @fqn com.wix.stores.catalog.product.variants.reader.api.v3.ProductVariantsReader.SearchVariants
4620
4756
  */
4621
- export declare function searchVariants(options?: SearchVariantsOptions): Promise<NonNullablePaths<SearchVariantsResponse, {
4757
+ export declare function searchVariants(search: ReadOnlyVariantSearch, options?: SearchVariantsOptions): Promise<NonNullablePaths<SearchVariantsResponse, {
4622
4758
  [P in ReadOnlyVariantNonNullablePaths]: `variants.${number}.${P}`;
4623
4759
  }[ReadOnlyVariantNonNullablePaths] | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`>>;
4624
4760
  export interface SearchVariantsOptions {
4625
- /** WQL expression */
4626
- search?: CursorSearch;
4627
4761
  /**
4628
4762
  * A list of requested fields to be included in the response.
4629
4763
  * @maxSize 100
4630
4764
  */
4631
- fields?: RequestedFields[];
4632
- }
4765
+ fields?: RequestedFieldsWithLiterals[];
4766
+ }
4767
+ export interface ReadOnlyVariantSearchSpec extends SearchSpec {
4768
+ aggregatable: [
4769
+ '_id',
4770
+ 'barcode',
4771
+ 'internalMetadata.rowState',
4772
+ 'inventoryStatus.inStock',
4773
+ 'inventoryStatus.preorderEnabled',
4774
+ 'optionChoices.optionChoiceIds.choiceId',
4775
+ 'optionChoices.optionChoiceIds.optionId',
4776
+ 'price.actualPrice.amount',
4777
+ 'price.compareAtPrice.amount',
4778
+ 'productData.directCategoryIds',
4779
+ 'productData.name',
4780
+ 'productData.productId',
4781
+ 'productData.productType',
4782
+ 'productData.slug',
4783
+ 'productData.visible',
4784
+ 'productData.visibleInPos',
4785
+ 'sku',
4786
+ 'visible'
4787
+ ];
4788
+ paging: 'cursor';
4789
+ wql: [
4790
+ {
4791
+ operators: ['$hasAll', '$hasSome'];
4792
+ fields: [
4793
+ 'optionChoices.optionChoiceIds.choiceId',
4794
+ 'optionChoices.optionChoiceIds.optionId'
4795
+ ];
4796
+ sort: 'NONE';
4797
+ },
4798
+ {
4799
+ operators: '*';
4800
+ fields: [
4801
+ '_id',
4802
+ 'barcode',
4803
+ 'internalMetadata.rowState',
4804
+ 'inventoryStatus.inStock',
4805
+ 'inventoryStatus.preorderEnabled',
4806
+ 'price.actualPrice.amount',
4807
+ 'price.compareAtPrice.amount',
4808
+ 'productData.directCategoryIds',
4809
+ 'productData.name',
4810
+ 'productData.productId',
4811
+ 'productData.productType',
4812
+ 'productData.slug',
4813
+ 'productData.visible',
4814
+ 'productData.visibleInPos',
4815
+ 'sku',
4816
+ 'visible'
4817
+ ];
4818
+ sort: 'NONE';
4819
+ }
4820
+ ];
4821
+ }
4822
+ export type CommonSearchWithEntityContext = SearchSdkType<ReadOnlyVariant, ReadOnlyVariantSearchSpec>;
4823
+ export type ReadOnlyVariantSearch = {
4824
+ /**
4825
+ Cursor pointing to page of results.
4826
+ When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
4827
+ */
4828
+ cursorPaging?: {
4829
+ /**
4830
+ Maximum number of items to return in the results.
4831
+ @max: 1000
4832
+ */
4833
+ limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
4834
+ /**
4835
+ Pointer to the next or previous page in the list of results.
4836
+
4837
+ Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
4838
+ Not relevant for the first request.
4839
+ @maxLength: 16000
4840
+ */
4841
+ cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
4842
+ };
4843
+ /**
4844
+ A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
4845
+ */
4846
+ filter?: CommonSearchWithEntityContext['filter'] | null;
4847
+ /**
4848
+ Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4849
+ @maxSize: 10
4850
+ */
4851
+ sort?: {
4852
+ /**
4853
+ Name of the field to sort by.
4854
+ @maxLength: 512
4855
+ */
4856
+ fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
4857
+ /**
4858
+ Sort order.
4859
+ */
4860
+ order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
4861
+ }[];
4862
+ /**
4863
+ Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
4864
+ @maxSize: 10
4865
+ */
4866
+ aggregations?: {
4867
+ /**
4868
+ Value aggregation
4869
+ */
4870
+ value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
4871
+ /**
4872
+ Range aggregation
4873
+ */
4874
+ range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
4875
+ /**
4876
+ Scalar aggregation
4877
+ */
4878
+ scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
4879
+ /**
4880
+ Date histogram aggregation
4881
+ */
4882
+ dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
4883
+ /**
4884
+ Nested aggregation
4885
+ */
4886
+ nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
4887
+ /**
4888
+ User-defined name of aggregation, should be unique, will appear in aggregation results
4889
+ @maxLength: 100
4890
+ */
4891
+ name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
4892
+ /**
4893
+ Type of aggregation, client must provide matching aggregation field below
4894
+ */
4895
+ type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
4896
+ /**
4897
+ Field to aggregate by, use dot notation to specify json path
4898
+ @maxLength: 200
4899
+ */
4900
+ fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
4901
+ }[];
4902
+ /**
4903
+ Free text to match in searchable fields
4904
+ */
4905
+ search?: {
4906
+ /**
4907
+ Defines how separate search terms in `expression` are combined
4908
+ */
4909
+ mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
4910
+ /**
4911
+ Search term or expression
4912
+ @maxLength: 100
4913
+ */
4914
+ expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
4915
+ /**
4916
+ Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
4917
+ @maxLength: 200,
4918
+ @maxSize: 20
4919
+ */
4920
+ fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
4921
+ /**
4922
+ Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
4923
+ */
4924
+ fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
4925
+ };
4926
+ /**
4927
+ UTC offset or IANA time zone. Valid values are
4928
+ ISO 8601 UTC offsets, such as +02:00 or -06:00,
4929
+ and IANA time zone IDs, such as Europe/Rome
4930
+
4931
+ Affects all filters and aggregations returned values.
4932
+ You may override this behavior in a specific filter by providing
4933
+ timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
4934
+ @maxLength: 50
4935
+ */
4936
+ timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
4937
+ };
4633
4938
  export {};