@wix/auto_sdk_stores_read-only-variants-v-3 1.0.4 → 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.
- package/build/cjs/index.typings.d.ts +2 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +1 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +210 -76
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +385 -81
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
- package/build/es/index.typings.d.ts +2 -0
- package/build/es/index.typings.js.map +1 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +1 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +210 -76
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +385 -81
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +6 -2
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +4 -3
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +210 -76
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +388 -83
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
- package/build/internal/es/index.typings.d.ts +6 -2
- package/build/internal/es/index.typings.js.map +1 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +1 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +4 -3
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +1 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +1 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +210 -76
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +1 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts +388 -83
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +7 -8
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts
CHANGED
|
@@ -216,7 +216,7 @@ export interface V3ProductMedia extends V3ProductMediaSetByOneOf, V3ProductMedia
|
|
|
216
216
|
* Media type.
|
|
217
217
|
* @readonly
|
|
218
218
|
*/
|
|
219
|
-
mediaType?:
|
|
219
|
+
mediaType?: ProductMediaMediaTypeWithLiterals;
|
|
220
220
|
/**
|
|
221
221
|
* Media thumbnail.
|
|
222
222
|
* @readonly
|
|
@@ -333,6 +333,8 @@ export declare enum ProductMediaMediaType {
|
|
|
333
333
|
/** Video media type. */
|
|
334
334
|
VIDEO = "VIDEO"
|
|
335
335
|
}
|
|
336
|
+
/** @enumType */
|
|
337
|
+
export type ProductMediaMediaTypeWithLiterals = ProductMediaMediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
|
|
336
338
|
export interface V3Thumbnail {
|
|
337
339
|
/**
|
|
338
340
|
* Thumbnail url.
|
|
@@ -408,7 +410,7 @@ export interface V3PricePerUnitSettings {
|
|
|
408
410
|
* For example, to define price per 100 grams, set this field to "G".
|
|
409
411
|
* @readonly
|
|
410
412
|
*/
|
|
411
|
-
measurementUnit?:
|
|
413
|
+
measurementUnit?: MeasurementUnitWithLiterals;
|
|
412
414
|
}
|
|
413
415
|
export declare enum MeasurementUnit {
|
|
414
416
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -434,6 +436,8 @@ export declare enum MeasurementUnit {
|
|
|
434
436
|
YD = "YD",
|
|
435
437
|
SQFT = "SQFT"
|
|
436
438
|
}
|
|
439
|
+
/** @enumType */
|
|
440
|
+
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';
|
|
437
441
|
export interface V3VariantDigitalProperties {
|
|
438
442
|
/**
|
|
439
443
|
* Digital file which will be downloaded by customer after successful purchase.
|
|
@@ -469,7 +473,7 @@ export interface V3SecuredMedia {
|
|
|
469
473
|
* File type.
|
|
470
474
|
* @readonly
|
|
471
475
|
*/
|
|
472
|
-
fileType?:
|
|
476
|
+
fileType?: SecuredMediaFileTypeWithLiterals;
|
|
473
477
|
}
|
|
474
478
|
export declare enum SecuredMediaFileType {
|
|
475
479
|
/** Unspecified file type. */
|
|
@@ -485,6 +489,8 @@ export declare enum SecuredMediaFileType {
|
|
|
485
489
|
/** Secure archive file. */
|
|
486
490
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
487
491
|
}
|
|
492
|
+
/** @enumType */
|
|
493
|
+
export type SecuredMediaFileTypeWithLiterals = SecuredMediaFileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
488
494
|
export interface V3SubscriptionPricesInfo {
|
|
489
495
|
/**
|
|
490
496
|
* Subscription prices.
|
|
@@ -562,7 +568,7 @@ export interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
|
|
|
562
568
|
* product type
|
|
563
569
|
* @readonly
|
|
564
570
|
*/
|
|
565
|
-
productType?:
|
|
571
|
+
productType?: V3ProductTypeWithLiterals;
|
|
566
572
|
/**
|
|
567
573
|
* Product slug.
|
|
568
574
|
* @format URL_SLUG
|
|
@@ -622,6 +628,8 @@ export declare enum V3ProductType {
|
|
|
622
628
|
/** Digital product. */
|
|
623
629
|
DIGITAL = "DIGITAL"
|
|
624
630
|
}
|
|
631
|
+
/** @enumType */
|
|
632
|
+
export type V3ProductTypeWithLiterals = V3ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
|
|
625
633
|
export interface V3PhysicalProperties {
|
|
626
634
|
/**
|
|
627
635
|
* Weight measurement unit.
|
|
@@ -635,7 +643,7 @@ export interface V3WeightMeasurementUnitInfo {
|
|
|
635
643
|
* Weight measurement unit.
|
|
636
644
|
* @readonly
|
|
637
645
|
*/
|
|
638
|
-
weightMeasurementUnit?:
|
|
646
|
+
weightMeasurementUnit?: WeightUnitWithLiterals;
|
|
639
647
|
}
|
|
640
648
|
export declare enum WeightUnit {
|
|
641
649
|
/** Weight unit can't be classified due to an error. */
|
|
@@ -645,6 +653,8 @@ export declare enum WeightUnit {
|
|
|
645
653
|
/** Pounds. */
|
|
646
654
|
LB = "LB"
|
|
647
655
|
}
|
|
656
|
+
/** @enumType */
|
|
657
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
648
658
|
export interface InternalMetadata {
|
|
649
659
|
}
|
|
650
660
|
export declare enum InternalRowState {
|
|
@@ -659,6 +669,8 @@ export declare enum InternalRowState {
|
|
|
659
669
|
/** Variant is permanently deleted. */
|
|
660
670
|
PERMANENTLY_DELETED = "PERMANENTLY_DELETED"
|
|
661
671
|
}
|
|
672
|
+
/** @enumType */
|
|
673
|
+
export type InternalRowStateWithLiterals = InternalRowState | 'UNKNOWN_ROW_STATE' | 'READY' | 'IN_PROCESS' | 'SOFT_DELETED' | 'PERMANENTLY_DELETED';
|
|
662
674
|
export interface QueryVariantsRequest {
|
|
663
675
|
/** WQL expression. */
|
|
664
676
|
query?: CursorQuery;
|
|
@@ -666,7 +678,7 @@ export interface QueryVariantsRequest {
|
|
|
666
678
|
* A list of requested fields to be included in the response.
|
|
667
679
|
* @maxSize 100
|
|
668
680
|
*/
|
|
669
|
-
fields?:
|
|
681
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
670
682
|
}
|
|
671
683
|
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
672
684
|
/** 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`. */
|
|
@@ -699,16 +711,18 @@ export interface Sorting {
|
|
|
699
711
|
*/
|
|
700
712
|
fieldName?: string;
|
|
701
713
|
/** Sort order. */
|
|
702
|
-
order?:
|
|
714
|
+
order?: SortOrderWithLiterals;
|
|
703
715
|
}
|
|
704
716
|
export declare enum SortOrder {
|
|
705
717
|
ASC = "ASC",
|
|
706
718
|
DESC = "DESC"
|
|
707
719
|
}
|
|
720
|
+
/** @enumType */
|
|
721
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
708
722
|
export interface CursorPaging {
|
|
709
723
|
/**
|
|
710
724
|
* Maximum number of items to return in the results.
|
|
711
|
-
* @max
|
|
725
|
+
* @max 1000
|
|
712
726
|
*/
|
|
713
727
|
limit?: number | null;
|
|
714
728
|
/**
|
|
@@ -729,6 +743,8 @@ export declare enum RequestedFields {
|
|
|
729
743
|
SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
|
|
730
744
|
WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO"
|
|
731
745
|
}
|
|
746
|
+
/** @enumType */
|
|
747
|
+
export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CURRENCY' | 'MERCHANT_DATA' | 'SUBSCRIPTION_PRICES_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO';
|
|
732
748
|
export interface QueryVariantsResponse {
|
|
733
749
|
/** List of ReadOnlyVariants. */
|
|
734
750
|
variants?: ReadOnlyVariant[];
|
|
@@ -767,7 +783,7 @@ export interface SearchVariantsRequest {
|
|
|
767
783
|
* A list of requested fields to be included in the response.
|
|
768
784
|
* @maxSize 100
|
|
769
785
|
*/
|
|
770
|
-
fields?:
|
|
786
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
771
787
|
}
|
|
772
788
|
export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
773
789
|
/**
|
|
@@ -826,7 +842,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
826
842
|
*/
|
|
827
843
|
name?: string | null;
|
|
828
844
|
/** Type of aggregation, client must provide matching aggregation field below */
|
|
829
|
-
type?:
|
|
845
|
+
type?: AggregationTypeWithLiterals;
|
|
830
846
|
/**
|
|
831
847
|
* Field to aggregate by, use dot notation to specify json path
|
|
832
848
|
* @maxLength 200
|
|
@@ -858,18 +874,24 @@ export declare enum SortType {
|
|
|
858
874
|
/** Should sort by value of the field alphabetically */
|
|
859
875
|
VALUE = "VALUE"
|
|
860
876
|
}
|
|
877
|
+
/** @enumType */
|
|
878
|
+
export type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
861
879
|
export declare enum SortDirection {
|
|
862
880
|
/** Should sort in descending order */
|
|
863
881
|
DESC = "DESC",
|
|
864
882
|
/** Should sort in ascending order */
|
|
865
883
|
ASC = "ASC"
|
|
866
884
|
}
|
|
885
|
+
/** @enumType */
|
|
886
|
+
export type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
867
887
|
export declare enum MissingValues {
|
|
868
888
|
/** Should missing values be excluded from the aggregation results */
|
|
869
889
|
EXCLUDE = "EXCLUDE",
|
|
870
890
|
/** Should missing values be included in the aggregation results */
|
|
871
891
|
INCLUDE = "INCLUDE"
|
|
872
892
|
}
|
|
893
|
+
/** @enumType */
|
|
894
|
+
export type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
873
895
|
export interface IncludeMissingValuesOptions {
|
|
874
896
|
/**
|
|
875
897
|
* Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
@@ -886,17 +908,19 @@ export declare enum ScalarType {
|
|
|
886
908
|
/** Maximum value */
|
|
887
909
|
MAX = "MAX"
|
|
888
910
|
}
|
|
911
|
+
/** @enumType */
|
|
912
|
+
export type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
889
913
|
export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
890
914
|
/** Options for including missing values */
|
|
891
915
|
includeOptions?: IncludeMissingValuesOptions;
|
|
892
916
|
/** Should sort by number of matches or value of the field */
|
|
893
|
-
sortType?:
|
|
917
|
+
sortType?: SortTypeWithLiterals;
|
|
894
918
|
/** Should sort in ascending or descending order */
|
|
895
|
-
sortDirection?:
|
|
919
|
+
sortDirection?: SortDirectionWithLiterals;
|
|
896
920
|
/** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
|
|
897
921
|
limit?: number | null;
|
|
898
922
|
/** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
|
|
899
|
-
missingValues?:
|
|
923
|
+
missingValues?: MissingValuesWithLiterals;
|
|
900
924
|
}
|
|
901
925
|
/** @oneof */
|
|
902
926
|
export interface ValueAggregationOptionsOneOf {
|
|
@@ -914,6 +938,8 @@ export declare enum NestedAggregationType {
|
|
|
914
938
|
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
|
|
915
939
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
916
940
|
}
|
|
941
|
+
/** @enumType */
|
|
942
|
+
export type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
917
943
|
export interface RangeAggregation {
|
|
918
944
|
/**
|
|
919
945
|
* 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
|
|
@@ -923,11 +949,11 @@ export interface RangeAggregation {
|
|
|
923
949
|
}
|
|
924
950
|
export interface ScalarAggregation {
|
|
925
951
|
/** Define the operator for the scalar aggregation */
|
|
926
|
-
type?:
|
|
952
|
+
type?: ScalarTypeWithLiterals;
|
|
927
953
|
}
|
|
928
954
|
export interface DateHistogramAggregation {
|
|
929
955
|
/** Interval for date histogram aggregation */
|
|
930
|
-
interval?:
|
|
956
|
+
interval?: IntervalWithLiterals;
|
|
931
957
|
}
|
|
932
958
|
export declare enum Interval {
|
|
933
959
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
@@ -946,6 +972,8 @@ export declare enum Interval {
|
|
|
946
972
|
/** Second interval */
|
|
947
973
|
SECOND = "SECOND"
|
|
948
974
|
}
|
|
975
|
+
/** @enumType */
|
|
976
|
+
export type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
949
977
|
export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
950
978
|
/** Value aggregation */
|
|
951
979
|
value?: ValueAggregation;
|
|
@@ -961,7 +989,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
961
989
|
*/
|
|
962
990
|
name?: string | null;
|
|
963
991
|
/** Type of aggregation, client must provide matching aggregation field below */
|
|
964
|
-
type?:
|
|
992
|
+
type?: NestedAggregationTypeWithLiterals;
|
|
965
993
|
/**
|
|
966
994
|
* Field to aggregate by, use dont notation to specify json path
|
|
967
995
|
* @maxLength 200
|
|
@@ -992,6 +1020,8 @@ export declare enum AggregationType {
|
|
|
992
1020
|
/** Multi-level aggregation, where each next aggregation is nested within previous one */
|
|
993
1021
|
NESTED = "NESTED"
|
|
994
1022
|
}
|
|
1023
|
+
/** @enumType */
|
|
1024
|
+
export type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
995
1025
|
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
996
1026
|
export interface NestedAggregation {
|
|
997
1027
|
/**
|
|
@@ -1003,7 +1033,7 @@ export interface NestedAggregation {
|
|
|
1003
1033
|
}
|
|
1004
1034
|
export interface SearchDetails {
|
|
1005
1035
|
/** Defines how separate search terms in `expression` are combined */
|
|
1006
|
-
mode?:
|
|
1036
|
+
mode?: ModeWithLiterals;
|
|
1007
1037
|
/**
|
|
1008
1038
|
* Search term or expression
|
|
1009
1039
|
* @maxLength 100
|
|
@@ -1024,6 +1054,8 @@ export declare enum Mode {
|
|
|
1024
1054
|
/** All search terms must be present */
|
|
1025
1055
|
AND = "AND"
|
|
1026
1056
|
}
|
|
1057
|
+
/** @enumType */
|
|
1058
|
+
export type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
1027
1059
|
export interface SearchVariantsResponse {
|
|
1028
1060
|
/** Variants which satisfy the provided query. */
|
|
1029
1061
|
variants?: ReadOnlyVariant[];
|
|
@@ -1069,7 +1101,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
1069
1101
|
*/
|
|
1070
1102
|
name?: string;
|
|
1071
1103
|
/** Type of aggregation that matches result */
|
|
1072
|
-
type?:
|
|
1104
|
+
type?: AggregationTypeWithLiterals;
|
|
1073
1105
|
/**
|
|
1074
1106
|
* Field to aggregate by, matches the one provided in request
|
|
1075
1107
|
* @maxLength 200
|
|
@@ -1101,7 +1133,7 @@ export interface RangeResults {
|
|
|
1101
1133
|
}
|
|
1102
1134
|
export interface AggregationResultsScalarResult {
|
|
1103
1135
|
/** Type of scalar aggregation */
|
|
1104
|
-
type?:
|
|
1136
|
+
type?: ScalarTypeWithLiterals;
|
|
1105
1137
|
/** Value of the scalar aggregation */
|
|
1106
1138
|
value?: number;
|
|
1107
1139
|
}
|
|
@@ -1213,7 +1245,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
1213
1245
|
*/
|
|
1214
1246
|
name?: string;
|
|
1215
1247
|
/** Type of aggregation that must match provided kind as derived from search request */
|
|
1216
|
-
type?:
|
|
1248
|
+
type?: AggregationTypeWithLiterals;
|
|
1217
1249
|
/**
|
|
1218
1250
|
* Field to aggregate by as derived from search request
|
|
1219
1251
|
* @maxLength 200
|
|
@@ -1242,7 +1274,7 @@ export interface DeprecatedSearchVariantsWithOffsetRequest {
|
|
|
1242
1274
|
* A list of requested fields to be included in the response.
|
|
1243
1275
|
* @maxSize 100
|
|
1244
1276
|
*/
|
|
1245
|
-
fields?:
|
|
1277
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1246
1278
|
}
|
|
1247
1279
|
export interface PlatformOffsetSearch extends PlatformOffsetSearchPagingMethodOneOf {
|
|
1248
1280
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
@@ -1268,12 +1300,14 @@ export interface CommonSorting {
|
|
|
1268
1300
|
*/
|
|
1269
1301
|
fieldName?: string;
|
|
1270
1302
|
/** Sort order. */
|
|
1271
|
-
order?:
|
|
1303
|
+
order?: CommonSortOrderWithLiterals;
|
|
1272
1304
|
}
|
|
1273
1305
|
export declare enum CommonSortOrder {
|
|
1274
1306
|
ASC = "ASC",
|
|
1275
1307
|
DESC = "DESC"
|
|
1276
1308
|
}
|
|
1309
|
+
/** @enumType */
|
|
1310
|
+
export type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
|
|
1277
1311
|
export interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
1278
1312
|
/** Value aggregation. */
|
|
1279
1313
|
value?: AggregationValueAggregation;
|
|
@@ -1291,7 +1325,7 @@ export interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
|
1291
1325
|
*/
|
|
1292
1326
|
name?: string | null;
|
|
1293
1327
|
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
1294
|
-
type?:
|
|
1328
|
+
type?: CommonAggregationTypeWithLiterals;
|
|
1295
1329
|
/**
|
|
1296
1330
|
* Field to aggregate by, use dot notation to specify json path.
|
|
1297
1331
|
* @maxLength 200
|
|
@@ -1330,18 +1364,24 @@ export declare enum ValueAggregationSortType {
|
|
|
1330
1364
|
/** Sort by value of the field alphabetically. */
|
|
1331
1365
|
VALUE = "VALUE"
|
|
1332
1366
|
}
|
|
1367
|
+
/** @enumType */
|
|
1368
|
+
export type ValueAggregationSortTypeWithLiterals = ValueAggregationSortType | 'COUNT' | 'VALUE';
|
|
1333
1369
|
export declare enum ValueAggregationSortDirection {
|
|
1334
1370
|
/** Sort in descending order. */
|
|
1335
1371
|
DESC = "DESC",
|
|
1336
1372
|
/** Sort in ascending order. */
|
|
1337
1373
|
ASC = "ASC"
|
|
1338
1374
|
}
|
|
1375
|
+
/** @enumType */
|
|
1376
|
+
export type ValueAggregationSortDirectionWithLiterals = ValueAggregationSortDirection | 'DESC' | 'ASC';
|
|
1339
1377
|
export declare enum ValueAggregationMissingValues {
|
|
1340
1378
|
/** Exclude missing values from the aggregation results. */
|
|
1341
1379
|
EXCLUDE = "EXCLUDE",
|
|
1342
1380
|
/** Include missing values in the aggregation results. */
|
|
1343
1381
|
INCLUDE = "INCLUDE"
|
|
1344
1382
|
}
|
|
1383
|
+
/** @enumType */
|
|
1384
|
+
export type ValueAggregationMissingValuesWithLiterals = ValueAggregationMissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
1345
1385
|
export interface ValueAggregationIncludeMissingValuesOptions {
|
|
1346
1386
|
/**
|
|
1347
1387
|
* Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
@@ -1358,17 +1398,19 @@ export declare enum CommonScalarType {
|
|
|
1358
1398
|
/** Maximum value. */
|
|
1359
1399
|
MAX = "MAX"
|
|
1360
1400
|
}
|
|
1401
|
+
/** @enumType */
|
|
1402
|
+
export type CommonScalarTypeWithLiterals = CommonScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
1361
1403
|
export interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
|
|
1362
1404
|
/** Options for including missing values. */
|
|
1363
1405
|
includeOptions?: ValueAggregationIncludeMissingValuesOptions;
|
|
1364
1406
|
/** Whether to sort by number of matches or value of the field. */
|
|
1365
|
-
sortType?:
|
|
1407
|
+
sortType?: ValueAggregationSortTypeWithLiterals;
|
|
1366
1408
|
/** Whether to sort in ascending or descending order. */
|
|
1367
|
-
sortDirection?:
|
|
1409
|
+
sortDirection?: ValueAggregationSortDirectionWithLiterals;
|
|
1368
1410
|
/** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
|
|
1369
1411
|
limit?: number | null;
|
|
1370
1412
|
/** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
|
|
1371
|
-
missingValues?:
|
|
1413
|
+
missingValues?: ValueAggregationMissingValuesWithLiterals;
|
|
1372
1414
|
}
|
|
1373
1415
|
/** @oneof */
|
|
1374
1416
|
export interface AggregationValueAggregationOptionsOneOf {
|
|
@@ -1386,6 +1428,8 @@ export declare enum NestedAggregationNestedAggregationType {
|
|
|
1386
1428
|
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
|
|
1387
1429
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1388
1430
|
}
|
|
1431
|
+
/** @enumType */
|
|
1432
|
+
export type NestedAggregationNestedAggregationTypeWithLiterals = NestedAggregationNestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
1389
1433
|
export interface AggregationRangeAggregation {
|
|
1390
1434
|
/**
|
|
1391
1435
|
* 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.
|
|
@@ -1395,11 +1439,11 @@ export interface AggregationRangeAggregation {
|
|
|
1395
1439
|
}
|
|
1396
1440
|
export interface AggregationScalarAggregation {
|
|
1397
1441
|
/** Define the operator for the scalar aggregation. */
|
|
1398
|
-
type?:
|
|
1442
|
+
type?: CommonScalarTypeWithLiterals;
|
|
1399
1443
|
}
|
|
1400
1444
|
export interface AggregationDateHistogramAggregation {
|
|
1401
1445
|
/** Interval for date histogram aggregation. */
|
|
1402
|
-
interval?:
|
|
1446
|
+
interval?: DateHistogramAggregationIntervalWithLiterals;
|
|
1403
1447
|
}
|
|
1404
1448
|
export declare enum DateHistogramAggregationInterval {
|
|
1405
1449
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
@@ -1418,6 +1462,8 @@ export declare enum DateHistogramAggregationInterval {
|
|
|
1418
1462
|
/** Second interval */
|
|
1419
1463
|
SECOND = "SECOND"
|
|
1420
1464
|
}
|
|
1465
|
+
/** @enumType */
|
|
1466
|
+
export type DateHistogramAggregationIntervalWithLiterals = DateHistogramAggregationInterval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
1421
1467
|
export interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
|
|
1422
1468
|
/** Value aggregation. */
|
|
1423
1469
|
value?: AggregationValueAggregation;
|
|
@@ -1433,7 +1479,7 @@ export interface NestedAggregationNestedAggregationItem extends NestedAggregatio
|
|
|
1433
1479
|
*/
|
|
1434
1480
|
name?: string | null;
|
|
1435
1481
|
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
1436
|
-
type?:
|
|
1482
|
+
type?: NestedAggregationNestedAggregationTypeWithLiterals;
|
|
1437
1483
|
/**
|
|
1438
1484
|
* Field to aggregate by, use dot notation to specify json path.
|
|
1439
1485
|
* @maxLength 200
|
|
@@ -1464,6 +1510,8 @@ export declare enum CommonAggregationType {
|
|
|
1464
1510
|
/** Multi-level aggregation, where each next aggregation is nested within previous one. */
|
|
1465
1511
|
NESTED = "NESTED"
|
|
1466
1512
|
}
|
|
1513
|
+
/** @enumType */
|
|
1514
|
+
export type CommonAggregationTypeWithLiterals = CommonAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
1467
1515
|
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
1468
1516
|
export interface AggregationNestedAggregation {
|
|
1469
1517
|
/**
|
|
@@ -1494,7 +1542,7 @@ export interface GroupByAggregationKindOneOf {
|
|
|
1494
1542
|
}
|
|
1495
1543
|
export interface CommonSearchDetails {
|
|
1496
1544
|
/** Defines how separate search terms in `expression` are combined. */
|
|
1497
|
-
mode?:
|
|
1545
|
+
mode?: SearchDetailsModeWithLiterals;
|
|
1498
1546
|
/**
|
|
1499
1547
|
* Search term or expression.
|
|
1500
1548
|
* @maxLength 100
|
|
@@ -1515,6 +1563,8 @@ export declare enum SearchDetailsMode {
|
|
|
1515
1563
|
/** All search terms must be present. */
|
|
1516
1564
|
AND = "AND"
|
|
1517
1565
|
}
|
|
1566
|
+
/** @enumType */
|
|
1567
|
+
export type SearchDetailsModeWithLiterals = SearchDetailsMode | 'OR' | 'AND';
|
|
1518
1568
|
export interface PlatformPaging {
|
|
1519
1569
|
/**
|
|
1520
1570
|
* Number of items to load.
|
|
@@ -1718,7 +1768,7 @@ export interface Product extends ProductTypedPropertiesOneOf {
|
|
|
1718
1768
|
* When passing `productType: PHYSICAL`, you must also pass `physicalProperties`.
|
|
1719
1769
|
* @immutable
|
|
1720
1770
|
*/
|
|
1721
|
-
productType?:
|
|
1771
|
+
productType?: ProductTypeWithLiterals;
|
|
1722
1772
|
/**
|
|
1723
1773
|
* A unique human-friendly identifier for the product.
|
|
1724
1774
|
* Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.
|
|
@@ -1851,7 +1901,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1851
1901
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1852
1902
|
layoutCellData?: LayoutCellData;
|
|
1853
1903
|
/** 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. */
|
|
1854
|
-
type?:
|
|
1904
|
+
type?: NodeTypeWithLiterals;
|
|
1855
1905
|
/** Node ID. */
|
|
1856
1906
|
id?: string;
|
|
1857
1907
|
/** A list of child nodes. */
|
|
@@ -1952,6 +2002,8 @@ export declare enum NodeType {
|
|
|
1952
2002
|
LAYOUT = "LAYOUT",
|
|
1953
2003
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1954
2004
|
}
|
|
2005
|
+
/** @enumType */
|
|
2006
|
+
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';
|
|
1955
2007
|
export interface NodeStyle {
|
|
1956
2008
|
/** The top padding value in pixels. */
|
|
1957
2009
|
paddingTop?: string | null;
|
|
@@ -1964,7 +2016,7 @@ export interface ButtonData {
|
|
|
1964
2016
|
/** Styling for the button's container. */
|
|
1965
2017
|
containerData?: PluginContainerData;
|
|
1966
2018
|
/** The button type. */
|
|
1967
|
-
type?:
|
|
2019
|
+
type?: TypeWithLiterals;
|
|
1968
2020
|
/** Styling for the button. */
|
|
1969
2021
|
styles?: Styles;
|
|
1970
2022
|
/** The text to display on the button. */
|
|
@@ -2005,7 +2057,7 @@ export interface PluginContainerData {
|
|
|
2005
2057
|
/** The width of the node when it's displayed. */
|
|
2006
2058
|
width?: PluginContainerDataWidth;
|
|
2007
2059
|
/** The node's alignment within its container. */
|
|
2008
|
-
alignment?:
|
|
2060
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
2009
2061
|
/** Spoiler cover settings for the node. */
|
|
2010
2062
|
spoiler?: Spoiler;
|
|
2011
2063
|
/** The height of the node when it's displayed. */
|
|
@@ -2023,6 +2075,8 @@ export declare enum WidthType {
|
|
|
2023
2075
|
/** coast-to-coast display */
|
|
2024
2076
|
FULL_WIDTH = "FULL_WIDTH"
|
|
2025
2077
|
}
|
|
2078
|
+
/** @enumType */
|
|
2079
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
2026
2080
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
2027
2081
|
/**
|
|
2028
2082
|
* One of the following predefined width options:
|
|
@@ -2031,7 +2085,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
2031
2085
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
2032
2086
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
2033
2087
|
*/
|
|
2034
|
-
size?:
|
|
2088
|
+
size?: WidthTypeWithLiterals;
|
|
2035
2089
|
/** A custom width value in pixels. */
|
|
2036
2090
|
custom?: string | null;
|
|
2037
2091
|
}
|
|
@@ -2044,7 +2098,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
2044
2098
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
2045
2099
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
2046
2100
|
*/
|
|
2047
|
-
size?:
|
|
2101
|
+
size?: WidthTypeWithLiterals;
|
|
2048
2102
|
/** A custom width value in pixels. */
|
|
2049
2103
|
custom?: string | null;
|
|
2050
2104
|
}
|
|
@@ -2056,6 +2110,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
2056
2110
|
/** Right Alignment */
|
|
2057
2111
|
RIGHT = "RIGHT"
|
|
2058
2112
|
}
|
|
2113
|
+
/** @enumType */
|
|
2114
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2059
2115
|
export interface Spoiler {
|
|
2060
2116
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
2061
2117
|
enabled?: boolean | null;
|
|
@@ -2074,6 +2130,8 @@ export declare enum Type {
|
|
|
2074
2130
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
2075
2131
|
ACTION = "ACTION"
|
|
2076
2132
|
}
|
|
2133
|
+
/** @enumType */
|
|
2134
|
+
export type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
2077
2135
|
export interface Styles {
|
|
2078
2136
|
/**
|
|
2079
2137
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -2139,7 +2197,7 @@ export interface Link extends LinkDataOneOf {
|
|
|
2139
2197
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
2140
2198
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
2141
2199
|
*/
|
|
2142
|
-
target?:
|
|
2200
|
+
target?: TargetWithLiterals;
|
|
2143
2201
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
2144
2202
|
rel?: Rel;
|
|
2145
2203
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -2162,6 +2220,8 @@ export declare enum Target {
|
|
|
2162
2220
|
/** Opens the linked document in the full body of the window */
|
|
2163
2221
|
TOP = "TOP"
|
|
2164
2222
|
}
|
|
2223
|
+
/** @enumType */
|
|
2224
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
2165
2225
|
export interface Rel {
|
|
2166
2226
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
2167
2227
|
nofollow?: boolean | null;
|
|
@@ -2178,7 +2238,7 @@ export interface CodeBlockData {
|
|
|
2178
2238
|
}
|
|
2179
2239
|
export interface TextStyle {
|
|
2180
2240
|
/** Text alignment. Defaults to `AUTO`. */
|
|
2181
|
-
textAlignment?:
|
|
2241
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
2182
2242
|
/** 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. */
|
|
2183
2243
|
lineHeight?: string | null;
|
|
2184
2244
|
}
|
|
@@ -2194,15 +2254,17 @@ export declare enum TextAlignment {
|
|
|
2194
2254
|
/** 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 */
|
|
2195
2255
|
JUSTIFY = "JUSTIFY"
|
|
2196
2256
|
}
|
|
2257
|
+
/** @enumType */
|
|
2258
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
2197
2259
|
export interface DividerData {
|
|
2198
2260
|
/** Styling for the divider's container. */
|
|
2199
2261
|
containerData?: PluginContainerData;
|
|
2200
2262
|
/** Divider line style. */
|
|
2201
|
-
lineStyle?:
|
|
2263
|
+
lineStyle?: LineStyleWithLiterals;
|
|
2202
2264
|
/** Divider width. */
|
|
2203
|
-
width?:
|
|
2265
|
+
width?: WidthWithLiterals;
|
|
2204
2266
|
/** Divider alignment. */
|
|
2205
|
-
alignment?:
|
|
2267
|
+
alignment?: AlignmentWithLiterals;
|
|
2206
2268
|
}
|
|
2207
2269
|
export declare enum LineStyle {
|
|
2208
2270
|
/** Single Line */
|
|
@@ -2214,6 +2276,8 @@ export declare enum LineStyle {
|
|
|
2214
2276
|
/** Dotted Line */
|
|
2215
2277
|
DOTTED = "DOTTED"
|
|
2216
2278
|
}
|
|
2279
|
+
/** @enumType */
|
|
2280
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
2217
2281
|
export declare enum Width {
|
|
2218
2282
|
/** Large line */
|
|
2219
2283
|
LARGE = "LARGE",
|
|
@@ -2222,6 +2286,8 @@ export declare enum Width {
|
|
|
2222
2286
|
/** Small line */
|
|
2223
2287
|
SMALL = "SMALL"
|
|
2224
2288
|
}
|
|
2289
|
+
/** @enumType */
|
|
2290
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
2225
2291
|
export declare enum Alignment {
|
|
2226
2292
|
/** Center alignment */
|
|
2227
2293
|
CENTER = "CENTER",
|
|
@@ -2230,6 +2296,8 @@ export declare enum Alignment {
|
|
|
2230
2296
|
/** Right alignment */
|
|
2231
2297
|
RIGHT = "RIGHT"
|
|
2232
2298
|
}
|
|
2299
|
+
/** @enumType */
|
|
2300
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2233
2301
|
export interface FileData {
|
|
2234
2302
|
/** Styling for the file's container. */
|
|
2235
2303
|
containerData?: PluginContainerData;
|
|
@@ -2261,6 +2329,8 @@ export declare enum ViewMode {
|
|
|
2261
2329
|
/** Mini PDF view */
|
|
2262
2330
|
MINI = "MINI"
|
|
2263
2331
|
}
|
|
2332
|
+
/** @enumType */
|
|
2333
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
2264
2334
|
export interface FileSource extends FileSourceDataOneOf {
|
|
2265
2335
|
/** The absolute URL for the file's source. */
|
|
2266
2336
|
url?: string | null;
|
|
@@ -2293,7 +2363,7 @@ export interface PDFSettings {
|
|
|
2293
2363
|
* `FULL` : A full page view of the PDF is displayed.
|
|
2294
2364
|
* `MINI` : A mini view of the PDF is displayed.
|
|
2295
2365
|
*/
|
|
2296
|
-
viewMode?:
|
|
2366
|
+
viewMode?: ViewModeWithLiterals;
|
|
2297
2367
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
2298
2368
|
disableDownload?: boolean | null;
|
|
2299
2369
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -2380,18 +2450,24 @@ export declare enum LayoutType {
|
|
|
2380
2450
|
/** Fullsize images type */
|
|
2381
2451
|
FULLSIZE = "FULLSIZE"
|
|
2382
2452
|
}
|
|
2453
|
+
/** @enumType */
|
|
2454
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
2383
2455
|
export declare enum Orientation {
|
|
2384
2456
|
/** Rows Orientation */
|
|
2385
2457
|
ROWS = "ROWS",
|
|
2386
2458
|
/** Columns Orientation */
|
|
2387
2459
|
COLUMNS = "COLUMNS"
|
|
2388
2460
|
}
|
|
2461
|
+
/** @enumType */
|
|
2462
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
2389
2463
|
export declare enum Crop {
|
|
2390
2464
|
/** Crop to fill */
|
|
2391
2465
|
FILL = "FILL",
|
|
2392
2466
|
/** Crop to fit */
|
|
2393
2467
|
FIT = "FIT"
|
|
2394
2468
|
}
|
|
2469
|
+
/** @enumType */
|
|
2470
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
2395
2471
|
export declare enum ThumbnailsAlignment {
|
|
2396
2472
|
/** Top alignment */
|
|
2397
2473
|
TOP = "TOP",
|
|
@@ -2404,13 +2480,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
2404
2480
|
/** No thumbnail */
|
|
2405
2481
|
NONE = "NONE"
|
|
2406
2482
|
}
|
|
2483
|
+
/** @enumType */
|
|
2484
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
2407
2485
|
export interface Layout {
|
|
2408
2486
|
/** Gallery layout type. */
|
|
2409
|
-
type?:
|
|
2487
|
+
type?: LayoutTypeWithLiterals;
|
|
2410
2488
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
2411
2489
|
horizontalScroll?: boolean | null;
|
|
2412
2490
|
/** Gallery orientation. */
|
|
2413
|
-
orientation?:
|
|
2491
|
+
orientation?: OrientationWithLiterals;
|
|
2414
2492
|
/** The number of columns to display on full size screens. */
|
|
2415
2493
|
numberOfColumns?: number | null;
|
|
2416
2494
|
/** The number of columns to display on mobile screens. */
|
|
@@ -2422,13 +2500,13 @@ export interface ItemStyle {
|
|
|
2422
2500
|
/** Item ratio */
|
|
2423
2501
|
ratio?: number | null;
|
|
2424
2502
|
/** Sets how item images are cropped. */
|
|
2425
|
-
crop?:
|
|
2503
|
+
crop?: CropWithLiterals;
|
|
2426
2504
|
/** The spacing between items in pixels. */
|
|
2427
2505
|
spacing?: number | null;
|
|
2428
2506
|
}
|
|
2429
2507
|
export interface Thumbnails {
|
|
2430
2508
|
/** Thumbnail alignment. */
|
|
2431
|
-
placement?:
|
|
2509
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
2432
2510
|
/** Spacing between thumbnails in pixels. */
|
|
2433
2511
|
spacing?: number | null;
|
|
2434
2512
|
}
|
|
@@ -2444,7 +2522,7 @@ export interface GIFData {
|
|
|
2444
2522
|
/** Width in pixels. */
|
|
2445
2523
|
width?: number;
|
|
2446
2524
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2447
|
-
gifType?:
|
|
2525
|
+
gifType?: GIFTypeWithLiterals;
|
|
2448
2526
|
}
|
|
2449
2527
|
export interface GIF {
|
|
2450
2528
|
/**
|
|
@@ -2467,6 +2545,8 @@ export declare enum GIFType {
|
|
|
2467
2545
|
NORMAL = "NORMAL",
|
|
2468
2546
|
STICKER = "STICKER"
|
|
2469
2547
|
}
|
|
2548
|
+
/** @enumType */
|
|
2549
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
2470
2550
|
export interface HeadingData {
|
|
2471
2551
|
/** Heading level from 1-6. */
|
|
2472
2552
|
level?: number;
|
|
@@ -2488,7 +2568,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
2488
2568
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
2489
2569
|
containerData?: PluginContainerData;
|
|
2490
2570
|
/** The type of HTML code. */
|
|
2491
|
-
source?:
|
|
2571
|
+
source?: SourceWithLiterals;
|
|
2492
2572
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
2493
2573
|
autoHeight?: boolean | null;
|
|
2494
2574
|
}
|
|
@@ -2508,6 +2588,8 @@ export declare enum Source {
|
|
|
2508
2588
|
HTML = "HTML",
|
|
2509
2589
|
ADSENSE = "ADSENSE"
|
|
2510
2590
|
}
|
|
2591
|
+
/** @enumType */
|
|
2592
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
2511
2593
|
export interface ImageData {
|
|
2512
2594
|
/** Styling for the image's container. */
|
|
2513
2595
|
containerData?: PluginContainerData;
|
|
@@ -2572,6 +2654,8 @@ export declare enum Position {
|
|
|
2572
2654
|
/** Thumbnail hidden and not displayed */
|
|
2573
2655
|
HIDDEN = "HIDDEN"
|
|
2574
2656
|
}
|
|
2657
|
+
/** @enumType */
|
|
2658
|
+
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2575
2659
|
export interface LinkPreviewDataStyles {
|
|
2576
2660
|
/**
|
|
2577
2661
|
* Background color as a hexadecimal value.
|
|
@@ -2603,7 +2687,7 @@ export interface LinkPreviewDataStyles {
|
|
|
2603
2687
|
*/
|
|
2604
2688
|
borderColor?: string | null;
|
|
2605
2689
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2606
|
-
thumbnailPosition?:
|
|
2690
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
2607
2691
|
}
|
|
2608
2692
|
export interface MapData {
|
|
2609
2693
|
/** Styling for the map's container. */
|
|
@@ -2633,7 +2717,7 @@ export interface MapSettings {
|
|
|
2633
2717
|
/** Initial zoom value. */
|
|
2634
2718
|
initialZoom?: number | null;
|
|
2635
2719
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2636
|
-
mapType?:
|
|
2720
|
+
mapType?: MapTypeWithLiterals;
|
|
2637
2721
|
}
|
|
2638
2722
|
export declare enum MapType {
|
|
2639
2723
|
/** Roadmap map type */
|
|
@@ -2645,6 +2729,8 @@ export declare enum MapType {
|
|
|
2645
2729
|
/** Terrain map type */
|
|
2646
2730
|
TERRAIN = "TERRAIN"
|
|
2647
2731
|
}
|
|
2732
|
+
/** @enumType */
|
|
2733
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2648
2734
|
export interface ParagraphData {
|
|
2649
2735
|
/** Styling for the paragraph text. */
|
|
2650
2736
|
textStyle?: TextStyle;
|
|
@@ -2671,17 +2757,21 @@ export declare enum ViewRole {
|
|
|
2671
2757
|
/** Anyone can see the results, even if one didn't vote */
|
|
2672
2758
|
EVERYONE = "EVERYONE"
|
|
2673
2759
|
}
|
|
2760
|
+
/** @enumType */
|
|
2761
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2674
2762
|
export declare enum VoteRole {
|
|
2675
2763
|
/** Logged in member */
|
|
2676
2764
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2677
2765
|
/** Anyone */
|
|
2678
2766
|
ALL = "ALL"
|
|
2679
2767
|
}
|
|
2768
|
+
/** @enumType */
|
|
2769
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2680
2770
|
export interface Permissions {
|
|
2681
2771
|
/** Sets who can view the poll results. */
|
|
2682
|
-
view?:
|
|
2772
|
+
view?: ViewRoleWithLiterals;
|
|
2683
2773
|
/** Sets who can vote. */
|
|
2684
|
-
vote?:
|
|
2774
|
+
vote?: VoteRoleWithLiterals;
|
|
2685
2775
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2686
2776
|
allowMultipleVotes?: boolean | null;
|
|
2687
2777
|
}
|
|
@@ -2707,17 +2797,21 @@ export declare enum PollLayoutType {
|
|
|
2707
2797
|
/** Grid */
|
|
2708
2798
|
GRID = "GRID"
|
|
2709
2799
|
}
|
|
2800
|
+
/** @enumType */
|
|
2801
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2710
2802
|
export declare enum PollLayoutDirection {
|
|
2711
2803
|
/** Left-to-right */
|
|
2712
2804
|
LTR = "LTR",
|
|
2713
2805
|
/** Right-to-left */
|
|
2714
2806
|
RTL = "RTL"
|
|
2715
2807
|
}
|
|
2808
|
+
/** @enumType */
|
|
2809
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2716
2810
|
export interface PollLayout {
|
|
2717
2811
|
/** The layout for displaying the voting options. */
|
|
2718
|
-
type?:
|
|
2812
|
+
type?: PollLayoutTypeWithLiterals;
|
|
2719
2813
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
2720
|
-
direction?:
|
|
2814
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
2721
2815
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2722
2816
|
enableImage?: boolean | null;
|
|
2723
2817
|
}
|
|
@@ -2733,6 +2827,8 @@ export declare enum BackgroundType {
|
|
|
2733
2827
|
/** Gradiant background type */
|
|
2734
2828
|
GRADIENT = "GRADIENT"
|
|
2735
2829
|
}
|
|
2830
|
+
/** @enumType */
|
|
2831
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2736
2832
|
export interface Gradient {
|
|
2737
2833
|
/** The gradient angle in degrees. */
|
|
2738
2834
|
angle?: number | null;
|
|
@@ -2758,7 +2854,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2758
2854
|
/** Details for a gradient background. */
|
|
2759
2855
|
gradient?: Gradient;
|
|
2760
2856
|
/** Background type. For each option, include the relevant details. */
|
|
2761
|
-
type?:
|
|
2857
|
+
type?: BackgroundTypeWithLiterals;
|
|
2762
2858
|
}
|
|
2763
2859
|
/** @oneof */
|
|
2764
2860
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -2837,7 +2933,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2837
2933
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2838
2934
|
strikethroughData?: boolean | null;
|
|
2839
2935
|
/** The type of decoration to apply. */
|
|
2840
|
-
type?:
|
|
2936
|
+
type?: DecorationTypeWithLiterals;
|
|
2841
2937
|
}
|
|
2842
2938
|
/** @oneof */
|
|
2843
2939
|
export interface DecorationDataOneOf {
|
|
@@ -2875,6 +2971,8 @@ export declare enum DecorationType {
|
|
|
2875
2971
|
EXTERNAL = "EXTERNAL",
|
|
2876
2972
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2877
2973
|
}
|
|
2974
|
+
/** @enumType */
|
|
2975
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2878
2976
|
export interface AnchorData {
|
|
2879
2977
|
/** The target node's ID. */
|
|
2880
2978
|
anchor?: string;
|
|
@@ -2899,7 +2997,7 @@ export interface MentionData {
|
|
|
2899
2997
|
}
|
|
2900
2998
|
export interface FontSizeData {
|
|
2901
2999
|
/** The units used for the font size. */
|
|
2902
|
-
unit?:
|
|
3000
|
+
unit?: FontTypeWithLiterals;
|
|
2903
3001
|
/** Font size value. */
|
|
2904
3002
|
value?: number | null;
|
|
2905
3003
|
}
|
|
@@ -2907,6 +3005,8 @@ export declare enum FontType {
|
|
|
2907
3005
|
PX = "PX",
|
|
2908
3006
|
EM = "EM"
|
|
2909
3007
|
}
|
|
3008
|
+
/** @enumType */
|
|
3009
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2910
3010
|
export interface SpoilerData {
|
|
2911
3011
|
/** Spoiler ID. */
|
|
2912
3012
|
id?: string | null;
|
|
@@ -2917,7 +3017,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2917
3017
|
/** Data for embedded Wix Events content. */
|
|
2918
3018
|
eventData?: EventData;
|
|
2919
3019
|
/** The type of Wix App content being embedded. */
|
|
2920
|
-
type?:
|
|
3020
|
+
type?: AppTypeWithLiterals;
|
|
2921
3021
|
/** The ID of the embedded content. */
|
|
2922
3022
|
itemId?: string | null;
|
|
2923
3023
|
/** The name of the embedded content. */
|
|
@@ -2944,6 +3044,8 @@ export declare enum AppType {
|
|
|
2944
3044
|
EVENT = "EVENT",
|
|
2945
3045
|
BOOKING = "BOOKING"
|
|
2946
3046
|
}
|
|
3047
|
+
/** @enumType */
|
|
3048
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2947
3049
|
export interface BookingData {
|
|
2948
3050
|
/** Booking duration in minutes. */
|
|
2949
3051
|
durations?: string | null;
|
|
@@ -3022,9 +3124,9 @@ export interface CollapsibleListData {
|
|
|
3022
3124
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
3023
3125
|
expandOnlyOne?: boolean | null;
|
|
3024
3126
|
/** Sets which items are expanded when the page loads. */
|
|
3025
|
-
initialExpandedItems?:
|
|
3127
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
3026
3128
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
3027
|
-
direction?:
|
|
3129
|
+
direction?: DirectionWithLiterals;
|
|
3028
3130
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
3029
3131
|
isQapageData?: boolean | null;
|
|
3030
3132
|
}
|
|
@@ -3036,12 +3138,16 @@ export declare enum InitialExpandedItems {
|
|
|
3036
3138
|
/** All items collapsed initally */
|
|
3037
3139
|
NONE = "NONE"
|
|
3038
3140
|
}
|
|
3141
|
+
/** @enumType */
|
|
3142
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
3039
3143
|
export declare enum Direction {
|
|
3040
3144
|
/** Left-to-right */
|
|
3041
3145
|
LTR = "LTR",
|
|
3042
3146
|
/** Right-to-left */
|
|
3043
3147
|
RTL = "RTL"
|
|
3044
3148
|
}
|
|
3149
|
+
/** @enumType */
|
|
3150
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
3045
3151
|
export interface TableData {
|
|
3046
3152
|
/** Styling for the table's container. */
|
|
3047
3153
|
containerData?: PluginContainerData;
|
|
@@ -3079,9 +3185,11 @@ export declare enum VerticalAlignment {
|
|
|
3079
3185
|
/** Bottom alignment */
|
|
3080
3186
|
BOTTOM = "BOTTOM"
|
|
3081
3187
|
}
|
|
3188
|
+
/** @enumType */
|
|
3189
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
3082
3190
|
export interface CellStyle {
|
|
3083
3191
|
/** Vertical alignment for the cell's text. */
|
|
3084
|
-
verticalAlignment?:
|
|
3192
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
3085
3193
|
/**
|
|
3086
3194
|
* Cell background color as a hexadecimal value.
|
|
3087
3195
|
* @format COLOR_HEX
|
|
@@ -3120,6 +3228,8 @@ export declare enum NullValue {
|
|
|
3120
3228
|
/** Null value. */
|
|
3121
3229
|
NULL_VALUE = "NULL_VALUE"
|
|
3122
3230
|
}
|
|
3231
|
+
/** @enumType */
|
|
3232
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
3123
3233
|
/**
|
|
3124
3234
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
3125
3235
|
*
|
|
@@ -3265,7 +3375,7 @@ export interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaO
|
|
|
3265
3375
|
* Media type.
|
|
3266
3376
|
* @readonly
|
|
3267
3377
|
*/
|
|
3268
|
-
mediaType?:
|
|
3378
|
+
mediaType?: MediaTypeWithLiterals;
|
|
3269
3379
|
/**
|
|
3270
3380
|
* Media thumbnail.
|
|
3271
3381
|
* > **Note:** Returned only when you pass `"THUMBNAIL"` to the `fields` array in Products API requests.
|
|
@@ -3380,6 +3490,8 @@ export declare enum MediaType {
|
|
|
3380
3490
|
/** Video media type. */
|
|
3381
3491
|
VIDEO = "VIDEO"
|
|
3382
3492
|
}
|
|
3493
|
+
/** @enumType */
|
|
3494
|
+
export type MediaTypeWithLiterals = MediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
|
|
3383
3495
|
export interface Thumbnail {
|
|
3384
3496
|
/**
|
|
3385
3497
|
* Thumbnail url.
|
|
@@ -3478,7 +3590,7 @@ export interface ConnectedOption extends ConnectedOptionOptionSettingsOneOf {
|
|
|
3478
3590
|
*/
|
|
3479
3591
|
name?: string | null;
|
|
3480
3592
|
/** Option render type. */
|
|
3481
|
-
optionRenderType?:
|
|
3593
|
+
optionRenderType?: ProductOptionRenderTypeWithLiterals;
|
|
3482
3594
|
}
|
|
3483
3595
|
/** @oneof */
|
|
3484
3596
|
export interface ConnectedOptionOptionSettingsOneOf {
|
|
@@ -3493,6 +3605,8 @@ export declare enum ProductOptionRenderType {
|
|
|
3493
3605
|
/** Swatch choices. */
|
|
3494
3606
|
SWATCH_CHOICES = "SWATCH_CHOICES"
|
|
3495
3607
|
}
|
|
3608
|
+
/** @enumType */
|
|
3609
|
+
export type ProductOptionRenderTypeWithLiterals = ProductOptionRenderType | 'UNKNOWN_OPTION_RENDER_TYPE' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
|
|
3496
3610
|
export interface ChoicesSettings {
|
|
3497
3611
|
/**
|
|
3498
3612
|
* List of available choices for the option.
|
|
@@ -3522,7 +3636,7 @@ export interface ConnectedOptionChoice extends ConnectedOptionChoiceValueOneOf {
|
|
|
3522
3636
|
*/
|
|
3523
3637
|
linkedMedia?: ProductMedia[];
|
|
3524
3638
|
/** The type of this choice. */
|
|
3525
|
-
choiceType?:
|
|
3639
|
+
choiceType?: ChoiceTypeWithLiterals;
|
|
3526
3640
|
/**
|
|
3527
3641
|
* Choice name.
|
|
3528
3642
|
* @minLength 1
|
|
@@ -3563,6 +3677,8 @@ export declare enum ChoiceType {
|
|
|
3563
3677
|
/** Image choice. */
|
|
3564
3678
|
IMAGE = "IMAGE"
|
|
3565
3679
|
}
|
|
3680
|
+
/** @enumType */
|
|
3681
|
+
export type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
|
|
3566
3682
|
export interface MultipleColors {
|
|
3567
3683
|
/**
|
|
3568
3684
|
* List of color codes.
|
|
@@ -3591,7 +3707,7 @@ export interface ConnectedModifier extends ConnectedModifierModifierSettingsOneO
|
|
|
3591
3707
|
*/
|
|
3592
3708
|
name?: string | null;
|
|
3593
3709
|
/** Modifier render type. */
|
|
3594
|
-
modifierRenderType?:
|
|
3710
|
+
modifierRenderType?: ModifierRenderTypeWithLiterals;
|
|
3595
3711
|
/** Whether customer input is required for this modifier. */
|
|
3596
3712
|
mandatory?: boolean;
|
|
3597
3713
|
}
|
|
@@ -3612,6 +3728,8 @@ export declare enum ModifierRenderType {
|
|
|
3612
3728
|
/** Swatch choices. */
|
|
3613
3729
|
SWATCH_CHOICES = "SWATCH_CHOICES"
|
|
3614
3730
|
}
|
|
3731
|
+
/** @enumType */
|
|
3732
|
+
export type ModifierRenderTypeWithLiterals = ModifierRenderType | 'UNKNOWN_MODIFIER_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
|
|
3615
3733
|
export interface FreeTextSettings {
|
|
3616
3734
|
/** Minimum number of characters. */
|
|
3617
3735
|
minCharCount?: number;
|
|
@@ -3659,7 +3777,7 @@ export interface ConnectedModifierChoice extends ConnectedModifierChoiceValueOne
|
|
|
3659
3777
|
*/
|
|
3660
3778
|
linkedMedia?: ProductMedia[];
|
|
3661
3779
|
/** Choice type. */
|
|
3662
|
-
choiceType?:
|
|
3780
|
+
choiceType?: ChoiceTypeWithLiterals;
|
|
3663
3781
|
/**
|
|
3664
3782
|
* Modifier key. Used for eCommerce integration.
|
|
3665
3783
|
* @readonly
|
|
@@ -3807,17 +3925,17 @@ export interface Inventory {
|
|
|
3807
3925
|
* Current availability status.
|
|
3808
3926
|
* @readonly
|
|
3809
3927
|
*/
|
|
3810
|
-
availabilityStatus?:
|
|
3928
|
+
availabilityStatus?: AvailabilityStatusWithLiterals;
|
|
3811
3929
|
/**
|
|
3812
3930
|
* Current preorder status.
|
|
3813
3931
|
* @readonly
|
|
3814
3932
|
*/
|
|
3815
|
-
preorderStatus?:
|
|
3933
|
+
preorderStatus?: PreorderStatusWithLiterals;
|
|
3816
3934
|
/**
|
|
3817
3935
|
* Preorder availability status.
|
|
3818
3936
|
* @readonly
|
|
3819
3937
|
*/
|
|
3820
|
-
preorderAvailability?:
|
|
3938
|
+
preorderAvailability?: ProductPreorderAvailabilityWithLiterals;
|
|
3821
3939
|
}
|
|
3822
3940
|
export declare enum AvailabilityStatus {
|
|
3823
3941
|
UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
|
|
@@ -3828,6 +3946,8 @@ export declare enum AvailabilityStatus {
|
|
|
3828
3946
|
/** Some variants are out of stock and some are in stock and available for purchase. */
|
|
3829
3947
|
PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
|
|
3830
3948
|
}
|
|
3949
|
+
/** @enumType */
|
|
3950
|
+
export type AvailabilityStatusWithLiterals = AvailabilityStatus | 'UNKNOWN_AVAILABILITY_STATUS' | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
|
|
3831
3951
|
export declare enum PreorderStatus {
|
|
3832
3952
|
UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
|
|
3833
3953
|
/** All variants are enabled for preorder. */
|
|
@@ -3837,6 +3957,8 @@ export declare enum PreorderStatus {
|
|
|
3837
3957
|
/** Some variants are disabled and some are enabled for preorder. */
|
|
3838
3958
|
PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
|
|
3839
3959
|
}
|
|
3960
|
+
/** @enumType */
|
|
3961
|
+
export type PreorderStatusWithLiterals = PreorderStatus | 'UNKNOWN_PREORDER_STATUS' | 'ENABLED' | 'DISABLED' | 'PARTIALLY_ENABLED';
|
|
3840
3962
|
export declare enum ProductPreorderAvailability {
|
|
3841
3963
|
UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
|
|
3842
3964
|
/** All the product variants are available for preorder. */
|
|
@@ -3846,6 +3968,8 @@ export declare enum ProductPreorderAvailability {
|
|
|
3846
3968
|
/** Some of the product variants are available for preorder. */
|
|
3847
3969
|
SOME_VARIANTS = "SOME_VARIANTS"
|
|
3848
3970
|
}
|
|
3971
|
+
/** @enumType */
|
|
3972
|
+
export type ProductPreorderAvailabilityWithLiterals = ProductPreorderAvailability | 'UNKNOWN_PREORDER_AVAILABILITY_STATUS' | 'ALL_VARIANTS' | 'NO_VARIANTS' | 'SOME_VARIANTS';
|
|
3849
3973
|
export declare enum ProductType {
|
|
3850
3974
|
/** Not implemented. */
|
|
3851
3975
|
UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
|
|
@@ -3854,6 +3978,8 @@ export declare enum ProductType {
|
|
|
3854
3978
|
/** Digital product. */
|
|
3855
3979
|
DIGITAL = "DIGITAL"
|
|
3856
3980
|
}
|
|
3981
|
+
/** @enumType */
|
|
3982
|
+
export type ProductTypeWithLiterals = ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
|
|
3857
3983
|
export interface PhysicalProperties {
|
|
3858
3984
|
/**
|
|
3859
3985
|
* Price per unit settings.
|
|
@@ -3899,7 +4025,7 @@ export interface PricePerUnitSettings {
|
|
|
3899
4025
|
* Measurement unit.
|
|
3900
4026
|
* For example, to define price per 100 grams, set this field to "G".
|
|
3901
4027
|
*/
|
|
3902
|
-
measurementUnit?:
|
|
4028
|
+
measurementUnit?: MeasurementUnitWithLiterals;
|
|
3903
4029
|
}
|
|
3904
4030
|
export interface WeightRange {
|
|
3905
4031
|
/**
|
|
@@ -3940,7 +4066,7 @@ export interface WeightMeasurementUnitInfo {
|
|
|
3940
4066
|
* Weight measurement unit.
|
|
3941
4067
|
* @readonly
|
|
3942
4068
|
*/
|
|
3943
|
-
weightMeasurementUnit?:
|
|
4069
|
+
weightMeasurementUnit?: WeightUnitWithLiterals;
|
|
3944
4070
|
}
|
|
3945
4071
|
export interface BreadcrumbsInfo {
|
|
3946
4072
|
/**
|
|
@@ -4087,7 +4213,7 @@ export interface OptionChoiceNames {
|
|
|
4087
4213
|
*/
|
|
4088
4214
|
choiceName?: string;
|
|
4089
4215
|
/** Render type. */
|
|
4090
|
-
renderType?:
|
|
4216
|
+
renderType?: ProductOptionRenderTypeWithLiterals;
|
|
4091
4217
|
}
|
|
4092
4218
|
export interface PriceInfo {
|
|
4093
4219
|
/** Variant price. Must be greater or equal to 0. */
|
|
@@ -4177,7 +4303,7 @@ export interface SecuredMedia {
|
|
|
4177
4303
|
* File type.
|
|
4178
4304
|
* @readonly
|
|
4179
4305
|
*/
|
|
4180
|
-
fileType?:
|
|
4306
|
+
fileType?: FileTypeWithLiterals;
|
|
4181
4307
|
}
|
|
4182
4308
|
export declare enum FileType {
|
|
4183
4309
|
/** Unspecified file type. */
|
|
@@ -4193,6 +4319,8 @@ export declare enum FileType {
|
|
|
4193
4319
|
/** Secure archive file. */
|
|
4194
4320
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
4195
4321
|
}
|
|
4322
|
+
/** @enumType */
|
|
4323
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
4196
4324
|
export interface SubscriptionPricesInfo {
|
|
4197
4325
|
/**
|
|
4198
4326
|
* Subscription prices.
|
|
@@ -4300,7 +4428,7 @@ export interface Subscription extends SubscriptionCyclesOneOf {
|
|
|
4300
4428
|
* Frequency of recurring payment.
|
|
4301
4429
|
* For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
|
|
4302
4430
|
*/
|
|
4303
|
-
frequency?:
|
|
4431
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
4304
4432
|
/**
|
|
4305
4433
|
* 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.
|
|
4306
4434
|
* @min 1
|
|
@@ -4332,6 +4460,8 @@ export declare enum SubscriptionFrequency {
|
|
|
4332
4460
|
MONTH = "MONTH",
|
|
4333
4461
|
YEAR = "YEAR"
|
|
4334
4462
|
}
|
|
4463
|
+
/** @enumType */
|
|
4464
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
4335
4465
|
export interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf {
|
|
4336
4466
|
/**
|
|
4337
4467
|
* Amount to discount from the variant discounted_price.
|
|
@@ -4345,7 +4475,7 @@ export interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf
|
|
|
4345
4475
|
*/
|
|
4346
4476
|
percentOff?: number;
|
|
4347
4477
|
/** Discount type. */
|
|
4348
|
-
type?:
|
|
4478
|
+
type?: DiscountTypeWithLiterals;
|
|
4349
4479
|
}
|
|
4350
4480
|
/** @oneof */
|
|
4351
4481
|
export interface SubscriptionDiscountDiscountOneOf {
|
|
@@ -4368,6 +4498,8 @@ export declare enum DiscountType {
|
|
|
4368
4498
|
/** Discount by a percentage. */
|
|
4369
4499
|
PERCENT = "PERCENT"
|
|
4370
4500
|
}
|
|
4501
|
+
/** @enumType */
|
|
4502
|
+
export type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_DISCOUNT' | 'AMOUNT' | 'PERCENT';
|
|
4371
4503
|
export interface VariantSummary {
|
|
4372
4504
|
/**
|
|
4373
4505
|
* The total number of variants for the product.
|
|
@@ -4530,7 +4662,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
4530
4662
|
*/
|
|
4531
4663
|
appId?: string;
|
|
4532
4664
|
/** @readonly */
|
|
4533
|
-
identityType?:
|
|
4665
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4534
4666
|
}
|
|
4535
4667
|
/** @oneof */
|
|
4536
4668
|
export interface IdentificationDataIdOneOf {
|
|
@@ -4562,3 +4694,5 @@ export declare enum WebhookIdentityType {
|
|
|
4562
4694
|
WIX_USER = "WIX_USER",
|
|
4563
4695
|
APP = "APP"
|
|
4564
4696
|
}
|
|
4697
|
+
/** @enumType */
|
|
4698
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|