@datocms/cma-client 1.1.1 → 1.1.2

package/dist/esm/buildBlockRecord.d.ts

@@ -16,6 +16,8 @@ export declare function buildBlockRecord(body: SimpleSchemaTypes.ItemUpdateSchem
         status?: "published" | "draft" | "updated" | null | undefined;
         is_valid?: boolean | undefined;
         current_version?: string | undefined;
+        is_current_version_valid?: boolean | null | undefined;
+        is_published_version_valid?: boolean | null | undefined;
         stage?: string | null | undefined;
     } | undefined;
     relationships?: {

package/dist/esm/generated/SchemaTypes.d.ts

@@ -516,7 +516,7 @@ export declare type ItemInstancesHrefSchema = {
         [k: string]: unknown;
     };
     /**
-     * Fields used to order results. You _must_ specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+     * Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
      */
     order_by?: string;
     /**
@@ -843,6 +843,10 @@ export declare type SearchResultInstancesHrefSchema = {
      * Attributes to filter search results
      */
     filter: {
+        /**
+         * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+         */
+        fuzzy?: string;
         /**
          * Text to search
          */
@@ -5710,6 +5714,14 @@ export declare type ItemMeta = {
      * Whether the current record is valid or not
      */
     is_valid: boolean;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid: null | boolean;
+    /**
+     * Whether the published version of record is valid or not
+     */
+    is_published_version_valid: null | boolean;
     /**
      * The ID of the current record version
      */
@@ -5827,6 +5839,14 @@ export declare type ItemCreateSchema = {
              * Whether the current record is valid or not
              */
             is_valid?: boolean;
+            /**
+             * Whether the current version of the record is valid or not
+             */
+            is_current_version_valid?: null | boolean;
+            /**
+             * Whether the published version of the record is valid or not
+             */
+            is_published_version_valid?: null | boolean;
             /**
              * The ID of the current record version
              */
@@ -5919,6 +5939,14 @@ export declare type ItemUpdateSchema = {
              * The ID of the current record version (for optimistic locking, see the example)
              */
             current_version?: string;
+            /**
+             * Whether the current version of the record is valid or not
+             */
+            is_current_version_valid?: null | boolean;
+            /**
+             * Whether the published version of record is valid or not
+             */
+            is_published_version_valid?: null | boolean;
             /**
              * The new stage to move the record to
              */
@@ -7815,7 +7843,7 @@ export declare type ItemTypeFilterAttributes = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7862,7 +7890,7 @@ export declare type ItemTypeFilterCreateSchema = {
              */
             name: string;
             /**
-             * The actual filter
+             * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
              */
             filter: {
                 [k: string]: unknown;
@@ -7910,7 +7938,7 @@ export declare type ItemTypeFilterUpdateSchema = {
              */
             shared?: boolean;
             /**
-             * The actual filter
+             * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
              */
             filter: {
                 [k: string]: unknown;

package/dist/esm/generated/SimpleSchemaTypes.d.ts

@@ -611,7 +611,7 @@ export declare type ItemInstancesHrefSchema = {
         [k: string]: unknown;
     };
     /**
-     * Fields used to order results. You _must_ specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+     * Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
      */
     order_by?: string;
     /**
@@ -1023,6 +1023,10 @@ export declare type SearchResultInstancesHrefSchema = {
      * Attributes to filter search results
      */
     filter: {
+        /**
+         * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+         */
+        fuzzy?: string;
         /**
          * Text to search
          */
@@ -6134,6 +6138,14 @@ export declare type ItemMeta = {
      * Whether the current record is valid or not
      */
     is_valid: boolean;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid: null | boolean;
+    /**
+     * Whether the published version of record is valid or not
+     */
+    is_published_version_valid: null | boolean;
     /**
      * The ID of the current record version
      */
@@ -6221,6 +6233,14 @@ export declare type ItemCreateSchema = {
          * Whether the current record is valid or not
          */
         is_valid?: boolean;
+        /**
+         * Whether the current version of the record is valid or not
+         */
+        is_current_version_valid?: null | boolean;
+        /**
+         * Whether the published version of the record is valid or not
+         */
+        is_published_version_valid?: null | boolean;
         /**
          * The ID of the current record version
          */
@@ -6277,6 +6297,14 @@ export declare type ItemUpdateSchema = {
          * The ID of the current record version (for optimistic locking, see the example)
          */
         current_version?: string;
+        /**
+         * Whether the current version of the record is valid or not
+         */
+        is_current_version_valid?: null | boolean;
+        /**
+         * Whether the published version of record is valid or not
+         */
+        is_published_version_valid?: null | boolean;
         /**
          * The new stage to move the record to
          */
@@ -7807,7 +7835,7 @@ export declare type ItemTypeFilter = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7844,7 +7872,7 @@ export declare type ItemTypeFilterAttributes = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7874,7 +7902,7 @@ export declare type ItemTypeFilterCreateSchema = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7901,7 +7929,7 @@ export declare type ItemTypeFilterUpdateSchema = {
      */
     shared?: boolean;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;

package/dist/types/buildBlockRecord.d.ts

@@ -16,6 +16,8 @@ export declare function buildBlockRecord(body: SimpleSchemaTypes.ItemUpdateSchem
         status?: "published" | "draft" | "updated" | null | undefined;
         is_valid?: boolean | undefined;
         current_version?: string | undefined;
+        is_current_version_valid?: boolean | null | undefined;
+        is_published_version_valid?: boolean | null | undefined;
         stage?: string | null | undefined;
     } | undefined;
     relationships?: {

package/dist/types/generated/SchemaTypes.d.ts

@@ -516,7 +516,7 @@ export declare type ItemInstancesHrefSchema = {
         [k: string]: unknown;
     };
     /**
-     * Fields used to order results. You _must_ specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+     * Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
      */
     order_by?: string;
     /**
@@ -843,6 +843,10 @@ export declare type SearchResultInstancesHrefSchema = {
      * Attributes to filter search results
      */
     filter: {
+        /**
+         * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+         */
+        fuzzy?: string;
         /**
          * Text to search
          */
@@ -5710,6 +5714,14 @@ export declare type ItemMeta = {
      * Whether the current record is valid or not
      */
     is_valid: boolean;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid: null | boolean;
+    /**
+     * Whether the published version of record is valid or not
+     */
+    is_published_version_valid: null | boolean;
     /**
      * The ID of the current record version
      */
@@ -5827,6 +5839,14 @@ export declare type ItemCreateSchema = {
              * Whether the current record is valid or not
              */
             is_valid?: boolean;
+            /**
+             * Whether the current version of the record is valid or not
+             */
+            is_current_version_valid?: null | boolean;
+            /**
+             * Whether the published version of the record is valid or not
+             */
+            is_published_version_valid?: null | boolean;
             /**
              * The ID of the current record version
              */
@@ -5919,6 +5939,14 @@ export declare type ItemUpdateSchema = {
              * The ID of the current record version (for optimistic locking, see the example)
              */
             current_version?: string;
+            /**
+             * Whether the current version of the record is valid or not
+             */
+            is_current_version_valid?: null | boolean;
+            /**
+             * Whether the published version of record is valid or not
+             */
+            is_published_version_valid?: null | boolean;
             /**
              * The new stage to move the record to
              */
@@ -7815,7 +7843,7 @@ export declare type ItemTypeFilterAttributes = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7862,7 +7890,7 @@ export declare type ItemTypeFilterCreateSchema = {
              */
             name: string;
             /**
-             * The actual filter
+             * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
              */
             filter: {
                 [k: string]: unknown;
@@ -7910,7 +7938,7 @@ export declare type ItemTypeFilterUpdateSchema = {
              */
             shared?: boolean;
             /**
-             * The actual filter
+             * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
              */
             filter: {
                 [k: string]: unknown;

package/dist/types/generated/SimpleSchemaTypes.d.ts

@@ -611,7 +611,7 @@ export declare type ItemInstancesHrefSchema = {
         [k: string]: unknown;
     };
     /**
-     * Fields used to order results. You _must_ specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+     * Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
      */
     order_by?: string;
     /**
@@ -1023,6 +1023,10 @@ export declare type SearchResultInstancesHrefSchema = {
      * Attributes to filter search results
      */
     filter: {
+        /**
+         * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+         */
+        fuzzy?: string;
         /**
          * Text to search
          */
@@ -6134,6 +6138,14 @@ export declare type ItemMeta = {
      * Whether the current record is valid or not
      */
     is_valid: boolean;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid: null | boolean;
+    /**
+     * Whether the published version of record is valid or not
+     */
+    is_published_version_valid: null | boolean;
     /**
      * The ID of the current record version
      */
@@ -6221,6 +6233,14 @@ export declare type ItemCreateSchema = {
          * Whether the current record is valid or not
          */
         is_valid?: boolean;
+        /**
+         * Whether the current version of the record is valid or not
+         */
+        is_current_version_valid?: null | boolean;
+        /**
+         * Whether the published version of the record is valid or not
+         */
+        is_published_version_valid?: null | boolean;
         /**
          * The ID of the current record version
          */
@@ -6277,6 +6297,14 @@ export declare type ItemUpdateSchema = {
          * The ID of the current record version (for optimistic locking, see the example)
          */
         current_version?: string;
+        /**
+         * Whether the current version of the record is valid or not
+         */
+        is_current_version_valid?: null | boolean;
+        /**
+         * Whether the published version of record is valid or not
+         */
+        is_published_version_valid?: null | boolean;
         /**
          * The new stage to move the record to
          */
@@ -7807,7 +7835,7 @@ export declare type ItemTypeFilter = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7844,7 +7872,7 @@ export declare type ItemTypeFilterAttributes = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7874,7 +7902,7 @@ export declare type ItemTypeFilterCreateSchema = {
      */
     name: string;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;
@@ -7901,7 +7929,7 @@ export declare type ItemTypeFilterUpdateSchema = {
      */
     shared?: boolean;
     /**
-     * The actual filter
+     * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
      */
     filter: {
         [k: string]: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -37,10 +37,10 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^1.1.1"
+    "@datocms/rest-client-utils": "^1.1.2"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^1.1.1"
+    "@datocms/dashboard-client": "^1.1.2"
   },
-  "gitHead": "d3b88053a1500682a3d679622975b3da7fe6aff5"
+  "gitHead": "60159cb125e4a493dbbeefb4ac3764d25c2abae8"
 }

package/src/generated/SchemaTypes.ts

@@ -520,7 +520,7 @@ export type ItemInstancesHrefSchema = {
     [k: string]: unknown;
   };
   /**
-   * Fields used to order results. You _must_ specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+   * Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
    */
   order_by?: string;
   /**
@@ -847,6 +847,10 @@ export type SearchResultInstancesHrefSchema = {
    * Attributes to filter search results
    */
   filter: {
+    /**
+     * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+     */
+    fuzzy?: string;
     /**
      * Text to search
      */
@@ -6105,6 +6109,14 @@ export type ItemMeta = {
    * Whether the current record is valid or not
    */
   is_valid: boolean;
+  /**
+   * Whether the current version of the record is valid or not
+   */
+  is_current_version_valid: null | boolean;
+  /**
+   * Whether the published version of record is valid or not
+   */
+  is_published_version_valid: null | boolean;
   /**
    * The ID of the current record version
    */
@@ -6226,6 +6238,14 @@ export type ItemCreateSchema = {
        * Whether the current record is valid or not
        */
       is_valid?: boolean;
+      /**
+       * Whether the current version of the record is valid or not
+       */
+      is_current_version_valid?: null | boolean;
+      /**
+       * Whether the published version of the record is valid or not
+       */
+      is_published_version_valid?: null | boolean;
       /**
        * The ID of the current record version
        */
@@ -6322,6 +6342,14 @@ export type ItemUpdateSchema = {
        * The ID of the current record version (for optimistic locking, see the example)
        */
       current_version?: string;
+      /**
+       * Whether the current version of the record is valid or not
+       */
+      is_current_version_valid?: null | boolean;
+      /**
+       * Whether the published version of record is valid or not
+       */
+      is_published_version_valid?: null | boolean;
       /**
        * The new stage to move the record to
        */
@@ -8342,7 +8370,7 @@ export type ItemTypeFilterAttributes = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8392,7 +8420,7 @@ export type ItemTypeFilterCreateSchema = {
        */
       name: string;
       /**
-       * The actual filter
+       * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
        */
       filter: {
         [k: string]: unknown;
@@ -8442,7 +8470,7 @@ export type ItemTypeFilterUpdateSchema = {
        */
       shared?: boolean;
       /**
-       * The actual filter
+       * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
        */
       filter: {
         [k: string]: unknown;

package/src/generated/SimpleSchemaTypes.ts

@@ -615,7 +615,7 @@ export type ItemInstancesHrefSchema = {
     [k: string]: unknown;
   };
   /**
-   * Fields used to order results. You _must_ specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+   * Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
    */
   order_by?: string;
   /**
@@ -1027,6 +1027,10 @@ export type SearchResultInstancesHrefSchema = {
    * Attributes to filter search results
    */
   filter: {
+    /**
+     * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+     */
+    fuzzy?: string;
     /**
      * Text to search
      */
@@ -6526,6 +6530,14 @@ export type ItemMeta = {
    * Whether the current record is valid or not
    */
   is_valid: boolean;
+  /**
+   * Whether the current version of the record is valid or not
+   */
+  is_current_version_valid: null | boolean;
+  /**
+   * Whether the published version of record is valid or not
+   */
+  is_published_version_valid: null | boolean;
   /**
    * The ID of the current record version
    */
@@ -6618,6 +6630,14 @@ export type ItemCreateSchema = {
      * Whether the current record is valid or not
      */
     is_valid?: boolean;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid?: null | boolean;
+    /**
+     * Whether the published version of the record is valid or not
+     */
+    is_published_version_valid?: null | boolean;
     /**
      * The ID of the current record version
      */
@@ -6675,6 +6695,14 @@ export type ItemUpdateSchema = {
      * The ID of the current record version (for optimistic locking, see the example)
      */
     current_version?: string;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid?: null | boolean;
+    /**
+     * Whether the published version of record is valid or not
+     */
+    is_published_version_valid?: null | boolean;
     /**
      * The new stage to move the record to
      */
@@ -8251,7 +8279,7 @@ export type ItemTypeFilter = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8289,7 +8317,7 @@ export type ItemTypeFilterAttributes = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8321,7 +8349,7 @@ export type ItemTypeFilterCreateSchema = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8349,7 +8377,7 @@ export type ItemTypeFilterUpdateSchema = {
    */
   shared?: boolean;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;