@wix/multilingual 1.0.37 → 1.0.38

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/multilingual",
-  "version": "1.0.37",
+  "version": "1.0.38",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,7 +22,7 @@
     "@wix/multilingual_machine-translation": "1.0.26",
     "@wix/multilingual_site-translator": "1.0.12",
     "@wix/multilingual_translation-contents": "1.0.15",
-    "@wix/multilingual_translation-published-contents": "1.0.3",
+    "@wix/multilingual_translation-published-contents": "1.0.4",
     "@wix/multilingual_translation-schemas": "1.0.13"
   },
   "devDependencies": {
@@ -48,5 +48,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "2bdec33356fd4920a7449dac668248e3e43c2b2bf034f17d9cf17504"
+  "falconPackageHash": "397f35632bfffabd2d3e701e76e553c7e04d867d07fd1d7550f58394"
 }

package/type-bundles/context.bundle.d.ts

@@ -525,26 +525,27 @@ declare namespace context$5 {
 /** Represents a content of an entity with its published translations */
 interface PublishedContent {
     /**
-     * Content ID.
+     * Pubished content ID.
      * @readonly
      */
     _id?: string | null;
-    /** Schema key of the content. */
+    /** Schema key of the published content. */
     schemaKey?: SchemaKey$1;
     /**
-     * Unique identifier that represents a specific entity under the schema key
+     * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
      * @readonly
      */
     entityId?: string;
     /**
-     * Indicates the locale of this content
+     * Published content locale.
      * @readonly
      */
     locale?: string;
-    /** List of fields localized in the given locale */
+    /** List of fields that have been translated and published for the given locale. */
     fields?: PublishedContentField[];
-    /** Optional field for the ID of the parent of this entity. */
+    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
     parentEntityId?: string | null;
+    /** Custom field data for the published content object. */
     extendedFields?: ExtendedFields;
 }
 interface SchemaKey$1 {
@@ -553,9 +554,14 @@ interface SchemaKey$1 {
      * @readonly
      */
     appId?: string;
-    /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
+    /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
     entityType?: string;
-    /** Scope schema is defined in (Global/Site) */
+    /**
+     * Scope of the translation schema.
+     * Supported values:
+     * + `GLOBAL`: A global schema for all sites.
+     * + `SITE`: A custom schema for a specific site.
+     */
     scope?: SchemaScope$1;
 }
 declare enum SchemaScope$1 {
@@ -577,11 +583,11 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
     /** Document media item */
     document?: string;
     /**
-     * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
+     * Unique string identifier that links a specific content field to its corresponding field in the schema.
      * @readonly
      */
     schemaFieldKey?: string;
-    /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
+    /** For repeated fields. Contains the IDs of the messages linked to this field. */
     sequenceIds?: string[];
 }
 /** @oneof */
@@ -1856,7 +1862,7 @@ interface GetPublishedContentResponse {
     publishedContent?: PublishedContent;
 }
 interface QueryPublishedContentRequest {
-    /** The query to filter the published content */
+    /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
     query: CursorQuery$2;
 }
 interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
@@ -1910,9 +1916,9 @@ interface CursorPaging$2 {
     cursor?: string | null;
 }
 interface QueryPublishedContentResponse {
-    /** The published content */
+    /** The published translation content. */
     publishedContent?: PublishedContent[];
-    /** Paging information */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$2;
 }
 interface CursorPagingMetadata$2 {

package/type-bundles/index.bundle.d.ts

@@ -525,26 +525,27 @@ declare namespace index_d$5 {
 /** Represents a content of an entity with its published translations */
 interface PublishedContent {
     /**
-     * Content ID.
+     * Pubished content ID.
      * @readonly
      */
     _id?: string | null;
-    /** Schema key of the content. */
+    /** Schema key of the published content. */
     schemaKey?: SchemaKey$1;
     /**
-     * Unique identifier that represents a specific entity under the schema key
+     * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
      * @readonly
      */
     entityId?: string;
     /**
-     * Indicates the locale of this content
+     * Published content locale.
      * @readonly
      */
     locale?: string;
-    /** List of fields localized in the given locale */
+    /** List of fields that have been translated and published for the given locale. */
     fields?: PublishedContentField[];
-    /** Optional field for the ID of the parent of this entity. */
+    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
     parentEntityId?: string | null;
+    /** Custom field data for the published content object. */
     extendedFields?: ExtendedFields;
 }
 interface SchemaKey$1 {
@@ -553,9 +554,14 @@ interface SchemaKey$1 {
      * @readonly
      */
     appId?: string;
-    /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
+    /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
     entityType?: string;
-    /** Scope schema is defined in (Global/Site) */
+    /**
+     * Scope of the translation schema.
+     * Supported values:
+     * + `GLOBAL`: A global schema for all sites.
+     * + `SITE`: A custom schema for a specific site.
+     */
     scope?: SchemaScope$1;
 }
 declare enum SchemaScope$1 {
@@ -577,11 +583,11 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
     /** Document media item */
     document?: string;
     /**
-     * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
+     * Unique string identifier that links a specific content field to its corresponding field in the schema.
      * @readonly
      */
     schemaFieldKey?: string;
-    /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
+    /** For repeated fields. Contains the IDs of the messages linked to this field. */
     sequenceIds?: string[];
 }
 /** @oneof */
@@ -1856,7 +1862,7 @@ interface GetPublishedContentResponse {
     publishedContent?: PublishedContent;
 }
 interface QueryPublishedContentRequest {
-    /** The query to filter the published content */
+    /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
     query: CursorQuery$2;
 }
 interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
@@ -1910,9 +1916,9 @@ interface CursorPaging$2 {
     cursor?: string | null;
 }
 interface QueryPublishedContentResponse {
-    /** The published content */
+    /** The published translation content. */
     publishedContent?: PublishedContent[];
-    /** Paging information */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$2;
 }
 interface CursorPagingMetadata$2 {

package/type-bundles/meta.bundle.d.ts

@@ -40,26 +40,27 @@ declare namespace meta$5 {
 /** Represents a content of an entity with its published translations */
 interface PublishedContent$1 {
     /**
-     * Content ID.
+     * Pubished content ID.
      * @readonly
      */
     id?: string | null;
-    /** Schema key of the content. */
+    /** Schema key of the published content. */
     schemaKey?: SchemaKey$3;
     /**
-     * Unique identifier that represents a specific entity under the schema key
+     * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
      * @readonly
      */
     entityId?: string;
     /**
-     * Indicates the locale of this content
+     * Published content locale.
      * @readonly
      */
     locale?: string;
-    /** List of fields localized in the given locale */
+    /** List of fields that have been translated and published for the given locale. */
     fields?: PublishedContentField$1[];
-    /** Optional field for the ID of the parent of this entity. */
+    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
     parentEntityId?: string | null;
+    /** Custom field data for the published content object. */
     extendedFields?: ExtendedFields$1;
 }
 interface SchemaKey$3 {
@@ -68,9 +69,14 @@ interface SchemaKey$3 {
      * @readonly
      */
     appId?: string;
-    /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
+    /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
     entityType?: string;
-    /** Scope schema is defined in (Global/Site) */
+    /**
+     * Scope of the translation schema.
+     * Supported values:
+     * + `GLOBAL`: A global schema for all sites.
+     * + `SITE`: A custom schema for a specific site.
+     */
     scope?: SchemaScope$3;
 }
 declare enum SchemaScope$3 {
@@ -92,11 +98,11 @@ interface PublishedContentField$1 extends PublishedContentFieldValueOneOf$1 {
     /** Document media item */
     document?: Document$1;
     /**
-     * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
+     * Unique string identifier that links a specific content field to its corresponding field in the schema.
      * @readonly
      */
     schemaFieldKey?: string;
-    /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
+    /** For repeated fields. Contains the IDs of the messages linked to this field. */
     sequenceIds?: string[];
 }
 /** @oneof */
@@ -1389,7 +1395,7 @@ interface ExtendedFields$1 {
     namespaces?: Record<string, Record<string, any>>;
 }
 interface QueryPublishedContentRequest$1 {
-    /** The query to filter the published content */
+    /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
     query: CursorQuery$5;
 }
 interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {
@@ -1443,9 +1449,9 @@ interface CursorPaging$5 {
     cursor?: string | null;
 }
 interface QueryPublishedContentResponse$1 {
-    /** The published content */
+    /** The published translation content. */
     publishedContent?: PublishedContent$1[];
-    /** Paging information */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$5;
 }
 interface CursorPagingMetadata$5 {
@@ -1760,26 +1766,27 @@ interface QueryPublishedContentResponseNonNullableFields$1 {
 /** Represents a content of an entity with its published translations */
 interface PublishedContent {
     /**
-     * Content ID.
+     * Pubished content ID.
      * @readonly
      */
     _id?: string | null;
-    /** Schema key of the content. */
+    /** Schema key of the published content. */
     schemaKey?: SchemaKey$2;
     /**
-     * Unique identifier that represents a specific entity under the schema key
+     * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
      * @readonly
      */
     entityId?: string;
     /**
-     * Indicates the locale of this content
+     * Published content locale.
      * @readonly
      */
     locale?: string;
-    /** List of fields localized in the given locale */
+    /** List of fields that have been translated and published for the given locale. */
     fields?: PublishedContentField[];
-    /** Optional field for the ID of the parent of this entity. */
+    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
     parentEntityId?: string | null;
+    /** Custom field data for the published content object. */
     extendedFields?: ExtendedFields;
 }
 interface SchemaKey$2 {
@@ -1788,9 +1795,14 @@ interface SchemaKey$2 {
      * @readonly
      */
     appId?: string;
-    /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
+    /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
     entityType?: string;
-    /** Scope schema is defined in (Global/Site) */
+    /**
+     * Scope of the translation schema.
+     * Supported values:
+     * + `GLOBAL`: A global schema for all sites.
+     * + `SITE`: A custom schema for a specific site.
+     */
     scope?: SchemaScope$2;
 }
 declare enum SchemaScope$2 {
@@ -1812,11 +1824,11 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
     /** Document media item */
     document?: string;
     /**
-     * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
+     * Unique string identifier that links a specific content field to its corresponding field in the schema.
      * @readonly
      */
     schemaFieldKey?: string;
-    /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
+    /** For repeated fields. Contains the IDs of the messages linked to this field. */
     sequenceIds?: string[];
 }
 /** @oneof */
@@ -3054,7 +3066,7 @@ interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 interface QueryPublishedContentRequest {
-    /** The query to filter the published content */
+    /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
     query: CursorQuery$4;
 }
 interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
@@ -3108,9 +3120,9 @@ interface CursorPaging$4 {
     cursor?: string | null;
 }
 interface QueryPublishedContentResponse {
-    /** The published content */
+    /** The published translation content. */
     publishedContent?: PublishedContent[];
-    /** Paging information */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$4;
 }
 interface CursorPagingMetadata$4 {