@datocms/cma-client 3.3.7 → 3.3.8

package/src/generated/SchemaTypes.ts

@@ -321,6 +321,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".
@@ -1457,6 +1486,7 @@ export type DatoApi = {
   site_plan?: SitePlan;
   menu_item?: MenuItem;
   schema_menu_item?: SchemaMenuItem;
+  upload_collection?: UploadCollection;
   item_type?: ItemType;
   field?: Field;
   fieldset?: Fieldset;
@@ -1561,7 +1591,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
    */
@@ -1814,7 +1848,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
      */
@@ -2047,6 +2085,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
        */
@@ -2301,6 +2343,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
        */
@@ -3946,6 +3992,178 @@ 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".
  *
@@ -7971,6 +8189,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.
    */
@@ -8064,6 +8288,14 @@ export type UploadCreateSchema = {
       tags?: string[];
       [k: string]: unknown;
     };
+    relationships?: {
+      /**
+       * Upload collection to which the asset belongs
+       */
+      upload_collection?: {
+        data: UploadCollectionData | null;
+      };
+    };
   };
 };
 
@@ -8187,7 +8419,7 @@ 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
@@ -8195,6 +8427,12 @@ export type UploadUpdateSchema = {
           | SsoUserData
           | OrganizationData;
       };
+      /**
+       * Upload collection to which the asset belongs
+       */
+      upload_collection?: {
+        data: UploadCollectionData | null;
+      };
     };
   };
 };
@@ -8326,6 +8564,50 @@ export type UploadBulkTagJobSchema = {
   };
 };
 
+/**
+ * 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.
@@ -9232,7 +9514,7 @@ export type WebhookDestroyTargetSchema = {
 };
 
 /**
- * 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/src/generated/SimpleSchemaTypes.ts

@@ -366,6 +366,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".
@@ -1045,6 +1079,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.
@@ -1753,6 +1792,7 @@ export type DatoApi = {
   site_plan?: SitePlan;
   menu_item?: MenuItem;
   schema_menu_item?: SchemaMenuItem;
+  upload_collection?: UploadCollection;
   item_type?: ItemType;
   field?: Field;
   fieldset?: Fieldset;
@@ -1845,7 +1885,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
    */
@@ -2088,7 +2132,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
      */
@@ -2316,7 +2364,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
    */
@@ -2553,6 +2605,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
    */
@@ -2782,6 +2838,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
    */
@@ -4402,6 +4462,106 @@ export type SchemaMenuItemUpdateSchema = {
   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".
  *
@@ -4864,6 +5024,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
@@ -4909,6 +5072,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;
@@ -7763,6 +7927,7 @@ export type Upload = {
      */
     alpha: number;
   }[];
+  upload_collection: UploadCollectionData | null;
   creator:
     | AccountData
     | AccessTokenData
@@ -7962,6 +8127,7 @@ export type UploadAttributes = {
  * via the `definition` "relationships".
  */
 export type UploadRelationships = {
+  upload_collection: UploadCollectionData | null;
   creator:
     | AccountData
     | AccessTokenData
@@ -8035,6 +8201,7 @@ export type UploadCreateSchema = {
    * Tags
    */
   tags?: string[];
+  upload_collection?: UploadCollectionData | null;
 };
 
 /**
@@ -8112,6 +8279,7 @@ export type UploadUpdateSchema = {
     | UserData
     | SsoUserData
     | OrganizationData;
+  upload_collection?: UploadCollectionData | null;
 };
 
 /**
@@ -8139,6 +8307,16 @@ export type UploadBulkTagSchema = {
   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.
@@ -9078,7 +9256,7 @@ export type WebhookUpdateSchema = {
 };
 
 /**
- * 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/src/generated/resources/Role.ts

@@ -29,6 +29,7 @@ export default class Role extends BaseResource {
           'environments_access',
           'can_manage_users',
           'can_manage_shared_filters',
+          'can_manage_upload_collections',
           'can_manage_build_triggers',
           'can_manage_webhooks',
           'can_manage_environments',
@@ -100,6 +101,7 @@ export default class Role extends BaseResource {
           'environments_access',
           'can_manage_users',
           'can_manage_shared_filters',
+          'can_manage_upload_collections',
           'can_manage_build_triggers',
           'can_manage_webhooks',
           'can_manage_environments',