@datocms/cma-client 3.3.7 → 3.3.8

package/dist/types/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".
@@ -1408,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;
@@ -1510,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
      */
@@ -1726,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
          */
@@ -1924,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
              */
@@ -2142,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
              */
@@ -3676,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".
  *
@@ -7381,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.
      */
@@ -7467,6 +7680,14 @@ export type UploadCreateSchema = {
             tags?: string[];
             [k: string]: unknown;
         };
+        relationships?: {
+            /**
+             * Upload collection to which the asset belongs
+             */
+            upload_collection?: {
+                data: UploadCollectionData | null;
+            };
+        };
     };
 };
 /**
@@ -7584,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;
+            };
         };
     };
 };
@@ -7706,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.
@@ -8478,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".

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".
@@ -1043,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.
@@ -1698,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;
@@ -1789,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
      */
@@ -1997,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
          */
@@ -2190,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
      */
@@ -2391,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
      */
@@ -2585,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
      */
@@ -4129,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".
  *
@@ -4562,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
@@ -4607,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;
@@ -7193,6 +7352,7 @@ export type Upload = {
          */
         alpha: number;
     }[];
+    upload_collection: UploadCollectionData | null;
     creator: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
 };
 export type UploadCreateJobSchema = Upload;
@@ -7385,6 +7545,7 @@ export type UploadAttributes = {
  * via the `definition` "relationships".
  */
 export type UploadRelationships = {
+    upload_collection: UploadCollectionData | null;
     creator: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
 };
 /**
@@ -7452,6 +7613,7 @@ export type UploadCreateSchema = {
      * Tags
      */
     tags?: string[];
+    upload_collection?: UploadCollectionData | null;
 };
 /**
  * This interface was referenced by `Upload`'s JSON-Schema
@@ -7523,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
@@ -7547,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.
@@ -8351,7 +8523,7 @@ export type WebhookUpdateSchema = {
     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".

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
      *