@datocms/cma-client 3.1.2 → 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;
 };
 /**
@@ -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
    */
@@ -10064,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
  *
@@ -10537,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
    */
@@ -10663,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;
 };
 
 /**
@@ -10834,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?: {
@@ -10907,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.
  *

package/src/generated/SimpleSchemaTypes.ts

@@ -425,6 +425,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;
 };
 /**
@@ -1397,6 +1405,32 @@ export type SsoSettingsIdentity = string;
  * via the `definition` "type".
  */
 export type SsoSettingsType = 'sso_settings';
+/**
+ * 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 `definition` "type".
+ */
+export type EmojiSuggestionsType = 'emoji_suggestions';
+/**
+ * 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;
+};
 /**
  * ID
  *
@@ -1666,6 +1700,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;
@@ -3703,6 +3738,10 @@ export type SitePlan = {
    * 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
    */
@@ -3937,6 +3976,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
    */
@@ -9674,6 +9717,45 @@ export type SsoSettingsUpdateSchema = {
   default_role?: RoleData;
 };
 
+/**
+ * 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 = {
+  id: EmojiSuggestionsIdentity;
+  type: EmojiSuggestionsType;
+  /**
+   * Emojis connected to a specific term
+   */
+  emojis: string[];
+};
+export type EmojiSuggestionsSelfTargetSchema = EmojiSuggestions;
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type EmojiSuggestionsData = {
+  type: EmojiSuggestionsType;
+  id: EmojiSuggestionsIdentity;
+};
+
+/**
+ * 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[];
+};
+
 /**
  * Represents the white-label settings of the current DatoCMS project
  *
@@ -10157,6 +10239,37 @@ export type Site = {
    * 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
    */
@@ -10248,6 +10361,7 @@ export type SiteActivateImprovedHexManagementTargetSchema = Site;
 export type SiteActivateImprovedGqlMultilocaleFieldsTargetSchema = Site;
 export type SiteActivateImprovedGqlVisibilityControlTargetSchema = Site;
 export type SiteActivateImprovedBooleanFieldsTargetSchema = Site;
+export type SiteUpdateAssetsCdnDefaultSettingsTargetSchema = Site;
 /**
  * Meta attributes
  *
@@ -10275,6 +10389,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;
 };
 
 /**
@@ -10347,6 +10465,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
    */
@@ -10587,6 +10736,49 @@ 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;
+  };
+};
+
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `update_assets_cdn_default_settings.schema` link.
+ */
+export type SiteUpdateAssetsCdnDefaultSettingsSchema = {
+  type?: string;
+  /**
+   * 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;
+    };
   };
 };
 

package/src/generated/resources/EmojiSuggestions.ts

@@ -0,0 +1,46 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class EmojiSuggestions extends BaseResource {
+  static readonly TYPE = 'emoji_suggestions' as const;
+
+  /**
+   * Retrieve emoji suggestions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/emoji-suggestions/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  find(queryParams?: SimpleSchemaTypes.EmojiSuggestionsSelfHrefSchema) {
+    return this.rawFind(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EmojiSuggestionsSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve emoji suggestions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/emoji-suggestions/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawFind(
+    queryParams?: SchemaTypes.EmojiSuggestionsSelfHrefSchema,
+  ): Promise<SchemaTypes.EmojiSuggestionsSelfTargetSchema> {
+    return this.client.request<SchemaTypes.EmojiSuggestionsSelfTargetSchema>({
+      method: 'GET',
+      url: '/emoji-suggestions',
+      queryParams,
+    });
+  }
+}

package/src/generated/resources/Site.ts

@@ -275,4 +275,55 @@ export default class Site extends BaseResource {
       },
     );
   }
+
+  /**
+   * Update CDN settings default assets
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update_assets_cdn_default_settings
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  updateAssetsCdnDefaultSettings(
+    body: SimpleSchemaTypes.SiteUpdateAssetsCdnDefaultSettingsSchema,
+  ) {
+    return this.rawUpdateAssetsCdnDefaultSettings(
+      Utils.serializeRequestBody<SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsSchema>(
+        body,
+        {
+          type: 'assets-cdn-default-settings',
+          attributes: ['assets_cdn_default_settings'],
+          relationships: [],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteUpdateAssetsCdnDefaultSettingsTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update CDN settings default assets
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update_assets_cdn_default_settings
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawUpdateAssetsCdnDefaultSettings(
+    body: SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsSchema,
+  ): Promise<SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsTargetSchema> {
+    return this.client.request<SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsTargetSchema>(
+      {
+        method: 'PUT',
+        url: '/site/assets-cdn-default-settings',
+        body,
+      },
+    );
+  }
 }

package/src/generated/resources/index.ts

@@ -32,6 +32,7 @@ export { default as SiteInvitation } from './SiteInvitation';
 export { default as EditingSession } from './EditingSession';
 export { default as SsoGroup } from './SsoGroup';
 export { default as SsoSettings } from './SsoSettings';
+export { default as EmojiSuggestions } from './EmojiSuggestions';
 export { default as WhiteLabelSettings } from './WhiteLabelSettings';
 export { default as PublicInfo } from './PublicInfo';
 export { default as DailyUsage } from './DailyUsage';