Fix webhook endpoint methods

datocms · Nov 15, 2023 · 6c46971 · 6c46971
1 parent 440e24c
commit 6c46971
Show file tree

Hide file tree

Showing 3 changed files with 75 additions and 24 deletions.
diff --git a/packages/cma-client-node/__tests__/webhook.test.ts b/packages/cma-client-node/__tests__/webhook.test.ts
@@ -0,0 +1,48 @@
+import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+
+describe('Webhooks', () => {
+  it.concurrent('create, find, all, destroy', async () => {
+    const client = await generateNewCmaClient();
+
+    const webhook = await client.webhooks.create({
+      name: 'test',
+      url: 'https://www.google.com',
+      http_basic_user: null,
+      http_basic_password: null,
+      custom_payload: null,
+      headers: {},
+      events: [
+        {
+          event_types: ['create', 'update'],
+          entity_type: 'item_type',
+          filters: [
+            {
+              entity_ids: ['brand', 'tag'],
+              entity_type: 'item_type',
+            },
+          ],
+        },
+      ],
+    });
+
+    const foundWebhook = await client.webhooks.find(webhook);
+    expect(foundWebhook.id).toEqual(webhook.id);
+
+    const allWebhooks = await client.webhooks.list();
+    expect(allWebhooks).toHaveLength(3);
+
+    await client.webhooks.update(foundWebhook, {
+      events: [
+        {
+          event_types: ['create'],
+          filters: [],
+          entity_type: 'item_type',
+        },
+      ],
+    });
+
+    await client.webhooks.destroy(foundWebhook);
+
+    expect(await client.webhooks.list()).toHaveLength(2);
+  });
+});
diff --git a/packages/cma-client/resources.json b/packages/cma-client/resources.json
@@ -2408,13 +2408,13 @@
         "returnsCollection": false,
         "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/update",
         "rel": "update",
-        "urlTemplate": "/webhooks/${userId}",
+        "urlTemplate": "/webhooks/${webhookId}",
         "method": "PUT",
         "comment": "Update a webhook",
         "urlPlaceholder": {
-          "variableName": "userId",
-          "isEntityId": false,
-          "relType": "UserData"
+          "variableName": "webhookId",
+          "isEntityId": true,
+          "relType": "WebhookData"
         },
         "requestBodyType": "WebhookUpdateSchema",
         "optionalRequestBody": false,
@@ -2457,13 +2457,13 @@
         "returnsCollection": false,
         "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/self",
         "rel": "self",
-        "urlTemplate": "/webhooks/${userId}",
+        "urlTemplate": "/webhooks/${webhookId}",
         "method": "GET",
         "comment": "Retrieve a webhook",
         "urlPlaceholder": {
-          "variableName": "userId",
-          "isEntityId": false,
-          "relType": "UserData"
+          "variableName": "webhookId",
+          "isEntityId": true,
+          "relType": "WebhookData"
         },
         "optionalRequestBody": false,
         "queryParamsRequired": false,
@@ -2475,13 +2475,13 @@
         "returnsCollection": false,
         "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/destroy",
         "rel": "destroy",
-        "urlTemplate": "/webhooks/${userId}",
+        "urlTemplate": "/webhooks/${webhookId}",
         "method": "DELETE",
         "comment": "Delete a webhook",
         "urlPlaceholder": {
-          "variableName": "userId",
-          "isEntityId": false,
-          "relType": "UserData"
+          "variableName": "webhookId",
+          "isEntityId": true,
+          "relType": "WebhookData"
         },
         "optionalRequestBody": false,
         "queryParamsRequired": false,

diff --git a/packages/cma-client/src/generated/resources/Webhook.ts b/packages/cma-client/src/generated/resources/Webhook.ts
@@ -66,12 +66,13 @@ export default class Webhook extends BaseResource {
    * @throws {TimeoutError}
    */
   update(
-    userId: string | SimpleSchemaTypes.UserData,
+    webhookId: string | SimpleSchemaTypes.WebhookData,
     body: SimpleSchemaTypes.WebhookUpdateSchema,
   ) {
     return this.rawUpdate(
-      Utils.toId(userId),
+      Utils.toId(webhookId),
       Utils.serializeRequestBody<SchemaTypes.WebhookUpdateSchema>(body, {
+        id: Utils.toId(webhookId),
         type: 'webhook',
         attributes: [
           'name',
@@ -103,12 +104,12 @@ export default class Webhook extends BaseResource {
    * @throws {TimeoutError}
    */
   rawUpdate(
-    userId: string,
+    webhookId: string,
     body: SchemaTypes.WebhookUpdateSchema,
   ): Promise<SchemaTypes.WebhookUpdateTargetSchema> {
     return this.client.request<SchemaTypes.WebhookUpdateTargetSchema>({
       method: 'PUT',
-      url: `/webhooks/${userId}`,
+      url: `/webhooks/${webhookId}`,
       body,
     });
   }
@@ -152,8 +153,8 @@ export default class Webhook extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  find(userId: string | SimpleSchemaTypes.UserData) {
-    return this.rawFind(Utils.toId(userId)).then((body) =>
+  find(webhookId: string | SimpleSchemaTypes.WebhookData) {
+    return this.rawFind(Utils.toId(webhookId)).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookSelfTargetSchema>(
         body,
       ),
@@ -168,10 +169,10 @@ export default class Webhook extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  rawFind(userId: string): Promise<SchemaTypes.WebhookSelfTargetSchema> {
+  rawFind(webhookId: string): Promise<SchemaTypes.WebhookSelfTargetSchema> {
     return this.client.request<SchemaTypes.WebhookSelfTargetSchema>({
       method: 'GET',
-      url: `/webhooks/${userId}`,
+      url: `/webhooks/${webhookId}`,
     });
   }
 
@@ -183,8 +184,8 @@ export default class Webhook extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  destroy(userId: string | SimpleSchemaTypes.UserData) {
-    return this.rawDestroy(Utils.toId(userId)).then((body) =>
+  destroy(webhookId: string | SimpleSchemaTypes.WebhookData) {
+    return this.rawDestroy(Utils.toId(webhookId)).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookDestroyTargetSchema>(
         body,
       ),
@@ -199,10 +200,12 @@ export default class Webhook extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  rawDestroy(userId: string): Promise<SchemaTypes.WebhookDestroyTargetSchema> {
+  rawDestroy(
+    webhookId: string,
+  ): Promise<SchemaTypes.WebhookDestroyTargetSchema> {
     return this.client.request<SchemaTypes.WebhookDestroyTargetSchema>({
       method: 'DELETE',
-      url: `/webhooks/${userId}`,
+      url: `/webhooks/${webhookId}`,
     });
   }
 }