@datocms/cma-client 3.3.5 → 3.3.8

package/dist/types/generated/resources/UploadCollection.d.ts

@@ -0,0 +1,96 @@
+import BaseResource from '../../BaseResource';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+export default class UploadCollection extends BaseResource {
+    static readonly TYPE: "upload_collection";
+    /**
+     * Create a new upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    create(body: SimpleSchemaTypes.UploadCollectionCreateSchema): Promise<SimpleSchemaTypes.UploadCollection>;
+    /**
+     * Create a new upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawCreate(body: SchemaTypes.UploadCollectionCreateSchema): Promise<SchemaTypes.UploadCollectionCreateTargetSchema>;
+    /**
+     * Update a upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    update(uploadCollectionId: string | SimpleSchemaTypes.UploadCollectionData, body: SimpleSchemaTypes.UploadCollectionUpdateSchema): Promise<SimpleSchemaTypes.UploadCollection>;
+    /**
+     * Update a upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawUpdate(uploadCollectionId: string, body: SchemaTypes.UploadCollectionUpdateSchema): Promise<SchemaTypes.UploadCollectionUpdateTargetSchema>;
+    /**
+     * List all upload collections
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    list(queryParams?: SimpleSchemaTypes.UploadCollectionInstancesHrefSchema): Promise<SimpleSchemaTypes.UploadCollectionInstancesTargetSchema>;
+    /**
+     * List all upload collections
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawList(queryParams?: SchemaTypes.UploadCollectionInstancesHrefSchema): Promise<SchemaTypes.UploadCollectionInstancesTargetSchema>;
+    /**
+     * Retrieve a upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    find(uploadCollectionId: string | SimpleSchemaTypes.UploadCollectionData): Promise<SimpleSchemaTypes.UploadCollection>;
+    /**
+     * Retrieve a upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawFind(uploadCollectionId: string): Promise<SchemaTypes.UploadCollectionSelfTargetSchema>;
+    /**
+     * Delete a upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    destroy(uploadCollectionId: string | SimpleSchemaTypes.UploadCollectionData): Promise<SimpleSchemaTypes.UploadCollection>;
+    /**
+     * Delete a upload collection
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawDestroy(uploadCollectionId: string): Promise<SchemaTypes.UploadCollectionDestroyTargetSchema>;
+}

package/dist/types/generated/resources/WebhookCall.d.ts

@@ -40,6 +40,24 @@ export default class WebhookCall extends BaseResource {
      * @throws {TimeoutError}
      */
     rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<SchemaTypes.WebhookCallInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.WebhookCall, void, unknown>;
+    /**
+     * Retrieve a webhook call
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    find(webhookCallId: string | SimpleSchemaTypes.WebhookCallData): Promise<SimpleSchemaTypes.WebhookCall>;
+    /**
+     * Retrieve a webhook call
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawFind(webhookCallId: string): Promise<SchemaTypes.WebhookCallSelfTargetSchema>;
     /**
      * Re-send the webhook call
      *

package/dist/types/generated/resources/index.d.ts

@@ -4,6 +4,7 @@ export { default as SsoUser } from './SsoUser';
 export { default as AuditLogEvent } from './AuditLogEvent';
 export { default as MenuItem } from './MenuItem';
 export { default as SchemaMenuItem } from './SchemaMenuItem';
+export { default as UploadCollection } from './UploadCollection';
 export { default as ItemType } from './ItemType';
 export { default as Field } from './Field';
 export { default as Fieldset } from './Fieldset';

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@datocms/cma-client",
-  "version": "3.3.5",
+  "version": "3.3.8",
   "description": "JS client for DatoCMS REST Content Management API",
-  "keywords": ["datocms", "client"],
+  "keywords": [
+    "datocms",
+    "client"
+  ],
   "author": "Stefano Verna <s.verna@datocms.com>",
   "homepage": "https://github.com/datocms/js-rest-api-clients/tree/main/packages/cma-client#readme",
   "license": "MIT",
@@ -14,7 +17,11 @@
     "lib": "dist",
     "test": "__tests__"
   },
-  "files": ["dist", "src", "resources.json"],
+  "files": [
+    "dist",
+    "src",
+    "resources.json"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -34,8 +41,8 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^3.3.5",
+    "@datocms/dashboard-client": "^3.3.7",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "9cd93dc5205b69f63eec5c86a7783f5e414a2952"
+  "gitHead": "e46a0db6a551cfa9d6b3bb5d087c68ea09a15f7f"
 }

package/resources.json

@@ -25,6 +25,7 @@
             "environments_access",
             "can_manage_users",
             "can_manage_shared_filters",
+            "can_manage_upload_collections",
             "can_manage_build_triggers",
             "can_manage_webhooks",
             "can_manage_environments",
@@ -83,6 +84,7 @@
             "environments_access",
             "can_manage_users",
             "can_manage_shared_filters",
+            "can_manage_upload_collections",
             "can_manage_build_triggers",
             "can_manage_webhooks",
             "can_manage_environments",
@@ -655,6 +657,130 @@
     "namespace": "schemaMenuItems",
     "resourceClassName": "SchemaMenuItem"
   },
+  {
+    "jsonApiType": "upload_collection",
+    "endpoints": [
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/create",
+        "rel": "create",
+        "urlTemplate": "/upload-collections",
+        "method": "POST",
+        "comment": "Create a new upload collection",
+        "urlPlaceholders": [],
+        "requestBodyType": "UploadCollectionCreateSchema",
+        "optionalRequestBody": false,
+        "requestStructure": {
+          "type": "upload_collection",
+          "attributes": ["label", "position"],
+          "relationships": ["parent"]
+        },
+        "queryParamsRequired": false,
+        "responseType": "UploadCollectionCreateTargetSchema",
+        "name": "create",
+        "rawName": "rawCreate"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/update",
+        "rel": "update",
+        "urlTemplate": "/upload-collections/${uploadCollectionId}",
+        "method": "PUT",
+        "comment": "Update a upload collection",
+        "urlPlaceholders": [
+          {
+            "variableName": "uploadCollectionId",
+            "isEntityId": true,
+            "relType": "UploadCollectionData"
+          }
+        ],
+        "entityIdPlaceholder": {
+          "variableName": "uploadCollectionId",
+          "isEntityId": true,
+          "relType": "UploadCollectionData"
+        },
+        "requestBodyType": "UploadCollectionUpdateSchema",
+        "optionalRequestBody": false,
+        "requestStructure": {
+          "type": "upload_collection",
+          "idRequired": true,
+          "attributes": ["label", "position"],
+          "relationships": ["parent", "children"]
+        },
+        "queryParamsRequired": false,
+        "responseType": "UploadCollectionUpdateTargetSchema",
+        "name": "update",
+        "rawName": "rawUpdate"
+      },
+      {
+        "returnsCollection": true,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances",
+        "rel": "instances",
+        "urlTemplate": "/upload-collections",
+        "method": "GET",
+        "comment": "List all upload collections",
+        "urlPlaceholders": [],
+        "optionalRequestBody": false,
+        "queryParamsType": "UploadCollectionInstancesHrefSchema",
+        "queryParamsRequired": false,
+        "responseType": "UploadCollectionInstancesTargetSchema",
+        "name": "list",
+        "rawName": "rawList"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/self",
+        "rel": "self",
+        "urlTemplate": "/upload-collections/${uploadCollectionId}",
+        "method": "GET",
+        "comment": "Retrieve a upload collection",
+        "urlPlaceholders": [
+          {
+            "variableName": "uploadCollectionId",
+            "isEntityId": true,
+            "relType": "UploadCollectionData"
+          }
+        ],
+        "entityIdPlaceholder": {
+          "variableName": "uploadCollectionId",
+          "isEntityId": true,
+          "relType": "UploadCollectionData"
+        },
+        "optionalRequestBody": false,
+        "queryParamsRequired": false,
+        "responseType": "UploadCollectionSelfTargetSchema",
+        "name": "find",
+        "rawName": "rawFind"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy",
+        "rel": "destroy",
+        "urlTemplate": "/upload-collections/${uploadCollectionId}",
+        "method": "DELETE",
+        "comment": "Delete a upload collection",
+        "urlPlaceholders": [
+          {
+            "variableName": "uploadCollectionId",
+            "isEntityId": true,
+            "relType": "UploadCollectionData"
+          }
+        ],
+        "entityIdPlaceholder": {
+          "variableName": "uploadCollectionId",
+          "isEntityId": true,
+          "relType": "UploadCollectionData"
+        },
+        "optionalRequestBody": false,
+        "queryParamsRequired": false,
+        "responseType": "UploadCollectionDestroyTargetSchema",
+        "name": "destroy",
+        "rawName": "rawDestroy"
+      }
+    ],
+    "namespace": "uploadCollections",
+    "resourceClassName": "UploadCollection"
+  },
   {
     "jsonApiType": "item_type",
     "endpoints": [
@@ -2273,7 +2399,7 @@
             "default_field_metadata",
             "tags"
           ],
-          "relationships": []
+          "relationships": ["upload_collection"]
         },
         "queryParamsRequired": false,
         "responseType": "UploadCreateJobSchema",
@@ -2382,7 +2508,7 @@
             "tags",
             "default_field_metadata"
           ],
-          "relationships": ["creator"]
+          "relationships": ["creator", "upload_collection"]
         },
         "queryParamsRequired": false,
         "responseType": "UploadUpdateJobSchema",
@@ -2473,6 +2599,26 @@
         "name": "bulkTag",
         "rawName": "rawBulkTag"
       },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/bulk_set_upload_collection",
+        "rel": "bulk_set_upload_collection",
+        "urlTemplate": "/uploads/bulk/set-upload-collection",
+        "method": "POST",
+        "comment": "Put assets into a collection in bulk",
+        "urlPlaceholders": [],
+        "requestBodyType": "UploadBulkSetUploadCollectionSchema",
+        "optionalRequestBody": false,
+        "requestStructure": {
+          "type": "upload_bulk_set_upload_collection_operation",
+          "attributes": [],
+          "relationships": ["upload_collection", "uploads"]
+        },
+        "queryParamsRequired": false,
+        "responseType": "UploadBulkSetUploadCollectionJobSchema",
+        "name": "bulkSetUploadCollection",
+        "rawName": "rawBulkSetUploadCollection"
+      },
       {
         "returnsCollection": false,
         "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy",
@@ -3008,7 +3154,8 @@
             "http_basic_password",
             "enabled",
             "payload_api_version",
-            "nested_items_in_payload"
+            "nested_items_in_payload",
+            "auto_retry"
           ],
           "relationships": []
         },
@@ -3051,7 +3198,8 @@
             "http_basic_password",
             "enabled",
             "payload_api_version",
-            "nested_items_in_payload"
+            "nested_items_in_payload",
+            "auto_retry"
           ],
           "relationships": []
         },
@@ -3150,6 +3298,31 @@
         "name": "list",
         "rawName": "rawList"
       },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook-call/self",
+        "rel": "self",
+        "urlTemplate": "/webhook_calls/${webhookCallId}",
+        "method": "GET",
+        "comment": "Retrieve a webhook call",
+        "urlPlaceholders": [
+          {
+            "variableName": "webhookCallId",
+            "isEntityId": true,
+            "relType": "WebhookCallData"
+          }
+        ],
+        "entityIdPlaceholder": {
+          "variableName": "webhookCallId",
+          "isEntityId": true,
+          "relType": "WebhookCallData"
+        },
+        "optionalRequestBody": false,
+        "queryParamsRequired": false,
+        "responseType": "WebhookCallSelfTargetSchema",
+        "name": "find",
+        "rawName": "rawFind"
+      },
       {
         "returnsCollection": false,
         "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook",

package/src/generated/Client.ts

@@ -44,6 +44,7 @@ export class Client {
   auditLogEvents: Resources.AuditLogEvent;
   menuItems: Resources.MenuItem;
   schemaMenuItems: Resources.SchemaMenuItem;
+  uploadCollections: Resources.UploadCollection;
   itemTypes: Resources.ItemType;
   fields: Resources.Field;
   fieldsets: Resources.Fieldset;
@@ -96,6 +97,7 @@ export class Client {
     this.auditLogEvents = new Resources.AuditLogEvent(this);
     this.menuItems = new Resources.MenuItem(this);
     this.schemaMenuItems = new Resources.SchemaMenuItem(this);
+    this.uploadCollections = new Resources.UploadCollection(this);
     this.itemTypes = new Resources.ItemType(this);
     this.fields = new Resources.Field(this);
     this.fieldsets = new Resources.Fieldset(this);
@@ -145,7 +147,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v3.3.5',
+      userAgent: '@datocms/cma-client v3.3.8',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {