@wix/multilingual 1.0.37 → 1.0.39

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 {
@@ -7980,29 +7986,35 @@ declare namespace index_d$1 {
 
 interface Schema {
     /**
-     * Schema ID.
+     * Translation schema ID.
      * @readonly
      */
     _id?: string | null;
-    /** (compound key) Schema key. */
+    /** Translation schema unique key identifier. */
     key?: SchemaKey;
-    /** A list of unique fields on the entity in the specific language */
+    /** List of fields for the translation schema. This property uses a string to map to a `SchemaField` (`Map<string, SchemaField>`). The string serves as a key, which you'll need to access each field in the schema and when adding translation content. */
     fields?: Record<string, SchemaField>;
-    /** Fields that will be displayed in content previews (e.g., product name for products). */
+    /** Fields displayed in content previews. For example, a product name for a product translation schema. */
     previewFields?: PreviewFields;
-    /** Whether the schema is hidden from the site. */
+    /** Whether the translation schema is hidden from the site. */
     hidden?: boolean | null;
-    /** The name of the schema */
+    /** Translation schema name. */
     displayName?: string | null;
-    /** Higher level schema, group_by_name will point to an entity of this schema. */
+    /** A reference to the parent schema defined by the app developer. For example, if the schema is for a menu item, this property would link to the schema of the menu it belongs to. */
     parentId?: string | null;
     /** @readonly */
     revision?: string | null;
-    /** @readonly */
+    /**
+     * Date and time the translation schema was created.
+     * @readonly
+     */
     _createdDate?: Date;
-    /** @readonly */
+    /**
+     * Date and time the translation schema was updated.
+     * @readonly
+     */
     _updatedDate?: Date;
-    /** indicate if the content should be duplicated when the site is cloned */
+    /** Whether to duplicate the translated content in the schema when a site containing the translation schema and content is duplicated. */
     duplicateContent?: boolean | null;
 }
 interface SchemaKey {
@@ -8011,9 +8023,14 @@ interface SchemaKey {
      * @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;
 }
 declare enum SchemaScope {
@@ -8025,27 +8042,38 @@ declare enum SchemaScope {
 }
 interface SchemaField {
     /**
-     * Field ID.
+     * Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parenthesis to reference repeated items, such as images. These parenthesis can't be nested and each open one must have a closed one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     _id?: string;
-    /** Field type. */
+    /**
+     * Field type.
+     * Supported values:
+     * + `SHORT_TEXT`: Short plain text.
+     * + `LONG_TEXT`: Long plain text.
+     * + `HTML`: Long text including styles, images, and links.
+     * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos.js](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
+     * + `IMAGE`: Wix Media Manager image.
+     * + `IMAGE_LINK`: Image URL without metadata.
+     * + `VIDEO`: Wix Media Manager video.
+     * + `DOCUMENT`: Wix Media Manager document.
+     */
     type?: FieldType;
-    /** Field descriptive name. */
+    /** Field name. */
     displayName?: string | null;
-    /** Field semantic grouping */
+    /** Field group name. */
     groupName?: string | null;
-    /** Field minimum length (in case of text field) */
+    /** Field minimum text length. */
     minLength?: number | null;
-    /** Field maximum length (in case text field) */
+    /** Field maximum text length. */
     maxLength?: number | null;
-    /** Field format. If set - must be one of the values of wix.api.format as string (case insensitive) */
+    /** Field format. The content will be validated based on the format set here in the field schema. For example, if the format is `EMAIL`, then the content for this field must be a valid email address. */
     format?: string | null;
-    /** Whether the field is hidden from the site. Hidden field constraints (type, min/max length) are still active! */
+    /** Whether the field is hidden from the site. Hidden fields are still validated. */
     hidden?: boolean;
-    /** Whether the field is for display only and should not allowed to be translated */
+    /** Whether the field is read-only, and is not meant to be translated. For example, an image. Use this field as a way to provide more context for the field in the Multilingual Dashboard. */
     displayOnly?: boolean;
-    /** In cases where the order of the fields holds meaning, use this index */
+    /** Field index. Use for cases where the order of the fields are relevant. */
     index?: number | null;
 }
 declare enum FieldType {
@@ -8077,31 +8105,31 @@ interface PreviewFields {
     imageFieldId?: string | null;
 }
 interface CreateSchemaRequest {
-    /** Schema to be created. */
+    /** Translation schema to create. */
     schema?: Schema;
 }
 interface CreateSchemaResponse {
-    /** The created Schema. */
+    /** Newly created translation schema. */
     schema?: Schema;
 }
 interface GetSchemaRequest {
-    /** ID of the Schema to retrieve. */
+    /** ID of the translation schema to retrieve. */
     schemaId: string;
 }
 interface GetSchemaResponse {
-    /** The requested Schema. */
+    /** The requested translation schema. */
     schema?: Schema;
 }
 interface GetSchemaByKeyRequest {
-    /** ID of the Schema to retrieve. */
+    /** ID of the translation schema to retrieve. */
     key: SchemaKey;
 }
 interface GetSchemaByKeyResponse {
-    /** The requested Schema. */
+    /** The requested translation schema. */
     schema?: Schema;
 }
 interface UpdateSchemaRequest {
-    /** Schema to be updated, may be partial. */
+    /** Translation schema to update. */
     schema?: Schema;
 }
 interface UpdateSchemaResponse {
@@ -8109,36 +8137,42 @@ interface UpdateSchemaResponse {
     schema?: Schema;
 }
 interface DeleteSchemaRequest {
-    /** Id of the Schema to delete. */
+    /** ID of the translation schema to delete. */
     schemaId?: string;
 }
 interface DeleteSchemaResponse {
 }
 interface QuerySchemasRequest {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** 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`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf {
-    /** 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`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging;
 }
 interface Sorting {
@@ -8163,13 +8197,13 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QuerySchemasResponse {
-    /** List of Schemas. */
+    /** List of translation schemas. */
     schemas?: Schema[];
-    /** Paging metadata */
+    /** Paging metadata for the next page of results. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors;
@@ -8192,9 +8226,9 @@ interface ListSiteSchemasRequest {
     paging?: CursorPaging;
 }
 interface ListSiteSchemasResponse {
-    /** List of Schemas. */
+    /** List of translation schemas. */
     schemas?: Schema[];
-    /** Paging metadata */
+    /** Paging metadata for the next page of results. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
@@ -8665,9 +8699,14 @@ interface GetSchemaByKeyIdentifiers {
      * @readonly
      */
     keyAppId?: 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'`. */
     keyEntityType?: 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.
+     */
     keyScope?: SchemaScope;
 }
 interface QuerySchemasOptions {
@@ -8737,30 +8776,39 @@ interface ListSiteSchemasOptions {
 declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
 interface GetSchemaSignature {
     /**
-     * Retrieves a Schema.
-     * @param - ID of the Schema to retrieve.
-     * @returns The requested Schema.
+     * Retrieves a translation schema.
+     * @param - ID of the translation schema to retrieve.
+     * @returns The requested translation schema.
      */
     (schemaId: string): Promise<Schema & SchemaNonNullableFields>;
 }
 declare function getSchemaByKey$1(httpClient: HttpClient): GetSchemaByKeySignature;
 interface GetSchemaByKeySignature {
     /**
-     * Retrieves a Schema by key.
+     * Retrieves a translation schema by key.
      */
     (identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey): Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
 }
 declare function querySchemas$1(httpClient: HttpClient): QuerySchemasSignature;
 interface QuerySchemasSignature {
     /**
-     * Retrieves a list of Schemas, given the provided [paging, filtering, and sorting][1].
+     * Retrieves a list of schemas, given the provided paging, filtering, and sorting. Up to 100 schemas can be returned per request.
+     *
+     * > **Note:**
+     * >
+     * > This method can retrieve all schemas with a `GLOBAL` scope and `SITE` scope schemas for the site you are authorized for in the current API request.
+     *
+     * The default `sort` is `id` in `ASC`.
+     *
+     * For a detailed list of supported operations, see [Translation Schema: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/translation-schema/sort-and-filter).
+     * To learn how to query translation schemas, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
      */
     (options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
 }
 declare function listSiteSchemas$1(httpClient: HttpClient): ListSiteSchemasSignature;
 interface ListSiteSchemasSignature {
     /**
-     * Retrieves a list of Schemas of app installed on site.
+     * Retrieves a list of all translation schemas associated with a site, including those created by you or other developers.
      */
     (options?: ListSiteSchemasOptions | undefined): Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
 }