@datocms/cma-client 1.1.1 → 1.1.3

package/src/generated/SimpleSchemaTypes.ts

@@ -307,6 +307,23 @@ export type MenuItemType = 'menu_item';
  * 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.targetSchema` link.
@@ -615,7 +632,7 @@ export 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;
   /**
@@ -1027,6 +1044,10 @@ export 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
      */
@@ -1163,23 +1184,6 @@ export type WebhookCallInstancesHrefSchema = {
  * via the `instances.targetSchema` link.
  */
 export type BuildTriggerInstancesTargetSchema = BuildTrigger[];
-/**
- * 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
- *
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
- * via the `definition` "type".
- */
-export type ItemTypeFilterType = 'item_type_filter';
 /**
  * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
  * via the `instances.targetSchema` link.
@@ -3893,10 +3897,11 @@ export type MenuItem = {
    */
   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;
   item_type: ItemTypeData | null;
+  item_type_filter: ItemTypeFilterData | null;
   parent: null | MenuItemData;
   children: MenuItemData[];
 };
@@ -3915,6 +3920,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
  *
@@ -3946,7 +3962,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;
 };
@@ -3959,6 +3975,7 @@ export type MenuItemAttributes = {
  */
 export type MenuItemRelationships = {
   item_type: ItemTypeData | null;
+  item_type_filter: ItemTypeFilterData | null;
   parent: null | MenuItemData;
   children: MenuItemData[];
 };
@@ -3980,12 +3997,13 @@ 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;
   item_type?: ItemTypeData | null;
+  item_type_filter?: ItemTypeFilterData | null;
   parent?: null | MenuItemData;
 };
 
@@ -4009,10 +4027,11 @@ export type MenuItemUpdateSchema = {
    */
   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;
   item_type?: ItemTypeData | null;
+  item_type_filter?: ItemTypeFilterData | null;
   parent?: null | MenuItemData;
 };
 
@@ -6526,6 +6545,14 @@ export 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
    */
@@ -6618,6 +6645,14 @@ export 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
      */
@@ -6675,6 +6710,14 @@ export 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
      */
@@ -8251,11 +8294,42 @@ export type ItemTypeFilter = {
    */
   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
    */
@@ -8266,17 +8340,6 @@ export type ItemTypeFilterCreateTargetSchema = ItemTypeFilter;
 export type ItemTypeFilterUpdateTargetSchema = ItemTypeFilter;
 export type ItemTypeFilterSelfTargetSchema = ItemTypeFilter;
 export type ItemTypeFilterDestroyTargetSchema = ItemTypeFilter;
-/**
- * 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 attributes
  *
@@ -8289,11 +8352,42 @@ export 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
    */
@@ -8321,15 +8415,46 @@ export 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;
   item_type: ItemTypeData;
 };
 
@@ -8343,17 +8468,49 @@ 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
    */
   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;
   };
+  item_type?: ItemTypeData;
 };
 
 /**

package/src/generated/resources/AccessToken.ts

@@ -10,6 +10,9 @@ export default class AccessToken extends BaseResource {
    * Create a new API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   create(body: SimpleSchemaTypes.AccessTokenCreateSchema) {
     return this.rawCreate(
@@ -34,6 +37,9 @@ export default class AccessToken extends BaseResource {
    * Create a new API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawCreate(
     body: SchemaTypes.AccessTokenCreateSchema,
@@ -49,6 +55,9 @@ export default class AccessToken extends BaseResource {
    * Update an API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   update(
     accessTokenId: string | SimpleSchemaTypes.AccessTokenData,
@@ -78,6 +87,9 @@ export default class AccessToken extends BaseResource {
    * Update an API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawUpdate(
     accessTokenId: string,
@@ -94,6 +106,9 @@ export default class AccessToken extends BaseResource {
    * List all API tokens
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   list() {
     return this.rawList().then((body) =>
@@ -107,6 +122,9 @@ export default class AccessToken extends BaseResource {
    * List all API tokens
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawList(): Promise<SchemaTypes.AccessTokenInstancesTargetSchema> {
     return this.client.request<SchemaTypes.AccessTokenInstancesTargetSchema>({
@@ -119,6 +137,9 @@ export default class AccessToken extends BaseResource {
    * Retrieve an API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   find(accessTokenId: string | SimpleSchemaTypes.AccessTokenData) {
     return this.rawFind(Utils.toId(accessTokenId)).then((body) =>
@@ -132,6 +153,9 @@ export default class AccessToken extends BaseResource {
    * Retrieve an API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawFind(
     accessTokenId: string,
@@ -146,6 +170,9 @@ export default class AccessToken extends BaseResource {
    * Rotate API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   regenerateToken(accessTokenId: string | SimpleSchemaTypes.AccessTokenData) {
     return this.rawRegenerateToken(Utils.toId(accessTokenId)).then((body) =>
@@ -159,6 +186,9 @@ export default class AccessToken extends BaseResource {
    * Rotate API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawRegenerateToken(
     accessTokenId: string,
@@ -175,6 +205,9 @@ export default class AccessToken extends BaseResource {
    * Delete an API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   destroy(
     accessTokenId: string | SimpleSchemaTypes.AccessTokenData,
@@ -192,6 +225,9 @@ export default class AccessToken extends BaseResource {
    * Delete an API token
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawDestroy(
     accessTokenId: string,

package/src/generated/resources/AuditLogEvent.ts

@@ -10,6 +10,9 @@ export default class AuditLogEvent extends BaseResource {
    * List Audit Log events
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   query(body: SimpleSchemaTypes.AuditLogEventQuerySchema) {
     return this.rawQuery(
@@ -29,6 +32,9 @@ export default class AuditLogEvent extends BaseResource {
    * List Audit Log events
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawQuery(
     body: SchemaTypes.AuditLogEventQuerySchema,

package/src/generated/resources/BuildEvent.ts

@@ -10,6 +10,9 @@ export default class BuildEvent extends BaseResource {
    * List all deploy events
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   list() {
     return this.rawList().then((body) =>
@@ -23,6 +26,9 @@ export default class BuildEvent extends BaseResource {
    * List all deploy events
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawList(): Promise<SchemaTypes.BuildEventInstancesTargetSchema> {
     return this.client.request<SchemaTypes.BuildEventInstancesTargetSchema>({
@@ -35,6 +41,9 @@ export default class BuildEvent extends BaseResource {
    * Retrieve a deploy event
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   find(buildEventId: string | SimpleSchemaTypes.BuildEventData) {
     return this.rawFind(Utils.toId(buildEventId)).then((body) =>
@@ -48,6 +57,9 @@ export default class BuildEvent extends BaseResource {
    * Retrieve a deploy event
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawFind(
     buildEventId: string,