@datocms/cma-client 1.1.2 → 1.1.4

package/src/generated/SchemaTypes.ts

@@ -272,6 +272,23 @@ export type MenuItemIdentity = string;
  * via the `definition` "type".
  */
 export type ItemTypeType = 'item_type';
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export 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 type ItemTypeFilterIdentity = string;
 /**
  * This interface was referenced by `MenuItem`'s JSON-Schema
  * via the `instances.hrefSchema` link.
@@ -957,23 +974,6 @@ export type WebhookCallInstancesHrefSchema = {
   };
   [k: string]: unknown;
 };
-/**
- * JSON API type field
- *
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
- * via the `definition` "type".
- */
-export 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 type ItemTypeFilterIdentity = string;
 /**
  * JSON API type field
  *
@@ -3299,7 +3299,7 @@ export 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;
 };
@@ -3312,11 +3312,17 @@ export type MenuItemAttributes = {
  */
 export 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
    */
@@ -3342,6 +3348,17 @@ export type ItemTypeData = {
   id: ItemTypeIdentity;
 };
 
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type ItemTypeFilterData = {
+  type: ItemTypeFilterType;
+  id: ItemTypeFilterIdentity;
+};
+
 /**
  * JSON API data
  *
@@ -3375,19 +3392,25 @@ export 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
        */
@@ -3421,7 +3444,7 @@ export type MenuItemUpdateSchema = {
       /**
        * The label of the menu item
        */
-      label: string;
+      label?: string;
       /**
        * The URL to which the menu item points to
        */
@@ -3429,19 +3452,25 @@ export 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
        */
@@ -4331,9 +4360,9 @@ export 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.
@@ -4776,13 +4805,14 @@ export 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>
  *
@@ -8375,6 +8405,37 @@ export 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
    */
@@ -8396,17 +8457,6 @@ export type ItemTypeFilterRelationships = {
   };
 };
 
-/**
- * JSON API data
- *
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
- * via the `definition` "data".
- */
-export type ItemTypeFilterData = {
-  type: ItemTypeFilterType;
-  id: ItemTypeFilterIdentity;
-};
-
 /**
  * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
  * via the `create.schema` link.
@@ -8422,13 +8472,44 @@ export 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: {
       /**
@@ -8464,7 +8545,38 @@ export 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
        */
@@ -8472,10 +8584,18 @@ export 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;
+      };
+    };
   };
 };