@datocms/cma-client 1.1.2 → 1.1.4

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.
@@ -953,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
  *
@@ -3080,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;
 };
@@ -3092,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
      */
@@ -3120,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
  *
@@ -3152,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
              */
@@ -3196,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
              */
@@ -3204,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
              */
@@ -4067,9 +4095,9 @@ export declare type ItemTypeDestroyJobSchema = {
  *
  * Only accept assets with specific file extensions.
  *
- * | Parameter         | Type                                      | Required | Description                    |
- * | ----------------- | ----------------------------------------- | -------- | ------------------------------ |
- * | `extensions`      | `Array<String>`                           |          | Set of allowed file extensions |
+ * | Parameter         | Type                                                               | Required | Description                    |
+ * | ----------------- | ------------------------------------------------------------------ | -------- | ------------------------------ |
+ * | `extensions`      | `Array<String>`                                                    |          | Set of allowed file extensions |
  * | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` |          | Allowed file type              |
  *
  * Only one of the parameters must be specified.
@@ -4512,13 +4540,14 @@ export declare type ItemTypeDestroyJobSchema = {
  *
  * Built-in editor for _Structured text_ fields.
  *
- * | Parameter                 | Type            | Required | Description                                                                                                                                   |
- * | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `nodes`                   | `Array<String>` | ✅       | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"`        |
- * | `marks`                   | `Array<String>` | ✅       | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
- * | `blocks_start_collapsed`  | `Boolean`       |          | Whether you want block nodes collapsed by default or not                                                                                      |
- * | `show_links_target_blank` | `Boolean`       |          | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links           |
- * | `show_links_meta_editor`  | `Boolean`       |          | Whether you want to show the complete meta editor for links                                                                                   |
+ * | Parameter                 | Type             | Required | Description                                                                                                                                   |
+ * | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `nodes`                   | `Array<String>`  | ✅       | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"`        |
+ * | `marks`                   | `Array<String>`  | ✅       | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
+ * | `heading_levels`          | `Array<Integer>` | ✅       | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6                   |
+ * | `blocks_start_collapsed`  | `Boolean`        |          | Whether you want block nodes collapsed by default or not                                                                                      |
+ * | `show_links_target_blank` | `Boolean`        |          | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links           |
+ * | `show_links_meta_editor`  | `Boolean`        |          | Whether you want to show the complete meta editor for links                                                                                   |
  *
  * </details>
  *
@@ -7848,6 +7877,35 @@ export declare type ItemTypeFilterAttributes = {
     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
      */
@@ -7867,16 +7925,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.
@@ -7892,13 +7940,42 @@ export declare type ItemTypeFilterCreateSchema = {
             /**
              * 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: {
             /**
@@ -7932,7 +8009,36 @@ 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
              */
@@ -7940,10 +8046,18 @@ export declare type ItemTypeFilterUpdateSchema = {
             /**
              * 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;
+            };
+        };
     };
 };
 /**