@datocms/cma-client 3.3.5 → 3.3.8

package/dist/esm/generated/SchemaTypes.d.ts

@@ -319,6 +319,35 @@ export type SchemaMenuItemInstancesHrefSchema = {
         ids: string;
     };
 };
+/**
+ * JSON API type field
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type UploadCollectionType = 'upload_collection';
+/**
+ * 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;
+/**
+ * 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".
@@ -562,7 +591,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.
@@ -685,7 +713,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;
 };
@@ -838,7 +865,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;
 };
@@ -941,7 +967,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
@@ -1064,8 +1089,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;
 };
 /**
@@ -1281,7 +1353,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;
 };
@@ -1327,7 +1398,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;
 };
@@ -1367,6 +1437,7 @@ export type DatoApi = {
     site_plan?: SitePlan;
     menu_item?: MenuItem;
     schema_menu_item?: SchemaMenuItem;
+    upload_collection?: UploadCollection;
     item_type?: ItemType;
     field?: Field;
     fieldset?: Fieldset;
@@ -1469,7 +1540,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
      */
@@ -1685,7 +1760,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
          */
@@ -1883,6 +1962,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
              */
@@ -2101,6 +2184,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
              */
@@ -3635,6 +3722,167 @@ export type SchemaMenuItemSelfTargetSchema = {
 export type SchemaMenuItemDestroyTargetSchema = {
     data: SchemaMenuItem;
 };
+/**
+ * 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 = {
+    type: UploadCollectionType;
+    id: UploadCollectionIdentity;
+    attributes: UploadCollectionAttributes;
+    relationships: UploadCollectionRelationships;
+};
+/**
+ * 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 upload collection
+     */
+    parent: {
+        data: null | UploadCollectionData;
+    };
+    /**
+     * Underlying upload collections
+     */
+    children: {
+        data: UploadCollectionData[];
+    };
+};
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type UploadCollectionData = {
+    type: UploadCollectionType;
+    id: UploadCollectionIdentity;
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `create.schema` link.
+ */
+export type UploadCollectionCreateSchema = {
+    data: {
+        id?: UploadCollectionIdentity;
+        type: UploadCollectionType;
+        /**
+         * JSON API attributes
+         */
+        attributes: {
+            /**
+             * The label of the upload collection
+             */
+            label: string;
+            /**
+             * Ordering index
+             */
+            position?: number;
+        };
+        relationships?: {
+            /**
+             * Parent upload collection
+             */
+            parent?: {
+                data: null | UploadCollectionData;
+            };
+        };
+    };
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `create.targetSchema` link.
+ */
+export type UploadCollectionCreateTargetSchema = {
+    data: UploadCollection;
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `update.schema` link.
+ */
+export type UploadCollectionUpdateSchema = {
+    data: {
+        type: UploadCollectionType;
+        id: UploadCollectionIdentity;
+        /**
+         * JSON API attributes
+         */
+        attributes?: {
+            /**
+             * The label of the upload collection
+             */
+            label?: string;
+            /**
+             * Ordering index
+             */
+            position?: number;
+        };
+        relationships?: {
+            /**
+             * Parent upload collection
+             */
+            parent?: {
+                data: null | UploadCollectionData;
+            };
+            /**
+             * Underlying upload collections
+             */
+            children?: {
+                data: UploadCollectionData[];
+            };
+        };
+    };
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `update.targetSchema` link.
+ */
+export type UploadCollectionUpdateTargetSchema = {
+    data: UploadCollection;
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `instances.targetSchema` link.
+ */
+export type UploadCollectionInstancesTargetSchema = {
+    data: UploadCollection[];
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `self.targetSchema` link.
+ */
+export type UploadCollectionSelfTargetSchema = {
+    data: UploadCollection;
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `destroy.targetSchema` link.
+ */
+export type UploadCollectionDestroyTargetSchema = {
+    data: UploadCollection;
+};
 /**
  * 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".
  *
@@ -7340,6 +7588,12 @@ export type UploadAttributes = {
  * via the `definition` "relationships".
  */
 export type UploadRelationships = {
+    /**
+     * Upload collection to which the asset belongs
+     */
+    upload_collection: {
+        data: UploadCollectionData | null;
+    };
     /**
      * The entity (account/collaborator/access token) who created the asset. It must be an object with `type` (e.g. 'account') and `id` properties.
      */
@@ -7426,6 +7680,14 @@ export type UploadCreateSchema = {
             tags?: string[];
             [k: string]: unknown;
         };
+        relationships?: {
+            /**
+             * Upload collection to which the asset belongs
+             */
+            upload_collection?: {
+                data: UploadCollectionData | null;
+            };
+        };
     };
 };
 /**
@@ -7543,9 +7805,15 @@ export type UploadUpdateSchema = {
             /**
              * The entity (account/collaborator/access token) who created the asset. It must be an object with `type` (e.g. 'account') and `id` properties.
              */
-            creator: {
+            creator?: {
                 data: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
             };
+            /**
+             * Upload collection to which the asset belongs
+             */
+            upload_collection?: {
+                data: UploadCollectionData | null;
+            };
         };
     };
 };
@@ -7665,6 +7933,47 @@ export type UploadBulkTagJobSchema = {
         failed: number;
     };
 };
+/**
+ * This interface was referenced by `Upload`'s JSON-Schema
+ * via the `bulk_set_upload_collection.schema` link.
+ */
+export type UploadBulkSetUploadCollectionSchema = {
+    data: {
+        type: 'upload_bulk_set_upload_collection_operation';
+        relationships: {
+            /**
+             * Asset collection to put uploads into
+             */
+            upload_collection: {
+                data: null | UploadCollectionData;
+            };
+            /**
+             * Assets to assign to the collection
+             */
+            uploads: {
+                data: UploadData[];
+            };
+        };
+    };
+};
+/**
+ * This interface was referenced by `Upload`'s JSON-Schema
+ * via the `bulk_set_upload_collection.targetSchema` link.
+ */
+export type UploadBulkSetUploadCollectionTargetSchema = {
+    data: Job;
+};
+/**
+ * This interface was referenced by `Upload`'s JSON-Schema
+ * via the `bulk_set_upload_collection.jobSchema` link.
+ */
+export type UploadBulkSetUploadCollectionJobSchema = {
+    data: unknown[];
+    meta: {
+        successful: number;
+        failed: number;
+    };
+};
 /**
  * This interface was referenced by `Upload`'s JSON-Schema
  * via the `bulk_destroy.schema` link.
@@ -8236,12 +8545,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
      */
@@ -8250,6 +8566,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;
 };
 /**
  * JSON API data
@@ -8285,12 +8605,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
              */
@@ -8311,6 +8638,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;
         };
     };
 };
@@ -8346,12 +8677,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
              */
@@ -8372,6 +8710,10 @@ 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;
         };
     };
 };
@@ -8404,7 +8746,7 @@ export type WebhookDestroyTargetSchema = {
     data: Webhook;
 };
 /**
- * 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".
@@ -8425,13 +8767,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;
     /**
@@ -8457,11 +8799,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
@@ -8496,6 +8854,15 @@ export type WebhookCallInstancesTargetSchema = {
     meta: {
         total_count: number;
     };
+    included: Webhook[];
+};
+/**
+ * This interface was referenced by `WebhookCall`'s JSON-Schema
+ * via the `self.targetSchema` link.
+ */
+export type WebhookCallSelfTargetSchema = {
+    data: WebhookCall;
+    included: Webhook[];
 };
 /**
  * Configuration for different build triggers. You can have different staging and production environments in order to test your site before final deploy