@datocms/cma-client 3.3.8 → 3.3.10

package/resources.json

@@ -528,6 +528,27 @@
         "responseType": "MenuItemDestroyTargetSchema",
         "name": "destroy",
         "rawName": "rawDestroy"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/reorder",
+        "rel": "reorder",
+        "urlTemplate": "/menu-items/reorder",
+        "method": "POST",
+        "comment": "Reorders a set of menu items",
+        "urlPlaceholders": [],
+        "requestBodyType": "MenuItemReorderSchema",
+        "optionalRequestBody": false,
+        "requestStructure": {
+          "type": "menu_item",
+          "attributes": [],
+          "relationships": []
+        },
+        "queryParamsRequired": false,
+        "responseType": "MenuItemReorderJobSchema",
+        "deprecated": "This API call is to be considered private and might change without notice",
+        "name": "reorder",
+        "rawName": "rawReorder"
       }
     ],
     "namespace": "menuItems",
@@ -652,6 +673,27 @@
         "responseType": "SchemaMenuItemDestroyTargetSchema",
         "name": "destroy",
         "rawName": "rawDestroy"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/schema-menu_item/reorder",
+        "rel": "reorder",
+        "urlTemplate": "/schema-menu-items/reorder",
+        "method": "POST",
+        "comment": "Reorders a set of schema menu items",
+        "urlPlaceholders": [],
+        "requestBodyType": "SchemaMenuItemReorderSchema",
+        "optionalRequestBody": false,
+        "requestStructure": {
+          "type": "schema_menu_item",
+          "attributes": [],
+          "relationships": []
+        },
+        "queryParamsRequired": false,
+        "responseType": "SchemaMenuItemReorderJobSchema",
+        "deprecated": "This API call is to be considered private and might change without notice",
+        "name": "reorder",
+        "rawName": "rawReorder"
       }
     ],
     "namespace": "schemaMenuItems",
@@ -776,6 +818,27 @@
         "responseType": "UploadCollectionDestroyTargetSchema",
         "name": "destroy",
         "rawName": "rawDestroy"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/reorder",
+        "rel": "reorder",
+        "urlTemplate": "/upload-collections/reorder",
+        "method": "POST",
+        "comment": "Reorders a set of upload collections",
+        "urlPlaceholders": [],
+        "requestBodyType": "UploadCollectionReorderSchema",
+        "optionalRequestBody": false,
+        "requestStructure": {
+          "type": "upload_collection",
+          "attributes": [],
+          "relationships": []
+        },
+        "queryParamsRequired": false,
+        "responseType": "UploadCollectionReorderJobSchema",
+        "deprecated": "This API call is to be considered private and might change without notice",
+        "name": "reorder",
+        "rawName": "rawReorder"
       }
     ],
     "namespace": "uploadCollections",
@@ -969,6 +1032,26 @@
         "responseType": "ItemTypeDestroyJobSchema",
         "name": "destroy",
         "rawName": "rawDestroy"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/reorder_fields_and_fieldsets",
+        "rel": "reorder_fields_and_fieldsets",
+        "urlTemplate": "/item-types/reorder-fields-and-fieldsets",
+        "method": "POST",
+        "comment": "Reorders a set of fields and fieldsets within the model",
+        "urlPlaceholders": [],
+        "requestBodyType": "ItemTypeReorderFieldsAndFieldsetsSchema",
+        "optionalRequestBody": false,
+        "requestStructure": {
+          "type": "*",
+          "attributes": [],
+          "relationships": []
+        },
+        "queryParamsRequired": false,
+        "responseType": "ItemTypeReorderFieldsAndFieldsetsJobSchema",
+        "deprecated": "This API call is to be considered private and might change without notice",
+        "rawName": "rawReorderFieldsAndFieldsets"
       }
     ],
     "namespace": "itemTypes",
@@ -3327,16 +3410,21 @@
         "returnsCollection": false,
         "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook",
         "rel": "resend_webhook",
-        "urlTemplate": "/webhook_calls/${userId}/resend_webhook",
+        "urlTemplate": "/webhook_calls/${webhookCallId}/resend_webhook",
         "method": "POST",
         "comment": "Re-send the webhook call",
         "urlPlaceholders": [
           {
-            "variableName": "userId",
-            "isEntityId": false,
-            "relType": "UserData"
+            "variableName": "webhookCallId",
+            "isEntityId": true,
+            "relType": "WebhookCallData"
           }
         ],
+        "entityIdPlaceholder": {
+          "variableName": "webhookCallId",
+          "isEntityId": true,
+          "relType": "WebhookCallData"
+        },
         "optionalRequestBody": false,
         "queryParamsRequired": false,
         "name": "resendWebhook",

package/src/generated/Client.ts

@@ -147,7 +147,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v3.3.8',
+      userAgent: '@datocms/cma-client v3.3.10',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {

package/src/generated/SchemaTypes.ts

@@ -292,6 +292,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
  *
@@ -419,21 +434,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.
@@ -3790,6 +3790,70 @@ 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.
  *
@@ -3992,6 +4056,50 @@ 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.
  *
@@ -4164,6 +4272,50 @@ 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".
  *
@@ -4611,26 +4763,6 @@ 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.
@@ -4679,6 +4811,65 @@ 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.
  *
@@ -4735,12 +4926,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