@datocms/cma-client 3.3.5 → 3.3.8

package/dist/types/generated/SimpleSchemaTypes.d.ts

@@ -364,6 +364,40 @@ export type SchemaMenuItemInstancesHrefSchema = {
         ids: string;
     };
 };
+/**
+ * RFC 4122 UUID of upload collection expressed in URL-safe base64 format
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type UploadCollectionIdentity = string;
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type UploadCollectionType = 'upload_collection';
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `instances.targetSchema` link.
+ */
+export type UploadCollectionInstancesTargetSchema = UploadCollection[];
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type UploadCollectionInstancesHrefSchema = {
+    filter?: {
+        /**
+         * IDs to fetch, comma separated
+         */
+        ids: string;
+    };
+};
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `definition` "type".
@@ -662,7 +696,6 @@ export type ItemInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 30, maximum is 500)
          */
         limit?: number;
-        [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>_(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.
@@ -916,7 +949,6 @@ export type ItemVersionInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 15, maximum is 50)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -985,7 +1017,6 @@ export type UploadInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 30, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -1046,6 +1077,11 @@ export type UploadReferencesHrefSchema = {
  * via the `bulk_tag.jobSchema` link.
  */
 export type UploadBulkTagJobSchema = unknown[];
+/**
+ * This interface was referenced by `Upload`'s JSON-Schema
+ * via the `bulk_set_upload_collection.jobSchema` link.
+ */
+export type UploadBulkSetUploadCollectionJobSchema = unknown[];
 /**
  * This interface was referenced by `Upload`'s JSON-Schema
  * via the `bulk_destroy.jobSchema` link.
@@ -1123,7 +1159,6 @@ export type SearchResultInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 20, maximum is 100)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     /**
      * Attributes to filter search results
@@ -1271,8 +1306,55 @@ export type WebhookCallInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 30, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
+    /**
+     * Attributes to filter
+     */
+    filter?: {
+        /**
+         * IDs to fetch, comma separated
+         */
+        ids?: string;
+        fields?: {
+            webhook_id?: {
+                eq?: string;
+            };
+            entity_type?: {
+                /**
+                 * The subject of webhook triggering
+                 */
+                eq?: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+            };
+            event_type?: {
+                /**
+                 * The event that triggers the webhook call
+                 */
+                eq?: 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate';
+            };
+            status?: {
+                /**
+                 * The current status
+                 */
+                eq?: 'pending' | 'success' | 'failed' | 'rescheduled';
+            };
+            last_sent_at?: {
+                gt?: string;
+                lt?: string;
+            };
+            next_retry_at?: {
+                gt?: string;
+                lt?: string;
+            };
+            created_at?: {
+                gt?: string;
+                lt?: string;
+            };
+        };
+    };
+    /**
+     * Fields used to order results
+     */
+    order_by?: 'webhook_id_asc' | 'webhook_id_desc' | 'created_at_asc' | 'created_at_desc' | 'last_sent_at_asc' | 'last_sent_at_desc' | 'next_retry_at_asc' | 'next_retry_at_desc';
     [k: string]: unknown;
 };
 /**
@@ -1561,7 +1643,6 @@ export type UploadTagInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 50, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -1612,7 +1693,6 @@ export type UploadSmartTagInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 50, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -1657,6 +1737,7 @@ export type DatoApi = {
     site_plan?: SitePlan;
     menu_item?: MenuItem;
     schema_menu_item?: SchemaMenuItem;
+    upload_collection?: UploadCollection;
     item_type?: ItemType;
     field?: Field;
     fieldset?: Fieldset;
@@ -1748,7 +1829,11 @@ export type Role = {
     /**
      * Can create/edit shared filters (both for models and the media area)
      */
-    can_manage_shared_filters?: boolean;
+    can_manage_shared_filters: boolean;
+    /**
+     * Can create/edit upload collections
+     */
+    can_manage_upload_collections: boolean;
     /**
      * Can create/edit Build triggers
      */
@@ -1956,7 +2041,11 @@ export type RoleMeta = {
         /**
          * Can create/edit shared filters (both for models and the media area)
          */
-        can_manage_shared_filters?: boolean;
+        can_manage_shared_filters: boolean;
+        /**
+         * Can create/edit upload collections
+         */
+        can_manage_upload_collections: boolean;
         /**
          * Can create/edit Build triggers
          */
@@ -2149,7 +2238,11 @@ export type RoleAttributes = {
     /**
      * Can create/edit shared filters (both for models and the media area)
      */
-    can_manage_shared_filters?: boolean;
+    can_manage_shared_filters: boolean;
+    /**
+     * Can create/edit upload collections
+     */
+    can_manage_upload_collections: boolean;
     /**
      * Can create/edit Build triggers
      */
@@ -2350,6 +2443,10 @@ export type RoleCreateSchema = {
      * Can create/edit shared filters (both for models and the media area)
      */
     can_manage_shared_filters?: boolean;
+    /**
+     * Can create/edit upload collections
+     */
+    can_manage_upload_collections?: boolean;
     /**
      * Can create/edit Build triggers
      */
@@ -2544,6 +2641,10 @@ export type RoleUpdateSchema = {
      * Can create/edit shared filters (both for models and the media area)
      */
     can_manage_shared_filters?: boolean;
+    /**
+     * Can create/edit upload collections
+     */
+    can_manage_upload_collections?: boolean;
     /**
      * Can create/edit Build triggers
      */
@@ -4088,6 +4189,101 @@ export type SchemaMenuItemUpdateSchema = {
     parent?: null | SchemaMenuItemData;
     children?: SchemaMenuItemData[];
 };
+/**
+ * In DatoCMS you can organize the uploads present in your administrative area in collection, so that the final editors can easily navigate uploads.
+ *
+ * This interface was referenced by `DatoApi`'s JSON-Schema
+ * via the `definition` "upload_collection".
+ */
+export type UploadCollection = {
+    id: UploadCollectionIdentity;
+    type: UploadCollectionType;
+    /**
+     * The label of the upload collection
+     */
+    label: string;
+    /**
+     * Ordering index
+     */
+    position: number;
+    parent: null | UploadCollectionData;
+    children: UploadCollectionData[];
+};
+export type UploadCollectionCreateTargetSchema = UploadCollection;
+export type UploadCollectionUpdateTargetSchema = UploadCollection;
+export type UploadCollectionSelfTargetSchema = UploadCollection;
+export type UploadCollectionDestroyTargetSchema = UploadCollection;
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type UploadCollectionData = {
+    type: UploadCollectionType;
+    id: UploadCollectionIdentity;
+};
+/**
+ * JSON API attributes
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "attributes".
+ */
+export type UploadCollectionAttributes = {
+    /**
+     * The label of the upload collection
+     */
+    label: string;
+    /**
+     * Ordering index
+     */
+    position: number;
+};
+/**
+ * JSON API links
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "relationships".
+ */
+export type UploadCollectionRelationships = {
+    parent: null | UploadCollectionData;
+    children: UploadCollectionData[];
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `create.schema` link.
+ */
+export type UploadCollectionCreateSchema = {
+    id?: UploadCollectionIdentity;
+    type?: UploadCollectionType;
+    /**
+     * The label of the upload collection
+     */
+    label: string;
+    /**
+     * Ordering index
+     */
+    position?: number;
+    parent?: null | UploadCollectionData;
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `update.schema` link.
+ */
+export type UploadCollectionUpdateSchema = {
+    id?: UploadCollectionIdentity;
+    type?: UploadCollectionType;
+    /**
+     * The label of the upload collection
+     */
+    label?: string;
+    /**
+     * Ordering index
+     */
+    position?: number;
+    parent?: null | UploadCollectionData;
+    children?: UploadCollectionData[];
+};
 /**
  * The way you define the kind of content you can edit inside your administrative area passes through the concept of Models, which are much like database tables. For backward-compatibility reasons, the API refers to models as "item types".
  *
@@ -4521,6 +4717,9 @@ export type ItemTypeUpdateSchema = {
  * via the `bulk_tag.targetSchema` link.
  *
  * This interface was referenced by `Upload`'s JSON-Schema
+ * via the `bulk_set_upload_collection.targetSchema` link.
+ *
+ * This interface was referenced by `Upload`'s JSON-Schema
  * via the `bulk_destroy.targetSchema` link.
  *
  * This interface was referenced by `UploadTrack`'s JSON-Schema
@@ -4566,6 +4765,7 @@ export type UploadUpdateTargetSchema = Job;
 export type UploadBatchAddTagsTargetSchema = Job;
 export type UploadBatchDestroyTargetSchema = Job;
 export type UploadBulkTagTargetSchema = Job;
+export type UploadBulkSetUploadCollectionTargetSchema = Job;
 export type UploadBulkDestroyTargetSchema = Job;
 export type UploadTrackCreateTargetSchema = Job;
 export type UploadTrackDestroyTargetSchema = Job;
@@ -7152,6 +7352,7 @@ export type Upload = {
          */
         alpha: number;
     }[];
+    upload_collection: UploadCollectionData | null;
     creator: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
 };
 export type UploadCreateJobSchema = Upload;
@@ -7344,6 +7545,7 @@ export type UploadAttributes = {
  * via the `definition` "relationships".
  */
 export type UploadRelationships = {
+    upload_collection: UploadCollectionData | null;
     creator: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
 };
 /**
@@ -7411,6 +7613,7 @@ export type UploadCreateSchema = {
      * Tags
      */
     tags?: string[];
+    upload_collection?: UploadCollectionData | null;
 };
 /**
  * This interface was referenced by `Upload`'s JSON-Schema
@@ -7482,6 +7685,7 @@ export type UploadUpdateSchema = {
         };
     };
     creator?: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
+    upload_collection?: UploadCollectionData | null;
 };
 /**
  * This interface was referenced by `Upload`'s JSON-Schema
@@ -7506,6 +7710,15 @@ export type UploadBulkTagSchema = {
     tags: string[];
     uploads: UploadData[];
 };
+/**
+ * This interface was referenced by `Upload`'s JSON-Schema
+ * via the `bulk_set_upload_collection.schema` link.
+ */
+export type UploadBulkSetUploadCollectionSchema = {
+    type?: 'upload_bulk_set_upload_collection_operation';
+    upload_collection: null | UploadCollectionData;
+    uploads: UploadData[];
+};
 /**
  * This interface was referenced by `Upload`'s JSON-Schema
  * via the `bulk_destroy.schema` link.
@@ -8087,12 +8300,19 @@ export type Webhook = {
      * Additional headers that will be sent
      */
     headers: {
-        [k: string]: unknown;
+        [k: string]: string;
     };
-    /**
-     * All the events you will be notified for
-     */
-    events: unknown[];
+    events: {
+        /**
+         * The subject of webhook triggering
+         */
+        entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+        event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
+        filters?: {
+            entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
+            entity_ids: [string, ...string[]];
+        }[] | null;
+    }[];
     /**
      * Specifies which API version to use when serializing entities in the webhook payload
      */
@@ -8101,6 +8321,10 @@ export type Webhook = {
      * Whether the you want records present in the payload to show blocks expanded or not
      */
     nested_items_in_payload: boolean;
+    /**
+     * If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
+     */
+    auto_retry: boolean;
 };
 export type WebhookCreateTargetSchema = Webhook;
 export type WebhookUpdateTargetSchema = Webhook;
@@ -8151,12 +8375,19 @@ export type WebhookAttributes = {
      * Additional headers that will be sent
      */
     headers: {
-        [k: string]: unknown;
+        [k: string]: string;
     };
-    /**
-     * All the events you will be notified for
-     */
-    events: unknown[];
+    events: {
+        /**
+         * The subject of webhook triggering
+         */
+        entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+        event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
+        filters?: {
+            entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
+            entity_ids: [string, ...string[]];
+        }[] | null;
+    }[];
     /**
      * Specifies which API version to use when serializing entities in the webhook payload
      */
@@ -8165,6 +8396,10 @@ export type WebhookAttributes = {
      * Whether the you want records present in the payload to show blocks expanded or not
      */
     nested_items_in_payload: boolean;
+    /**
+     * If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
+     */
+    auto_retry: boolean;
 };
 /**
  * This interface was referenced by `Webhook`'s JSON-Schema
@@ -8188,12 +8423,19 @@ export type WebhookCreateSchema = {
      * Additional headers that will be sent
      */
     headers: {
-        [k: string]: unknown;
+        [k: string]: string;
     };
-    /**
-     * All the events you will be notified for
-     */
-    events: unknown[];
+    events: {
+        /**
+         * The subject of webhook triggering
+         */
+        entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+        event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
+        filters?: {
+            entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
+            entity_ids: [string, ...string[]];
+        }[] | null;
+    }[];
     /**
      * HTTP Basic Authorization username
      */
@@ -8214,6 +8456,10 @@ export type WebhookCreateSchema = {
      * Whether the you want records present in the payload to show blocks expanded or not
      */
     nested_items_in_payload?: boolean;
+    /**
+     * If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
+     */
+    auto_retry?: boolean;
 };
 /**
  * This interface was referenced by `Webhook`'s JSON-Schema
@@ -8238,12 +8484,19 @@ export type WebhookUpdateSchema = {
      * Additional headers that will be sent
      */
     headers?: {
-        [k: string]: unknown;
+        [k: string]: string;
     };
-    /**
-     * All the events you will be notified for
-     */
-    events?: unknown[];
+    events?: {
+        /**
+         * The subject of webhook triggering
+         */
+        entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+        event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
+        filters?: {
+            entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
+            entity_ids: [string, ...string[]];
+        }[] | null;
+    }[];
     /**
      * HTTP Basic Authorization username
      */
@@ -8264,9 +8517,13 @@ export type WebhookUpdateSchema = {
      * Whether the you want records present in the payload to show blocks expanded or not
      */
     nested_items_in_payload?: boolean;
+    /**
+     * If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
+     */
+    auto_retry?: boolean;
 };
 /**
- * Represents a log entry in the webhooks activity list.
+ * This represents a log entry in the webhooks activity list, detailing a specific webhook event along with its delivery attempt information.
  *
  * This interface was referenced by `DatoApi`'s JSON-Schema
  * via the `definition` "webhook_call".
@@ -8277,13 +8534,13 @@ export type WebhookCall = {
     /**
      * The subject of webhook triggering
      */
-    entity_type: 'item' | 'item_type' | 'upload';
+    entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
     /**
      * The event that triggers the webhook call
      */
-    event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish';
+    event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate';
     /**
-     * The moment the call occurred
+     * The moment the event was created
      */
     created_at: string;
     /**
@@ -8309,13 +8566,30 @@ export type WebhookCall = {
      */
     response_headers: {
         [k: string]: unknown;
-    };
+    } | null;
     /**
      * The body of the response
      */
     response_payload: string | null;
+    /**
+     * The number of retries attempted so far
+     */
+    attempted_auto_retries_count: number;
+    /**
+     * The last moment the call occurred
+     */
+    last_sent_at: string;
+    /**
+     * The date when the next retry attempt is scheduled to run. If no retry attempt is scheduled, it is set to null
+     */
+    next_retry_at: string | null;
+    /**
+     * The current status
+     */
+    status: 'pending' | 'success' | 'failed' | 'rescheduled';
     webhook: WebhookData;
 };
+export type WebhookCallSelfTargetSchema = WebhookCall;
 /**
  * JSON API data
  *
@@ -8336,13 +8610,13 @@ export type WebhookCallAttributes = {
     /**
      * The subject of webhook triggering
      */
-    entity_type: 'item' | 'item_type' | 'upload';
+    entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
     /**
      * The event that triggers the webhook call
      */
-    event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish';
+    event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate';
     /**
-     * The moment the call occurred
+     * The moment the event was created
      */
     created_at: string;
     /**
@@ -8368,11 +8642,27 @@ export type WebhookCallAttributes = {
      */
     response_headers: {
         [k: string]: unknown;
-    };
+    } | null;
     /**
      * The body of the response
      */
     response_payload: string | null;
+    /**
+     * The number of retries attempted so far
+     */
+    attempted_auto_retries_count: number;
+    /**
+     * The last moment the call occurred
+     */
+    last_sent_at: string;
+    /**
+     * The date when the next retry attempt is scheduled to run. If no retry attempt is scheduled, it is set to null
+     */
+    next_retry_at: string | null;
+    /**
+     * The current status
+     */
+    status: 'pending' | 'success' | 'failed' | 'rescheduled';
 };
 /**
  * JSON API links

package/dist/types/generated/resources/Upload.d.ts

@@ -192,6 +192,24 @@ export default class Upload extends BaseResource {
      * @throws {TimeoutError}
      */
     rawBulkTag(body: SchemaTypes.UploadBulkTagSchema): Promise<SchemaTypes.UploadBulkTagJobSchema>;
+    /**
+     * Put assets into a collection in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_set_upload_collection
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    bulkSetUploadCollection(body: SimpleSchemaTypes.UploadBulkSetUploadCollectionSchema): Promise<SimpleSchemaTypes.UploadBulkSetUploadCollectionJobSchema>;
+    /**
+     * Put assets into a collection in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_set_upload_collection
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawBulkSetUploadCollection(body: SchemaTypes.UploadBulkSetUploadCollectionSchema): Promise<SchemaTypes.UploadBulkSetUploadCollectionJobSchema>;
     /**
      * Destroy uploads
      *