@datocms/cma-client 3.3.7 → 3.3.9

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

@@ -290,6 +290,21 @@ export type MenuItemInstancesHrefSchema = {
         ids: string;
     };
 };
+/**
+ * This interface was referenced by `Job`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type JobType = 'job';
+/**
+ * ID of job
+ *
+ * This interface was referenced by `Job`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `Job`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type JobIdentity = string;
 /**
  * JSON API type field
  *
@@ -319,6 +334,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".
@@ -388,21 +432,6 @@ export type ItemTypeCreateHrefSchema = {
     schema_menu_item_id?: string;
     [k: string]: unknown;
 };
-/**
- * This interface was referenced by `Job`'s JSON-Schema
- * via the `definition` "type".
- */
-export type JobType = 'job';
-/**
- * ID of job
- *
- * This interface was referenced by `Job`'s JSON-Schema
- * via the `definition` "identity".
- *
- * This interface was referenced by `Job`'s JSON-Schema
- * via the `definition` "id".
- */
-export type JobIdentity = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `destroy.hrefSchema` link.
@@ -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
              */
@@ -3485,6 +3531,65 @@ export type MenuItemSelfTargetSchema = {
 export type MenuItemDestroyTargetSchema = {
     data: MenuItem;
 };
+/**
+ * This interface was referenced by `MenuItem`'s JSON-Schema
+ * via the `reorder.schema` link.
+ */
+export type MenuItemReorderSchema = {
+    data: {
+        id: MenuItemIdentity;
+        type: MenuItemType;
+        /**
+         * JSON API attributes
+         */
+        attributes: {
+            /**
+             * Ordering index
+             */
+            position: number;
+        };
+        relationships: {
+            /**
+             * Parent menu item
+             */
+            parent: {
+                data: null | MenuItemData;
+            };
+        };
+    }[];
+};
+/**
+ * This interface was referenced by `MenuItem`'s JSON-Schema
+ * via the `reorder.targetSchema` link.
+ */
+export type MenuItemReorderTargetSchema = {
+    data: Job;
+};
+/**
+ * This interface was referenced by `DatoApi`'s JSON-Schema
+ * via the `definition` "job".
+ */
+export type Job = {
+    type: JobType;
+    id: JobIdentity;
+};
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `Job`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type JobData = {
+    type: JobType;
+    id: JobIdentity;
+};
+/**
+ * This interface was referenced by `MenuItem`'s JSON-Schema
+ * via the `reorder.jobSchema` link.
+ */
+export type MenuItemReorderJobSchema = {
+    data: MenuItem[];
+};
 /**
  * In DatoCMS you can organize the different models and blocks present in your administrative area reordering and grouping them, so that their purpose will be more clear to the final editor.
  *
@@ -3676,6 +3781,249 @@ export type SchemaMenuItemSelfTargetSchema = {
 export type SchemaMenuItemDestroyTargetSchema = {
     data: SchemaMenuItem;
 };
+/**
+ * This interface was referenced by `SchemaMenuItem`'s JSON-Schema
+ * via the `reorder.schema` link.
+ */
+export type SchemaMenuItemReorderSchema = {
+    data: {
+        id: SchemaMenuItemIdentity;
+        type: SchemaMenuItemType;
+        /**
+         * JSON API attributes
+         */
+        attributes: {
+            /**
+             * Ordering index
+             */
+            position: number;
+        };
+        relationships: {
+            /**
+             * Parent schema menu item
+             */
+            parent: {
+                data: null | SchemaMenuItemData;
+            };
+        };
+    }[];
+};
+/**
+ * This interface was referenced by `SchemaMenuItem`'s JSON-Schema
+ * via the `reorder.targetSchema` link.
+ */
+export type SchemaMenuItemReorderTargetSchema = {
+    data: Job;
+};
+/**
+ * This interface was referenced by `SchemaMenuItem`'s JSON-Schema
+ * via the `reorder.jobSchema` link.
+ */
+export type SchemaMenuItemReorderJobSchema = {
+    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;
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `reorder.schema` link.
+ */
+export type UploadCollectionReorderSchema = {
+    data: {
+        id: UploadCollectionIdentity;
+        type: UploadCollectionType;
+        /**
+         * JSON API attributes
+         */
+        attributes: {
+            /**
+             * Ordering index
+             */
+            position: number;
+        };
+        relationships: {
+            /**
+             * Parent upload collection
+             */
+            parent: {
+                data: null | UploadCollectionData;
+            };
+        };
+    }[];
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `reorder.targetSchema` link.
+ */
+export type UploadCollectionReorderTargetSchema = {
+    data: Job;
+};
+/**
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
+ * via the `reorder.jobSchema` link.
+ */
+export type UploadCollectionReorderJobSchema = {
+    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".
  *
@@ -4096,24 +4444,6 @@ export type ItemTypeUpdateSchema = {
 export type ItemTypeUpdateTargetSchema = {
     data: Job;
 };
-/**
- * This interface was referenced by `DatoApi`'s JSON-Schema
- * via the `definition` "job".
- */
-export type Job = {
-    type: JobType;
-    id: JobIdentity;
-};
-/**
- * JSON API data
- *
- * This interface was referenced by `Job`'s JSON-Schema
- * via the `definition` "data".
- */
-export type JobData = {
-    type: JobType;
-    id: JobIdentity;
-};
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `update.jobSchema` link.
@@ -4156,6 +4486,59 @@ export type ItemTypeDestroyTargetSchema = {
 export type ItemTypeDestroyJobSchema = {
     data: ItemType;
 };
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `reorder_fields_and_fieldsets.schema` link.
+ */
+export type ItemTypeReorderFieldsAndFieldsetsSchema = {
+    data: ({
+        id: FieldIdentity;
+        type: FieldType;
+        /**
+         * JSON API attributes
+         */
+        attributes: {
+            /**
+             * Ordering index
+             */
+            position: number;
+        };
+        relationships: {
+            /**
+             * Fieldset linkage
+             */
+            fieldset: {
+                data: null | FieldsetData;
+            };
+        };
+    } | {
+        id: FieldsetIdentity;
+        type: FieldsetType;
+        /**
+         * JSON API attributes
+         */
+        attributes: {
+            /**
+             * Ordering index
+             */
+            position: number;
+        };
+    })[];
+};
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `reorder_fields_and_fieldsets.targetSchema` link.
+ */
+export type ItemTypeReorderFieldsAndFieldsetsTargetSchema = {
+    data: Job;
+};
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `reorder_fields_and_fieldsets.jobSchema` link.
+ */
+export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
+    data: (Field | Fieldset)[];
+};
 /**
  * DatoCMS offers a number of different fields that you can combine together to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
  *
@@ -4212,12 +4595,12 @@ export type ItemTypeDestroyJobSchema = {
  *
  * #### Setting the appearance to a field editor provided by a plugin
  *
- * If the project contains a plugin that exposes [manual field editors](/docs/plugin-sdk/manual-field-extensions), you can also configure the field to be presented with it instead of using one of the build-in editors.
+ * If the project contains a plugin that exposes [manual field editors](/docs/plugin-sdk/manual-field-extensions), you can also configure the field to be presented with it instead of using one of the built-in editors.
  *
  * In this case:
  *
- * - the `editor` property must be the ID of the plugin;
- * - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes;
+ * - the `editor` property is the plugin's project-specific autogenerated UUID. You can get it from the last part of the plugin's URL within your project's Configuration screen (e.g. `https://your-project.admin.datocms.com/configuration/plugins/PLUGIN_UUID/`), or via API with a [List all plugins](/docs/content-management-api/resources/plugin/instances) call.
+ * - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes. This is set in the plugin's own source code, within a `manualFieldExtension()` call in its entry point (usually something like `index.tsx`).
  * - the `parameters` property must provide a configuration object compatible with the [config screen of the manual field extension](/docs/plugin-sdk/manual-field-extensions#add-per-field-config-screens-to-manual-field-extensions), or an empty object if it doesn't require any configuration.
  *
  * ```js
@@ -7381,6 +7764,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 +7856,14 @@ export type UploadCreateSchema = {
             tags?: string[];
             [k: string]: unknown;
         };
+        relationships?: {
+            /**
+             * Upload collection to which the asset belongs
+             */
+            upload_collection?: {
+                data: UploadCollectionData | null;
+            };
+        };
     };
 };
 /**
@@ -7584,9 +7981,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 +8109,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 +8922,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".