@datocms/cma-client 3.1.1 → 3.1.3

package/src/generated/SchemaTypes.ts

@@ -380,6 +380,14 @@ export type ItemTypeCreateHrefSchema = {
    * Skip the creation of a menu item linked to the model
    */
   skip_menu_item_creation?: boolean;
+  /**
+   * Explicitely specify the ID of the menu item that will be linked to the model
+   */
+  menu_item_id?: string;
+  /**
+   * Explicitely specify the ID of the schema menu item that will be linked to the model
+   */
+  schema_menu_item_id?: string;
   [k: string]: unknown;
 };
 /**
@@ -509,7 +517,7 @@ export type BuildTriggerType = 'build_trigger';
  */
 export type ItemInstancesHrefSchema = {
   /**
-   * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
+   * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
    */
   nested?: boolean;
   /**
@@ -574,7 +582,7 @@ export type ItemInstancesHrefSchema = {
  */
 export type ItemReferencesHrefSchema = {
   /**
-   * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
+   * For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
    */
   nested?: boolean;
   /**
@@ -589,7 +597,7 @@ export type ItemReferencesHrefSchema = {
  */
 export type ItemSelfHrefSchema = {
   /**
-   * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
+   * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
    */
   nested?: boolean;
   /**
@@ -664,7 +672,7 @@ export type ItemVersionIdentity = string;
  */
 export type ItemVersionInstancesHrefSchema = {
   /**
-   * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
+   * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
    */
   nested?: boolean;
   /**
@@ -864,7 +872,7 @@ export type UploadBatchDestroyHrefSchema = {
  */
 export type UploadReferencesHrefSchema = {
   /**
-   * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
+   * For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
    */
   nested?: boolean;
   /**
@@ -1122,6 +1130,32 @@ export type SsoSettingsType = 'sso_settings';
  * via the `definition` "id".
  */
 export type SsoSettingsIdentity = string;
+/**
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type EmojiSuggestionsType = 'emoji_suggestions';
+/**
+ * ID
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type EmojiSuggestionsIdentity = string;
+/**
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type EmojiSuggestionsSelfHrefSchema = {
+  /**
+   * The term for which we are seeking suggestions for emojis
+   */
+  term?: string;
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema
  * via the `definition` "type".
@@ -1371,6 +1405,7 @@ export type DatoApi = {
   form_data?: FormData;
   sso_group?: SsoGroup;
   sso_settings?: SsoSettings;
+  emoji_suggestions?: EmojiSuggestions;
   white_label_settings?: WhiteLabelSettings;
   public_info?: PublicInfo;
   daily_usage?: DailyUsage;
@@ -3306,6 +3341,10 @@ export type SitePlanAttributes = {
    * Maximum size in bytes for a single file upload
    */
   maximum_single_upload_bytes: number;
+  /**
+   * Maximum size (in bytes) for a record, including its block records
+   */
+  item_byte_size: number;
   /**
    * Available extra packets
    */
@@ -4645,6 +4684,18 @@ export type ItemTypeDestroyJobSchema = {
  * </details>
  *
  * <details>
+ * <summary>Single Block (<code>single_block</code>)</summary>
+ *
+ * | Property                       | Value                                           |
+ * | ------------------------------ | ----------------------------------------------- |
+ * | Code                           | `single_block`                                  |
+ * | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
+ * | Required validators            | `single_block_blocks`                           |
+ * | Other validators available     | `required`                                      |
+ *
+ * </details>
+ *
+ * <details>
  * <summary>Structured text (<code>structured_text</code>)</summary>
  *
  * | Property                       | Value                                             |
@@ -4946,6 +4997,17 @@ export type ItemTypeDestroyJobSchema = {
  *
  * Only accept references to block records of the specified block models.
  *
+ * | Parameter    | Type                    | Required | Description                     |
+ * | ------------ | ----------------------- | -------- | ------------------------------ |
+ * | `item_types` | `Array<Block Model ID>` | ✅        | Set of allowed Block Model IDs |
+ *
+ * </details>
+ *
+ * <details>
+ * <summary><code>single_block_blocks</code></summary>
+ *
+ * Only accept references to block records of the specified block models.
+ *
  * | Parameter    | Type                    | Required | Description                    |
  * | ------------ | ----------------------- | -------- | ------------------------------ |
  * | `item_types` | `Array<Block Model ID>` | ✅        | Set of allowed Block Model IDs |
@@ -5165,10 +5227,10 @@ export type ItemTypeDestroyJobSchema = {
  *
  * Built-in editor for _seo_ fields.
  *
- * | Parameter  | Type            | Required | Description                                                                                                                                             |
- * | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `fields`   | `Array<String>` | ✅        | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
- * | `previews` | `Array<String>` | ✅        | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`  |
+ * | Parameter  | Type            | Required | Description                                                                                                                                                          |
+ * | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `fields`   | `Array<String>` | ✅        | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`              |
+ * | `previews` | `Array<String>` | ✅        | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
  *
  * </details>
  *
@@ -5184,6 +5246,17 @@ export type ItemTypeDestroyJobSchema = {
  * </details>
  *
  * <details>
+ * <summary><code>framed_single_block</code></summary>
+ *
+ * Built-in editor for _Single block_ fields.
+ *
+ * | Parameter         | Type      | Required | Description                                                |
+ * | ----------------- | --------- | -------- | ---------------------------------------------------------- |
+ * | `start_collapsed` | `Boolean` |          | Whether you want block record collapsed by default or not |
+ *
+ * </details>
+ *
+ * <details>
  * <summary><code>structured_text</code></summary>
  *
  * Built-in editor for _Structured text_ fields.
@@ -5239,25 +5312,26 @@ export type FieldAttributes = {
    * Type of input
    */
   field_type:
-    | 'string'
-    | 'text'
     | 'boolean'
-    | 'integer'
-    | 'float'
+    | 'color'
     | 'date'
     | 'date_time'
-    | 'color'
-    | 'json'
-    | 'lat_lon'
-    | 'seo'
-    | 'slug'
-    | 'video'
     | 'file'
+    | 'float'
     | 'gallery'
+    | 'integer'
+    | 'json'
+    | 'lat_lon'
     | 'link'
     | 'links'
     | 'rich_text'
-    | 'structured_text';
+    | 'seo'
+    | 'single_block'
+    | 'slug'
+    | 'string'
+    | 'structured_text'
+    | 'text'
+    | 'video';
   /**
    * Whether the field needs to be multilanguage or not
    */
@@ -5385,25 +5459,26 @@ export type FieldCreateSchema = {
        * Type of input
        */
       field_type:
-        | 'string'
-        | 'text'
         | 'boolean'
-        | 'integer'
-        | 'float'
+        | 'color'
         | 'date'
         | 'date_time'
-        | 'color'
-        | 'json'
-        | 'lat_lon'
-        | 'seo'
-        | 'slug'
-        | 'video'
         | 'file'
+        | 'float'
         | 'gallery'
+        | 'integer'
+        | 'json'
+        | 'lat_lon'
         | 'link'
         | 'links'
         | 'rich_text'
-        | 'structured_text';
+        | 'seo'
+        | 'single_block'
+        | 'slug'
+        | 'string'
+        | 'structured_text'
+        | 'text'
+        | 'video';
       /**
        * Field API key
        */
@@ -5613,25 +5688,26 @@ export type FieldUpdateSchema = {
        * Type of input
        */
       field_type?:
-        | 'string'
-        | 'text'
         | 'boolean'
-        | 'integer'
-        | 'float'
+        | 'color'
         | 'date'
         | 'date_time'
-        | 'color'
-        | 'json'
-        | 'lat_lon'
-        | 'seo'
-        | 'slug'
-        | 'video'
         | 'file'
+        | 'float'
         | 'gallery'
+        | 'integer'
+        | 'json'
+        | 'lat_lon'
         | 'link'
         | 'links'
         | 'rich_text'
-        | 'structured_text';
+        | 'seo'
+        | 'single_block'
+        | 'slug'
+        | 'string'
+        | 'structured_text'
+        | 'text'
+        | 'video';
       /**
        * Field hint
        */
@@ -10027,6 +10103,50 @@ export type SsoSettingsUpdateTargetSchema = {
   data: SsoSettings;
 };
 
+/**
+ * The entity suggests several emojis that are connected to a specific term
+ *
+ * This interface was referenced by `DatoApi`'s JSON-Schema
+ * via the `definition` "emoji_suggestions".
+ */
+export type EmojiSuggestions = {
+  type: EmojiSuggestionsType;
+  id: EmojiSuggestionsIdentity;
+  attributes: EmojiSuggestionsAttributes;
+};
+
+/**
+ * JSON API attributes
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "attributes".
+ */
+export type EmojiSuggestionsAttributes = {
+  /**
+   * Emojis connected to a specific term
+   */
+  emojis: string[];
+};
+
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type EmojiSuggestionsData = {
+  type: EmojiSuggestionsType;
+  id: EmojiSuggestionsIdentity;
+};
+
+/**
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `self.targetSchema` link.
+ */
+export type EmojiSuggestionsSelfTargetSchema = {
+  data: EmojiSuggestions;
+};
+
 /**
  * Represents the white-label settings of the current DatoCMS project
  *
@@ -10500,6 +10620,37 @@ export type SiteAttributes = {
    * If enabled, blocks schema changes of primary environment
    */
   force_use_of_sandbox_environments: boolean;
+  /**
+   * Allows setting default parameters for assets served through the CDN
+   */
+  assets_cdn_default_settings: {
+    /**
+     * Allows setting default parameters for optimizing images served by the CDN
+     */
+    image: {
+      /**
+       * Controls the output quality of lossy file formats (jpg, pjpg, webp, avif, or jxr). Valid values are in the range 0 – 100 and the default is 75.
+       */
+      q?: number;
+      /**
+       * The auto parameter helps automating a baseline level of optimization. Specify one or more settings
+       */
+      auto?: ('compress' | 'format' | 'enhance' | 'true' | 'redeye')[];
+      /**
+       * Specifies the color space of the output image
+       */
+      cs?: 'srgb' | 'adobergb1998' | 'tinysrgb' | 'strip';
+    };
+    /**
+     * Allows setting default parameters for optimizing videos served by the CDN
+     */
+    video: {
+      /**
+       * When true, attempting to retrieve raw video files directly instead of their optimized counterparts will result in a HTTP 422 status code
+       */
+      disable_serving_raw_videos?: boolean;
+    };
+  };
   /**
    * Specifies the theme to use in administrative area
    */
@@ -10626,6 +10777,10 @@ export type SiteMeta = {
    * Whether the Improved boolean fields option is active or not
    */
   improved_boolean_fields: boolean;
+  /**
+   * Whether the site has custom upload storage settings
+   */
+  custom_upload_storage_settings?: boolean;
 };
 
 /**
@@ -10797,6 +10952,10 @@ export type SiteUpdateSchema = {
        * Whether the Improved boolean fields option is active or not
        */
       improved_boolean_fields?: boolean;
+      /**
+       * Whether the site has custom upload storage settings
+       */
+      custom_upload_storage_settings?: boolean;
     };
     relationships?: {
       sso_default_role?: {
@@ -10870,6 +11029,57 @@ export type SiteActivateImprovedBooleanFieldsTargetSchema = {
   data: Site;
 };
 
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `update_assets_cdn_default_settings.schema` link.
+ */
+export type SiteUpdateAssetsCdnDefaultSettingsSchema = {
+  data: {
+    type: string;
+    attributes: {
+      /**
+       * Allows setting default parameters for assets served through the CDN
+       */
+      assets_cdn_default_settings: {
+        /**
+         * Allows setting default parameters for optimizing images served by the CDN
+         */
+        image: {
+          /**
+           * Controls the output quality of lossy file formats (jpg, pjpg, webp, avif, or jxr). Valid values are in the range 0 – 100 and the default is 75.
+           */
+          q?: number;
+          /**
+           * The auto parameter helps automating a baseline level of optimization. Specify one or more settings
+           */
+          auto?: ('compress' | 'format' | 'enhance' | 'true' | 'redeye')[];
+          /**
+           * Specifies the color space of the output image
+           */
+          cs?: 'srgb' | 'adobergb1998' | 'tinysrgb' | 'strip';
+        };
+        /**
+         * Allows setting default parameters for optimizing videos served by the CDN
+         */
+        video: {
+          /**
+           * When true, attempting to retrieve raw video files directly instead of their optimized counterparts will result in a HTTP 422 status code
+           */
+          disable_serving_raw_videos?: boolean;
+        };
+      };
+    };
+  };
+};
+
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `update_assets_cdn_default_settings.targetSchema` link.
+ */
+export type SiteUpdateAssetsCdnDefaultSettingsTargetSchema = {
+  data: Site;
+};
+
 /**
  * Through workflows it is possible to set up a precise state machine able to bring a draft content up to the final publication (and beyond), through a series of intermediate, fully customizable approval steps.
  *