@wix/multilingual 1.0.85 → 1.0.86

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/multilingual",
3
- "version": "1.0.85",
3
+ "version": "1.0.86",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -24,9 +24,9 @@
24
24
  "@wix/multilingual_entity-mapper": "1.0.25",
25
25
  "@wix/multilingual_machine-translation": "1.0.38",
26
26
  "@wix/multilingual_site-translator": "1.0.21",
27
- "@wix/multilingual_translation-contents": "1.0.43",
28
- "@wix/multilingual_translation-published-contents": "1.0.21",
29
- "@wix/multilingual_translation-schemas": "1.0.41"
27
+ "@wix/multilingual_translation-contents": "1.0.44",
28
+ "@wix/multilingual_translation-published-contents": "1.0.22",
29
+ "@wix/multilingual_translation-schemas": "1.0.42"
30
30
  },
31
31
  "devDependencies": {
32
32
  "glob": "^10.4.1",
@@ -51,5 +51,5 @@
51
51
  "fqdn": ""
52
52
  }
53
53
  },
54
- "falconPackageHash": "45ca600e10da63e5a56abea49ca555dd25f1a6c55c4f69ad19d3005a"
54
+ "falconPackageHash": "8510159e659345e895dd81bbb4ce88730f03da92f95e78cc400701b9"
55
55
  }
@@ -1017,9 +1017,9 @@ interface SchemaKey$1 {
1017
1017
  }
1018
1018
  declare enum SchemaScope$1 {
1019
1019
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
1020
- /** Global schema, relevant to all sites */
1020
+ /** Global schema for all sites. */
1021
1021
  GLOBAL = "GLOBAL",
1022
- /** Site schema, relevant to specific site only */
1022
+ /** Custom schema for a specific site. */
1023
1023
  SITE = "SITE"
1024
1024
  }
1025
1025
  interface PublishedContentField extends PublishedContentFieldValueOneOf {
@@ -5359,11 +5359,6 @@ interface Content {
5359
5359
  parentEntityId?: string | null;
5360
5360
  /**
5361
5361
  * The aggregated published status across all content fields.
5362
- *
5363
- * Supported values:
5364
- * + `UNPUBLISHED`: None of the fields have been sent for publication.
5365
- * + `PUBLISHED`: All of the fields have been sent for publication.
5366
- * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
5367
5362
  * @readonly
5368
5363
  */
5369
5364
  publishStatus?: PublishStatus;
@@ -5409,13 +5404,7 @@ interface ContentField extends ContentFieldValueOneOf {
5409
5404
  * Default: `false`
5410
5405
  */
5411
5406
  published?: boolean;
5412
- /**
5413
- * **Required.** The source that updated the translation content.
5414
- * Supported values:
5415
- * + `USER`: The Wix user.
5416
- * + `EXTERNAL_APP`: An external translation app.
5417
- * + `MACHINE`: Machine translation service.
5418
- */
5407
+ /** **Required.** The source that updated the translation content. */
5419
5408
  updatedBy?: UpdaterIdentity;
5420
5409
  /**
5421
5410
  * Unique string identifier that links a specific content field to its corresponding field in the schema.
@@ -6698,21 +6687,23 @@ interface VideoResolution {
6698
6687
  format?: string;
6699
6688
  }
6700
6689
  declare enum UpdaterIdentity {
6690
+ /** Unknown updater. */
6701
6691
  UNKNOWN_UPDATER_IDENTITY = "UNKNOWN_UPDATER_IDENTITY",
6702
- /** User identity */
6692
+ /** The Wix user. */
6703
6693
  USER = "USER",
6704
- /** External */
6694
+ /** An external translation app. */
6705
6695
  EXTERNAL_APP = "EXTERNAL_APP",
6706
- /** Machine translation like Google Translate */
6696
+ /** Machine translation service. */
6707
6697
  MACHINE = "MACHINE"
6708
6698
  }
6709
6699
  declare enum PublishStatus {
6700
+ /** Unknown publish status. */
6710
6701
  UNKNOWN_PUBLISH_STATUS = "UNKNOWN_PUBLISH_STATUS",
6711
- /** No fields are published */
6702
+ /** None of the fields have been sent for publication. */
6712
6703
  UNPUBLISHED = "UNPUBLISHED",
6713
- /** Some but not all fields are published */
6704
+ /** Some of the fields have been sent for publication. */
6714
6705
  PARTIALLY_PUBLISHED = "PARTIALLY_PUBLISHED",
6715
- /** All fields are published */
6706
+ /** All of the fields have been sent for publication. */
6716
6707
  PUBLISHED = "PUBLISHED"
6717
6708
  }
6718
6709
  interface CreateContentRequest {
@@ -7003,6 +6994,7 @@ interface IncludeMissingValuesOptions {
7003
6994
  addToBucket?: string;
7004
6995
  }
7005
6996
  declare enum ScalarType {
6997
+ /** Undefined scalar type. */
7006
6998
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
7007
6999
  /** Count of distinct values. */
7008
7000
  COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -7033,14 +7025,15 @@ interface ValueAggregationOptionsOneOf {
7033
7025
  includeOptions?: IncludeMissingValuesOptions;
7034
7026
  }
7035
7027
  declare enum NestedAggregationType {
7028
+ /** Undefined aggregation type. */
7036
7029
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
7037
- /** An aggregation where result buckets are dynamically built - one per unique value. */
7030
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
7038
7031
  VALUE = "VALUE",
7039
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
7032
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
7040
7033
  RANGE = "RANGE",
7041
7034
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
7042
7035
  SCALAR = "SCALAR",
7043
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
7036
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
7044
7037
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
7045
7038
  }
7046
7039
  interface RangeAggregation {
@@ -7056,20 +7049,21 @@ interface DateHistogramAggregation {
7056
7049
  interval?: Interval;
7057
7050
  }
7058
7051
  declare enum Interval {
7052
+ /** Undefined interval type. */
7059
7053
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
7060
- /** Yearly interval */
7054
+ /** Yearly interval. */
7061
7055
  YEAR = "YEAR",
7062
- /** Monthly interval */
7056
+ /** Monthly interval. */
7063
7057
  MONTH = "MONTH",
7064
- /** Weekly interval */
7058
+ /** Weekly interval. */
7065
7059
  WEEK = "WEEK",
7066
- /** Daily interval */
7060
+ /** Daily interval. */
7067
7061
  DAY = "DAY",
7068
- /** Hourly interval */
7062
+ /** Hourly interval. */
7069
7063
  HOUR = "HOUR",
7070
- /** Minute interval */
7064
+ /** Minute interval. */
7071
7065
  MINUTE = "MINUTE",
7072
- /** Second interval */
7066
+ /** Second interval. */
7073
7067
  SECOND = "SECOND"
7074
7068
  }
7075
7069
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -7100,16 +7094,17 @@ interface NestedAggregationItemKindOneOf {
7100
7094
  dateHistogram?: DateHistogramAggregation;
7101
7095
  }
7102
7096
  declare enum AggregationType {
7097
+ /** Undefined aggregation type. */
7103
7098
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
7104
- /** An aggregation where result buckets are dynamically built - one per unique value. */
7099
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
7105
7100
  VALUE = "VALUE",
7106
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
7101
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
7107
7102
  RANGE = "RANGE",
7108
7103
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
7109
7104
  SCALAR = "SCALAR",
7110
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
7105
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
7111
7106
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
7112
- /** Multi-level aggregation, where each next aggregation is nested within previous one. */
7107
+ /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
7113
7108
  NESTED = "NESTED"
7114
7109
  }
7115
7110
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
@@ -8069,11 +8064,6 @@ interface UpdateContent {
8069
8064
  parentEntityId?: string | null;
8070
8065
  /**
8071
8066
  * The aggregated published status across all content fields.
8072
- *
8073
- * Supported values:
8074
- * + `UNPUBLISHED`: None of the fields have been sent for publication.
8075
- * + `PUBLISHED`: All of the fields have been sent for publication.
8076
- * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
8077
8067
  * @readonly
8078
8068
  */
8079
8069
  publishStatus?: PublishStatus;
@@ -8719,9 +8709,9 @@ interface SchemaKey {
8719
8709
  }
8720
8710
  declare enum SchemaScope {
8721
8711
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
8722
- /** Global schema, relevant to all sites */
8712
+ /** Global schema for all sites. */
8723
8713
  GLOBAL = "GLOBAL",
8724
- /** Site schema, relevant to specific site only */
8714
+ /** Custom schema for a specific site. */
8725
8715
  SITE = "SITE"
8726
8716
  }
8727
8717
  interface SchemaField {
@@ -8730,18 +8720,7 @@ interface SchemaField {
8730
8720
  * @readonly
8731
8721
  */
8732
8722
  _id?: string;
8733
- /**
8734
- * **Required.** Field type.
8735
- * Supported values:
8736
- * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
8737
- * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
8738
- * + `HTML`: Long text including styles, images, and links.
8739
- * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
8740
- * + `IMAGE`: Wix Media Manager image.
8741
- * + `IMAGE_LINK`: Image URL without metadata.
8742
- * + `VIDEO`: Wix Media Manager video.
8743
- * + `DOCUMENT`: Wix Media Manager document.
8744
- */
8723
+ /** **Required.** Field type. */
8745
8724
  type?: FieldType;
8746
8725
  /** Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager). */
8747
8726
  displayName?: string | null;
@@ -8763,23 +8742,23 @@ interface SchemaField {
8763
8742
  declare enum FieldType {
8764
8743
  /** Undefined field type */
8765
8744
  UNDEFINED_TYPE = "UNDEFINED_TYPE",
8766
- /** Short text TEXT */
8745
+ /** Short plain text displayed as a single line in the UI. */
8767
8746
  SHORT_TEXT = "SHORT_TEXT",
8768
- /** Long Plain Text TEXT */
8747
+ /** Long plain text displayed as multiple lines in the UI. */
8769
8748
  LONG_TEXT = "LONG_TEXT",
8770
- /** Long text including styles, images, links and more... HTML */
8749
+ /** Long text including styles, images, and links. */
8771
8750
  HTML = "HTML",
8772
- /** Wix Rich-Content format RICO */
8751
+ /** Rich-Content using the Wix Ricos format. */
8773
8752
  RICH_CONTENT = "RICH_CONTENT",
8774
- /** Wix Image media item */
8753
+ /** Wix Media Manager image. */
8775
8754
  IMAGE = "IMAGE",
8776
- /** Image URL without metadata */
8755
+ /** Image URL without metadata. */
8777
8756
  IMAGE_LINK = "IMAGE_LINK",
8778
- /** contain an XML representation of an entity or part of it */
8757
+ /** Contains an XML representation of an entity or part of it. */
8779
8758
  JSON = "JSON",
8780
- /** Wix Video media item */
8759
+ /** Wix Media Manager video. */
8781
8760
  VIDEO = "VIDEO",
8782
- /** Wix Document media item */
8761
+ /** Wix Media Manager document. */
8783
8762
  DOCUMENT = "DOCUMENT"
8784
8763
  }
8785
8764
  interface PreviewFields {
@@ -1017,9 +1017,9 @@ interface SchemaKey$1 {
1017
1017
  }
1018
1018
  declare enum SchemaScope$1 {
1019
1019
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
1020
- /** Global schema, relevant to all sites */
1020
+ /** Global schema for all sites. */
1021
1021
  GLOBAL = "GLOBAL",
1022
- /** Site schema, relevant to specific site only */
1022
+ /** Custom schema for a specific site. */
1023
1023
  SITE = "SITE"
1024
1024
  }
1025
1025
  interface PublishedContentField extends PublishedContentFieldValueOneOf {
@@ -5359,11 +5359,6 @@ interface Content {
5359
5359
  parentEntityId?: string | null;
5360
5360
  /**
5361
5361
  * The aggregated published status across all content fields.
5362
- *
5363
- * Supported values:
5364
- * + `UNPUBLISHED`: None of the fields have been sent for publication.
5365
- * + `PUBLISHED`: All of the fields have been sent for publication.
5366
- * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
5367
5362
  * @readonly
5368
5363
  */
5369
5364
  publishStatus?: PublishStatus;
@@ -5409,13 +5404,7 @@ interface ContentField extends ContentFieldValueOneOf {
5409
5404
  * Default: `false`
5410
5405
  */
5411
5406
  published?: boolean;
5412
- /**
5413
- * **Required.** The source that updated the translation content.
5414
- * Supported values:
5415
- * + `USER`: The Wix user.
5416
- * + `EXTERNAL_APP`: An external translation app.
5417
- * + `MACHINE`: Machine translation service.
5418
- */
5407
+ /** **Required.** The source that updated the translation content. */
5419
5408
  updatedBy?: UpdaterIdentity;
5420
5409
  /**
5421
5410
  * Unique string identifier that links a specific content field to its corresponding field in the schema.
@@ -6698,21 +6687,23 @@ interface VideoResolution {
6698
6687
  format?: string;
6699
6688
  }
6700
6689
  declare enum UpdaterIdentity {
6690
+ /** Unknown updater. */
6701
6691
  UNKNOWN_UPDATER_IDENTITY = "UNKNOWN_UPDATER_IDENTITY",
6702
- /** User identity */
6692
+ /** The Wix user. */
6703
6693
  USER = "USER",
6704
- /** External */
6694
+ /** An external translation app. */
6705
6695
  EXTERNAL_APP = "EXTERNAL_APP",
6706
- /** Machine translation like Google Translate */
6696
+ /** Machine translation service. */
6707
6697
  MACHINE = "MACHINE"
6708
6698
  }
6709
6699
  declare enum PublishStatus {
6700
+ /** Unknown publish status. */
6710
6701
  UNKNOWN_PUBLISH_STATUS = "UNKNOWN_PUBLISH_STATUS",
6711
- /** No fields are published */
6702
+ /** None of the fields have been sent for publication. */
6712
6703
  UNPUBLISHED = "UNPUBLISHED",
6713
- /** Some but not all fields are published */
6704
+ /** Some of the fields have been sent for publication. */
6714
6705
  PARTIALLY_PUBLISHED = "PARTIALLY_PUBLISHED",
6715
- /** All fields are published */
6706
+ /** All of the fields have been sent for publication. */
6716
6707
  PUBLISHED = "PUBLISHED"
6717
6708
  }
6718
6709
  interface CreateContentRequest {
@@ -7003,6 +6994,7 @@ interface IncludeMissingValuesOptions {
7003
6994
  addToBucket?: string;
7004
6995
  }
7005
6996
  declare enum ScalarType {
6997
+ /** Undefined scalar type. */
7006
6998
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
7007
6999
  /** Count of distinct values. */
7008
7000
  COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -7033,14 +7025,15 @@ interface ValueAggregationOptionsOneOf {
7033
7025
  includeOptions?: IncludeMissingValuesOptions;
7034
7026
  }
7035
7027
  declare enum NestedAggregationType {
7028
+ /** Undefined aggregation type. */
7036
7029
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
7037
- /** An aggregation where result buckets are dynamically built - one per unique value. */
7030
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
7038
7031
  VALUE = "VALUE",
7039
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
7032
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
7040
7033
  RANGE = "RANGE",
7041
7034
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
7042
7035
  SCALAR = "SCALAR",
7043
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
7036
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
7044
7037
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
7045
7038
  }
7046
7039
  interface RangeAggregation {
@@ -7056,20 +7049,21 @@ interface DateHistogramAggregation {
7056
7049
  interval?: Interval;
7057
7050
  }
7058
7051
  declare enum Interval {
7052
+ /** Undefined interval type. */
7059
7053
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
7060
- /** Yearly interval */
7054
+ /** Yearly interval. */
7061
7055
  YEAR = "YEAR",
7062
- /** Monthly interval */
7056
+ /** Monthly interval. */
7063
7057
  MONTH = "MONTH",
7064
- /** Weekly interval */
7058
+ /** Weekly interval. */
7065
7059
  WEEK = "WEEK",
7066
- /** Daily interval */
7060
+ /** Daily interval. */
7067
7061
  DAY = "DAY",
7068
- /** Hourly interval */
7062
+ /** Hourly interval. */
7069
7063
  HOUR = "HOUR",
7070
- /** Minute interval */
7064
+ /** Minute interval. */
7071
7065
  MINUTE = "MINUTE",
7072
- /** Second interval */
7066
+ /** Second interval. */
7073
7067
  SECOND = "SECOND"
7074
7068
  }
7075
7069
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -7100,16 +7094,17 @@ interface NestedAggregationItemKindOneOf {
7100
7094
  dateHistogram?: DateHistogramAggregation;
7101
7095
  }
7102
7096
  declare enum AggregationType {
7097
+ /** Undefined aggregation type. */
7103
7098
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
7104
- /** An aggregation where result buckets are dynamically built - one per unique value. */
7099
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
7105
7100
  VALUE = "VALUE",
7106
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
7101
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
7107
7102
  RANGE = "RANGE",
7108
7103
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
7109
7104
  SCALAR = "SCALAR",
7110
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
7105
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
7111
7106
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
7112
- /** Multi-level aggregation, where each next aggregation is nested within previous one. */
7107
+ /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
7113
7108
  NESTED = "NESTED"
7114
7109
  }
7115
7110
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
@@ -8069,11 +8064,6 @@ interface UpdateContent {
8069
8064
  parentEntityId?: string | null;
8070
8065
  /**
8071
8066
  * The aggregated published status across all content fields.
8072
- *
8073
- * Supported values:
8074
- * + `UNPUBLISHED`: None of the fields have been sent for publication.
8075
- * + `PUBLISHED`: All of the fields have been sent for publication.
8076
- * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
8077
8067
  * @readonly
8078
8068
  */
8079
8069
  publishStatus?: PublishStatus;
@@ -8719,9 +8709,9 @@ interface SchemaKey {
8719
8709
  }
8720
8710
  declare enum SchemaScope {
8721
8711
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
8722
- /** Global schema, relevant to all sites */
8712
+ /** Global schema for all sites. */
8723
8713
  GLOBAL = "GLOBAL",
8724
- /** Site schema, relevant to specific site only */
8714
+ /** Custom schema for a specific site. */
8725
8715
  SITE = "SITE"
8726
8716
  }
8727
8717
  interface SchemaField {
@@ -8730,18 +8720,7 @@ interface SchemaField {
8730
8720
  * @readonly
8731
8721
  */
8732
8722
  _id?: string;
8733
- /**
8734
- * **Required.** Field type.
8735
- * Supported values:
8736
- * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
8737
- * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
8738
- * + `HTML`: Long text including styles, images, and links.
8739
- * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
8740
- * + `IMAGE`: Wix Media Manager image.
8741
- * + `IMAGE_LINK`: Image URL without metadata.
8742
- * + `VIDEO`: Wix Media Manager video.
8743
- * + `DOCUMENT`: Wix Media Manager document.
8744
- */
8723
+ /** **Required.** Field type. */
8745
8724
  type?: FieldType;
8746
8725
  /** Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager). */
8747
8726
  displayName?: string | null;
@@ -8763,23 +8742,23 @@ interface SchemaField {
8763
8742
  declare enum FieldType {
8764
8743
  /** Undefined field type */
8765
8744
  UNDEFINED_TYPE = "UNDEFINED_TYPE",
8766
- /** Short text TEXT */
8745
+ /** Short plain text displayed as a single line in the UI. */
8767
8746
  SHORT_TEXT = "SHORT_TEXT",
8768
- /** Long Plain Text TEXT */
8747
+ /** Long plain text displayed as multiple lines in the UI. */
8769
8748
  LONG_TEXT = "LONG_TEXT",
8770
- /** Long text including styles, images, links and more... HTML */
8749
+ /** Long text including styles, images, and links. */
8771
8750
  HTML = "HTML",
8772
- /** Wix Rich-Content format RICO */
8751
+ /** Rich-Content using the Wix Ricos format. */
8773
8752
  RICH_CONTENT = "RICH_CONTENT",
8774
- /** Wix Image media item */
8753
+ /** Wix Media Manager image. */
8775
8754
  IMAGE = "IMAGE",
8776
- /** Image URL without metadata */
8755
+ /** Image URL without metadata. */
8777
8756
  IMAGE_LINK = "IMAGE_LINK",
8778
- /** contain an XML representation of an entity or part of it */
8757
+ /** Contains an XML representation of an entity or part of it. */
8779
8758
  JSON = "JSON",
8780
- /** Wix Video media item */
8759
+ /** Wix Media Manager video. */
8781
8760
  VIDEO = "VIDEO",
8782
- /** Wix Document media item */
8761
+ /** Wix Media Manager document. */
8783
8762
  DOCUMENT = "DOCUMENT"
8784
8763
  }
8785
8764
  interface PreviewFields {
@@ -80,9 +80,9 @@ interface SchemaKey$3 {
80
80
  }
81
81
  declare enum SchemaScope$3 {
82
82
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
83
- /** Global schema, relevant to all sites */
83
+ /** Global schema for all sites. */
84
84
  GLOBAL = "GLOBAL",
85
- /** Site schema, relevant to specific site only */
85
+ /** Custom schema for a specific site. */
86
86
  SITE = "SITE"
87
87
  }
88
88
  interface PublishedContentField$1 extends PublishedContentFieldValueOneOf$1 {
@@ -1822,9 +1822,9 @@ interface SchemaKey$2 {
1822
1822
  }
1823
1823
  declare enum SchemaScope$2 {
1824
1824
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
1825
- /** Global schema, relevant to all sites */
1825
+ /** Global schema for all sites. */
1826
1826
  GLOBAL = "GLOBAL",
1827
- /** Site schema, relevant to specific site only */
1827
+ /** Custom schema for a specific site. */
1828
1828
  SITE = "SITE"
1829
1829
  }
1830
1830
  interface PublishedContentField extends PublishedContentFieldValueOneOf {
@@ -7884,11 +7884,6 @@ interface Content$1 {
7884
7884
  parentEntityId?: string | null;
7885
7885
  /**
7886
7886
  * The aggregated published status across all content fields.
7887
- *
7888
- * Supported values:
7889
- * + `UNPUBLISHED`: None of the fields have been sent for publication.
7890
- * + `PUBLISHED`: All of the fields have been sent for publication.
7891
- * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
7892
7887
  * @readonly
7893
7888
  */
7894
7889
  publishStatus?: PublishStatus$1;
@@ -7934,13 +7929,7 @@ interface ContentField$1 extends ContentFieldValueOneOf$1 {
7934
7929
  * Default: `false`
7935
7930
  */
7936
7931
  published?: boolean;
7937
- /**
7938
- * **Required.** The source that updated the translation content.
7939
- * Supported values:
7940
- * + `USER`: The Wix user.
7941
- * + `EXTERNAL_APP`: An external translation app.
7942
- * + `MACHINE`: Machine translation service.
7943
- */
7932
+ /** **Required.** The source that updated the translation content. */
7944
7933
  updatedBy?: UpdaterIdentity$1;
7945
7934
  /**
7946
7935
  * Unique string identifier that links a specific content field to its corresponding field in the schema.
@@ -9249,21 +9238,23 @@ interface Document {
9249
9238
  filename?: string | null;
9250
9239
  }
9251
9240
  declare enum UpdaterIdentity$1 {
9241
+ /** Unknown updater. */
9252
9242
  UNKNOWN_UPDATER_IDENTITY = "UNKNOWN_UPDATER_IDENTITY",
9253
- /** User identity */
9243
+ /** The Wix user. */
9254
9244
  USER = "USER",
9255
- /** External */
9245
+ /** An external translation app. */
9256
9246
  EXTERNAL_APP = "EXTERNAL_APP",
9257
- /** Machine translation like Google Translate */
9247
+ /** Machine translation service. */
9258
9248
  MACHINE = "MACHINE"
9259
9249
  }
9260
9250
  declare enum PublishStatus$1 {
9251
+ /** Unknown publish status. */
9261
9252
  UNKNOWN_PUBLISH_STATUS = "UNKNOWN_PUBLISH_STATUS",
9262
- /** No fields are published */
9253
+ /** None of the fields have been sent for publication. */
9263
9254
  UNPUBLISHED = "UNPUBLISHED",
9264
- /** Some but not all fields are published */
9255
+ /** Some of the fields have been sent for publication. */
9265
9256
  PARTIALLY_PUBLISHED = "PARTIALLY_PUBLISHED",
9266
- /** All fields are published */
9257
+ /** All of the fields have been sent for publication. */
9267
9258
  PUBLISHED = "PUBLISHED"
9268
9259
  }
9269
9260
  interface CreateContentRequest$1 {
@@ -9497,6 +9488,7 @@ interface IncludeMissingValuesOptions$1 {
9497
9488
  addToBucket?: string;
9498
9489
  }
9499
9490
  declare enum ScalarType$1 {
9491
+ /** Undefined scalar type. */
9500
9492
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
9501
9493
  /** Count of distinct values. */
9502
9494
  COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -9527,14 +9519,15 @@ interface ValueAggregationOptionsOneOf$1 {
9527
9519
  includeOptions?: IncludeMissingValuesOptions$1;
9528
9520
  }
9529
9521
  declare enum NestedAggregationType$1 {
9522
+ /** Undefined aggregation type. */
9530
9523
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
9531
- /** An aggregation where result buckets are dynamically built - one per unique value. */
9524
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
9532
9525
  VALUE = "VALUE",
9533
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
9526
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
9534
9527
  RANGE = "RANGE",
9535
9528
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
9536
9529
  SCALAR = "SCALAR",
9537
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
9530
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
9538
9531
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
9539
9532
  }
9540
9533
  interface RangeAggregation$1 {
@@ -9550,20 +9543,21 @@ interface DateHistogramAggregation$1 {
9550
9543
  interval?: Interval$1;
9551
9544
  }
9552
9545
  declare enum Interval$1 {
9546
+ /** Undefined interval type. */
9553
9547
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
9554
- /** Yearly interval */
9548
+ /** Yearly interval. */
9555
9549
  YEAR = "YEAR",
9556
- /** Monthly interval */
9550
+ /** Monthly interval. */
9557
9551
  MONTH = "MONTH",
9558
- /** Weekly interval */
9552
+ /** Weekly interval. */
9559
9553
  WEEK = "WEEK",
9560
- /** Daily interval */
9554
+ /** Daily interval. */
9561
9555
  DAY = "DAY",
9562
- /** Hourly interval */
9556
+ /** Hourly interval. */
9563
9557
  HOUR = "HOUR",
9564
- /** Minute interval */
9558
+ /** Minute interval. */
9565
9559
  MINUTE = "MINUTE",
9566
- /** Second interval */
9560
+ /** Second interval. */
9567
9561
  SECOND = "SECOND"
9568
9562
  }
9569
9563
  interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
@@ -9594,16 +9588,17 @@ interface NestedAggregationItemKindOneOf$1 {
9594
9588
  dateHistogram?: DateHistogramAggregation$1;
9595
9589
  }
9596
9590
  declare enum AggregationType$1 {
9591
+ /** Undefined aggregation type. */
9597
9592
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
9598
- /** An aggregation where result buckets are dynamically built - one per unique value. */
9593
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
9599
9594
  VALUE = "VALUE",
9600
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
9595
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
9601
9596
  RANGE = "RANGE",
9602
9597
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
9603
9598
  SCALAR = "SCALAR",
9604
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
9599
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
9605
9600
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
9606
- /** Multi-level aggregation, where each next aggregation is nested within previous one. */
9601
+ /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
9607
9602
  NESTED = "NESTED"
9608
9603
  }
9609
9604
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
@@ -10052,11 +10047,6 @@ interface Content {
10052
10047
  parentEntityId?: string | null;
10053
10048
  /**
10054
10049
  * The aggregated published status across all content fields.
10055
- *
10056
- * Supported values:
10057
- * + `UNPUBLISHED`: None of the fields have been sent for publication.
10058
- * + `PUBLISHED`: All of the fields have been sent for publication.
10059
- * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
10060
10050
  * @readonly
10061
10051
  */
10062
10052
  publishStatus?: PublishStatus;
@@ -10102,13 +10092,7 @@ interface ContentField extends ContentFieldValueOneOf {
10102
10092
  * Default: `false`
10103
10093
  */
10104
10094
  published?: boolean;
10105
- /**
10106
- * **Required.** The source that updated the translation content.
10107
- * Supported values:
10108
- * + `USER`: The Wix user.
10109
- * + `EXTERNAL_APP`: An external translation app.
10110
- * + `MACHINE`: Machine translation service.
10111
- */
10095
+ /** **Required.** The source that updated the translation content. */
10112
10096
  updatedBy?: UpdaterIdentity;
10113
10097
  /**
10114
10098
  * Unique string identifier that links a specific content field to its corresponding field in the schema.
@@ -11362,21 +11346,23 @@ interface TextNodeStyle {
11362
11346
  lineHeight?: string | null;
11363
11347
  }
11364
11348
  declare enum UpdaterIdentity {
11349
+ /** Unknown updater. */
11365
11350
  UNKNOWN_UPDATER_IDENTITY = "UNKNOWN_UPDATER_IDENTITY",
11366
- /** User identity */
11351
+ /** The Wix user. */
11367
11352
  USER = "USER",
11368
- /** External */
11353
+ /** An external translation app. */
11369
11354
  EXTERNAL_APP = "EXTERNAL_APP",
11370
- /** Machine translation like Google Translate */
11355
+ /** Machine translation service. */
11371
11356
  MACHINE = "MACHINE"
11372
11357
  }
11373
11358
  declare enum PublishStatus {
11359
+ /** Unknown publish status. */
11374
11360
  UNKNOWN_PUBLISH_STATUS = "UNKNOWN_PUBLISH_STATUS",
11375
- /** No fields are published */
11361
+ /** None of the fields have been sent for publication. */
11376
11362
  UNPUBLISHED = "UNPUBLISHED",
11377
- /** Some but not all fields are published */
11363
+ /** Some of the fields have been sent for publication. */
11378
11364
  PARTIALLY_PUBLISHED = "PARTIALLY_PUBLISHED",
11379
- /** All fields are published */
11365
+ /** All of the fields have been sent for publication. */
11380
11366
  PUBLISHED = "PUBLISHED"
11381
11367
  }
11382
11368
  interface CreateContentRequest {
@@ -11610,6 +11596,7 @@ interface IncludeMissingValuesOptions {
11610
11596
  addToBucket?: string;
11611
11597
  }
11612
11598
  declare enum ScalarType {
11599
+ /** Undefined scalar type. */
11613
11600
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
11614
11601
  /** Count of distinct values. */
11615
11602
  COUNT_DISTINCT = "COUNT_DISTINCT",
@@ -11640,14 +11627,15 @@ interface ValueAggregationOptionsOneOf {
11640
11627
  includeOptions?: IncludeMissingValuesOptions;
11641
11628
  }
11642
11629
  declare enum NestedAggregationType {
11630
+ /** Undefined aggregation type. */
11643
11631
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
11644
- /** An aggregation where result buckets are dynamically built - one per unique value. */
11632
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
11645
11633
  VALUE = "VALUE",
11646
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
11634
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
11647
11635
  RANGE = "RANGE",
11648
11636
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
11649
11637
  SCALAR = "SCALAR",
11650
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
11638
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
11651
11639
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
11652
11640
  }
11653
11641
  interface RangeAggregation {
@@ -11663,20 +11651,21 @@ interface DateHistogramAggregation {
11663
11651
  interval?: Interval;
11664
11652
  }
11665
11653
  declare enum Interval {
11654
+ /** Undefined interval type. */
11666
11655
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
11667
- /** Yearly interval */
11656
+ /** Yearly interval. */
11668
11657
  YEAR = "YEAR",
11669
- /** Monthly interval */
11658
+ /** Monthly interval. */
11670
11659
  MONTH = "MONTH",
11671
- /** Weekly interval */
11660
+ /** Weekly interval. */
11672
11661
  WEEK = "WEEK",
11673
- /** Daily interval */
11662
+ /** Daily interval. */
11674
11663
  DAY = "DAY",
11675
- /** Hourly interval */
11664
+ /** Hourly interval. */
11676
11665
  HOUR = "HOUR",
11677
- /** Minute interval */
11666
+ /** Minute interval. */
11678
11667
  MINUTE = "MINUTE",
11679
- /** Second interval */
11668
+ /** Second interval. */
11680
11669
  SECOND = "SECOND"
11681
11670
  }
11682
11671
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -11707,16 +11696,17 @@ interface NestedAggregationItemKindOneOf {
11707
11696
  dateHistogram?: DateHistogramAggregation;
11708
11697
  }
11709
11698
  declare enum AggregationType {
11699
+ /** Undefined aggregation type. */
11710
11700
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
11711
- /** An aggregation where result buckets are dynamically built - one per unique value. */
11701
+ /** An aggregation where result buckets are dynamically built, one per unique value. */
11712
11702
  VALUE = "VALUE",
11713
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
11703
+ /** An aggregation, where the user can define a set of ranges, each representing a bucket. */
11714
11704
  RANGE = "RANGE",
11715
11705
  /** A single-value metric aggregation. For example, min, max, sum, avg. */
11716
11706
  SCALAR = "SCALAR",
11717
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
11707
+ /** An aggregation where result buckets are dynamically built, one per time interval. For example, every hour, day, week, etc. */
11718
11708
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
11719
- /** Multi-level aggregation, where each next aggregation is nested within previous one. */
11709
+ /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
11720
11710
  NESTED = "NESTED"
11721
11711
  }
11722
11712
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
@@ -12252,9 +12242,9 @@ interface SchemaKey$1 {
12252
12242
  }
12253
12243
  declare enum SchemaScope$1 {
12254
12244
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
12255
- /** Global schema, relevant to all sites */
12245
+ /** Global schema for all sites. */
12256
12246
  GLOBAL = "GLOBAL",
12257
- /** Site schema, relevant to specific site only */
12247
+ /** Custom schema for a specific site. */
12258
12248
  SITE = "SITE"
12259
12249
  }
12260
12250
  interface SchemaField$1 {
@@ -12263,18 +12253,7 @@ interface SchemaField$1 {
12263
12253
  * @readonly
12264
12254
  */
12265
12255
  id?: string;
12266
- /**
12267
- * **Required.** Field type.
12268
- * Supported values:
12269
- * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
12270
- * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
12271
- * + `HTML`: Long text including styles, images, and links.
12272
- * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
12273
- * + `IMAGE`: Wix Media Manager image.
12274
- * + `IMAGE_LINK`: Image URL without metadata.
12275
- * + `VIDEO`: Wix Media Manager video.
12276
- * + `DOCUMENT`: Wix Media Manager document.
12277
- */
12256
+ /** **Required.** Field type. */
12278
12257
  type?: FieldType$1;
12279
12258
  /** Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager). */
12280
12259
  displayName?: string | null;
@@ -12296,23 +12275,23 @@ interface SchemaField$1 {
12296
12275
  declare enum FieldType$1 {
12297
12276
  /** Undefined field type */
12298
12277
  UNDEFINED_TYPE = "UNDEFINED_TYPE",
12299
- /** Short text TEXT */
12278
+ /** Short plain text displayed as a single line in the UI. */
12300
12279
  SHORT_TEXT = "SHORT_TEXT",
12301
- /** Long Plain Text TEXT */
12280
+ /** Long plain text displayed as multiple lines in the UI. */
12302
12281
  LONG_TEXT = "LONG_TEXT",
12303
- /** Long text including styles, images, links and more... HTML */
12282
+ /** Long text including styles, images, and links. */
12304
12283
  HTML = "HTML",
12305
- /** Wix Rich-Content format RICO */
12284
+ /** Rich-Content using the Wix Ricos format. */
12306
12285
  RICH_CONTENT = "RICH_CONTENT",
12307
- /** Wix Image media item */
12286
+ /** Wix Media Manager image. */
12308
12287
  IMAGE = "IMAGE",
12309
- /** Image URL without metadata */
12288
+ /** Image URL without metadata. */
12310
12289
  IMAGE_LINK = "IMAGE_LINK",
12311
- /** contain an XML representation of an entity or part of it */
12290
+ /** Contains an XML representation of an entity or part of it. */
12312
12291
  JSON = "JSON",
12313
- /** Wix Video media item */
12292
+ /** Wix Media Manager video. */
12314
12293
  VIDEO = "VIDEO",
12315
- /** Wix Document media item */
12294
+ /** Wix Media Manager document. */
12316
12295
  DOCUMENT = "DOCUMENT"
12317
12296
  }
12318
12297
  interface PreviewFields$1 {
@@ -12548,9 +12527,9 @@ interface SchemaKey {
12548
12527
  }
12549
12528
  declare enum SchemaScope {
12550
12529
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
12551
- /** Global schema, relevant to all sites */
12530
+ /** Global schema for all sites. */
12552
12531
  GLOBAL = "GLOBAL",
12553
- /** Site schema, relevant to specific site only */
12532
+ /** Custom schema for a specific site. */
12554
12533
  SITE = "SITE"
12555
12534
  }
12556
12535
  interface SchemaField {
@@ -12559,18 +12538,7 @@ interface SchemaField {
12559
12538
  * @readonly
12560
12539
  */
12561
12540
  _id?: string;
12562
- /**
12563
- * **Required.** Field type.
12564
- * Supported values:
12565
- * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
12566
- * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
12567
- * + `HTML`: Long text including styles, images, and links.
12568
- * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
12569
- * + `IMAGE`: Wix Media Manager image.
12570
- * + `IMAGE_LINK`: Image URL without metadata.
12571
- * + `VIDEO`: Wix Media Manager video.
12572
- * + `DOCUMENT`: Wix Media Manager document.
12573
- */
12541
+ /** **Required.** Field type. */
12574
12542
  type?: FieldType;
12575
12543
  /** Field name displayed in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager). */
12576
12544
  displayName?: string | null;
@@ -12592,23 +12560,23 @@ interface SchemaField {
12592
12560
  declare enum FieldType {
12593
12561
  /** Undefined field type */
12594
12562
  UNDEFINED_TYPE = "UNDEFINED_TYPE",
12595
- /** Short text TEXT */
12563
+ /** Short plain text displayed as a single line in the UI. */
12596
12564
  SHORT_TEXT = "SHORT_TEXT",
12597
- /** Long Plain Text TEXT */
12565
+ /** Long plain text displayed as multiple lines in the UI. */
12598
12566
  LONG_TEXT = "LONG_TEXT",
12599
- /** Long text including styles, images, links and more... HTML */
12567
+ /** Long text including styles, images, and links. */
12600
12568
  HTML = "HTML",
12601
- /** Wix Rich-Content format RICO */
12569
+ /** Rich-Content using the Wix Ricos format. */
12602
12570
  RICH_CONTENT = "RICH_CONTENT",
12603
- /** Wix Image media item */
12571
+ /** Wix Media Manager image. */
12604
12572
  IMAGE = "IMAGE",
12605
- /** Image URL without metadata */
12573
+ /** Image URL without metadata. */
12606
12574
  IMAGE_LINK = "IMAGE_LINK",
12607
- /** contain an XML representation of an entity or part of it */
12575
+ /** Contains an XML representation of an entity or part of it. */
12608
12576
  JSON = "JSON",
12609
- /** Wix Video media item */
12577
+ /** Wix Media Manager video. */
12610
12578
  VIDEO = "VIDEO",
12611
- /** Wix Document media item */
12579
+ /** Wix Media Manager document. */
12612
12580
  DOCUMENT = "DOCUMENT"
12613
12581
  }
12614
12582
  interface PreviewFields {