@datocms/cma-client 1.1.1 → 1.1.3

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

@@ -268,6 +268,23 @@ export declare type MenuItemIdentity = string;
  * via the `definition` "type".
  */
 export declare type ItemTypeType = 'item_type';
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export declare type ItemTypeFilterType = 'item_type_filter';
+/**
+ * ID of filter
+ *
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export declare type ItemTypeFilterIdentity = string;
 /**
  * This interface was referenced by `MenuItem`'s JSON-Schema
  * via the `instances.hrefSchema` link.
@@ -516,7 +533,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 +860,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
          */
@@ -949,23 +970,6 @@ export declare type WebhookCallInstancesHrefSchema = {
     };
     [k: string]: unknown;
 };
-/**
- * JSON API type field
- *
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
- * via the `definition` "type".
- */
-export declare type ItemTypeFilterType = 'item_type_filter';
-/**
- * ID of filter
- *
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
- * via the `definition` "identity".
- *
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
- * via the `definition` "id".
- */
-export declare type ItemTypeFilterIdentity = string;
 /**
  * JSON API type field
  *
@@ -3076,7 +3080,7 @@ export declare type MenuItemAttributes = {
      */
     position: number;
     /**
-     * Opens link in new tab (used together with `external_url`)
+     * Opens link in new tab (to be used together with `external_url`)
      */
     open_in_new_tab: boolean;
 };
@@ -3088,11 +3092,17 @@ export declare type MenuItemAttributes = {
  */
 export declare type MenuItemRelationships = {
     /**
-     * item type associated with the menu item
+     * Item type associated with the menu item
      */
     item_type: {
         data: ItemTypeData | null;
     };
+    /**
+     * Item type filter associated with the menu item (to be used together with `item_type` relationship)
+     */
+    item_type_filter: {
+        data: ItemTypeFilterData | null;
+    };
     /**
      * Parent menu item
      */
@@ -3116,6 +3126,16 @@ export declare type ItemTypeData = {
     type: ItemTypeType;
     id: ItemTypeIdentity;
 };
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export declare type ItemTypeFilterData = {
+    type: ItemTypeFilterType;
+    id: ItemTypeFilterIdentity;
+};
 /**
  * JSON API data
  *
@@ -3148,19 +3168,25 @@ export declare type MenuItemCreateSchema = {
             /**
              * Ordering index
              */
-            position: number;
+            position?: number;
             /**
-             * Opens link in new tab (used together with `external_url`)
+             * Opens link in new tab (to be used together with `external_url`)
              */
             open_in_new_tab?: boolean;
         };
         relationships?: {
             /**
-             * item type associated with the menu item
+             * Item type associated with the menu item
              */
             item_type?: {
                 data: ItemTypeData | null;
             };
+            /**
+             * Item type filter associated with the menu item (to be used together with `item_type` relationship)
+             */
+            item_type_filter?: {
+                data: ItemTypeFilterData | null;
+            };
             /**
              * Parent menu item
              */
@@ -3192,7 +3218,7 @@ export declare type MenuItemUpdateSchema = {
             /**
              * The label of the menu item
              */
-            label: string;
+            label?: string;
             /**
              * The URL to which the menu item points to
              */
@@ -3200,19 +3226,25 @@ export declare type MenuItemUpdateSchema = {
             /**
              * Ordering index
              */
-            position: number;
+            position?: number;
             /**
-             * Opens link in new tab (used together with `external_url`)
+             * Opens link in new tab (to be used together with `external_url`)
              */
             open_in_new_tab?: boolean;
         };
         relationships?: {
             /**
-             * item type associated with the menu item
+             * Item type associated with the menu item
              */
             item_type?: {
                 data: ItemTypeData | null;
             };
+            /**
+             * Item type filter associated with the menu item (to be used together with `item_type` relationship)
+             */
+            item_type_filter?: {
+                data: ItemTypeFilterData | null;
+            };
             /**
              * Parent menu item
              */
@@ -5710,6 +5742,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 +5867,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 +5967,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,11 +7871,40 @@ 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;
     };
+    /**
+     * The columns to show with this filter
+     */
+    columns: [
+        {
+            /**
+             * Can be either the API key of a model's field, or one of the following meta columns: `id`, `_preview`, `_updated_at`, `_created_at`, `_creator`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `position` (only for sortable models), `_stage (only for models associated with a workflow).
+             */
+            name: string;
+            /**
+             * The percentage width for the column (float, from 0 to 1.0)
+             */
+            width: number;
+        },
+        ...{
+            /**
+             * Can be either the API key of a model's field, or one of the following meta columns: `id`, `_preview`, `_updated_at`, `_created_at`, `_creator`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `position` (only for sortable models), `_stage (only for models associated with a workflow).
+             */
+            name: string;
+            /**
+             * The percentage width for the column (float, from 0 to 1.0)
+             */
+            width: number;
+        }[]
+    ] | null;
+    /**
+     * The ordering to apply with this filter, or `null` for the default model ordering. It follows the form of the `order_by` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
+     */
+    order_by: string | null;
     /**
      * Whether it's a shared filter or not
      */
@@ -7839,16 +7924,6 @@ export declare type ItemTypeFilterRelationships = {
         data: ItemTypeData;
     };
 };
-/**
- * JSON API data
- *
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
- * via the `definition` "data".
- */
-export declare type ItemTypeFilterData = {
-    type: ItemTypeFilterType;
-    id: ItemTypeFilterIdentity;
-};
 /**
  * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
  * via the `create.schema` link.
@@ -7862,15 +7937,44 @@ 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: {
+            filter?: {
                 [k: string]: unknown;
             };
+            /**
+             * The columns to show with this filter
+             */
+            columns?: [
+                {
+                    /**
+                     * Can be either the API key of a model's field, or one of the following meta columns: `id`, `_preview`, `_updated_at`, `_created_at`, `_creator`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `position` (only for sortable models), `_stage (only for models associated with a workflow).
+                     */
+                    name: string;
+                    /**
+                     * The percentage width for the column (float, from 0 to 1.0)
+                     */
+                    width: number;
+                },
+                ...{
+                    /**
+                     * Can be either the API key of a model's field, or one of the following meta columns: `id`, `_preview`, `_updated_at`, `_created_at`, `_creator`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `position` (only for sortable models), `_stage (only for models associated with a workflow).
+                     */
+                    name: string;
+                    /**
+                     * The percentage width for the column (float, from 0 to 1.0)
+                     */
+                    width: number;
+                }[]
+            ] | null;
+            /**
+             * The ordering to apply with this filter, or `null` for the default model ordering. It follows the form of the `order_by` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
+             */
+            order_by?: string | null;
             /**
              * Whether it's a shared filter or not
              */
-            shared: boolean;
+            shared?: boolean;
         };
         relationships: {
             /**
@@ -7904,18 +8008,55 @@ export declare type ItemTypeFilterUpdateSchema = {
             /**
              * The name of the filter
              */
-            name: string;
+            name?: string;
+            /**
+             * The columns to show with this filter
+             */
+            columns?: [
+                {
+                    /**
+                     * Can be either the API key of a model's field, or one of the following meta columns: `id`, `_preview`, `_updated_at`, `_created_at`, `_creator`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `position` (only for sortable models), `_stage (only for models associated with a workflow).
+                     */
+                    name: string;
+                    /**
+                     * The percentage width for the column (float, from 0 to 1.0)
+                     */
+                    width: number;
+                },
+                ...{
+                    /**
+                     * Can be either the API key of a model's field, or one of the following meta columns: `id`, `_preview`, `_updated_at`, `_created_at`, `_creator`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `position` (only for sortable models), `_stage (only for models associated with a workflow).
+                     */
+                    name: string;
+                    /**
+                     * The percentage width for the column (float, from 0 to 1.0)
+                     */
+                    width: number;
+                }[]
+            ] | null;
+            /**
+             * The ordering to apply with this filter, or `null` for the default model ordering. It follows the form of the `order_by` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
+             */
+            order_by?: string | null;
             /**
              * Whether it's a shared filter or not
              */
             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: {
+            filter?: {
                 [k: string]: unknown;
             };
         };
+        relationships?: {
+            /**
+             * Model associated with the filter
+             */
+            item_type: {
+                data: ItemTypeData;
+            };
+        };
     };
 };
 /**