Add tests for webhook endpoints and Refactor the webhooks API: Migrate from JavaScript to TypeScript and enhance type definitions

lib/types/SmartsheetClient.ts

@@ -5,6 +5,7 @@ import type { SharingApi } from '../sharing';
 import type { SightsApi } from '../sights/types';
 import type { AlternateEmailsApi } from '../users/alternateemails_types';
 import type { UsersApi } from '../users/types';
+import type { WebhooksApi } from '../webhooks/types';
 
 export interface SmartsheetClient {
   constants: any;
@@ -25,6 +26,6 @@ export interface SmartsheetClient {
   templates: any;
   tokens: any;
   users: UsersApi & AlternateEmailsApi;
-  webhooks: any;
+  webhooks: WebhooksApi;
   workspaces: any;
 }

lib/webhooks/index.ts

@@ -0,0 +1,79 @@
+import type { CreateOptions, RequestCallback, RequestOptions } from '../types';
+import type {
+  WebhooksApi,
+  CreateWebhookResponse,
+  GetWebhookOptions,
+  ListWebhooksResponse,
+  UpdateWebhookOptions,
+  UpdateWebhookResponse,
+  DeleteWebhookOptions,
+  DeleteWebhookResponse,
+  ResetSharedSecretOptions,
+  ResetSharedSecretResponse,
+  CreateWebhookBody,
+  Webhook,
+  ListWebhooksQueryParameters,
+} from './types';
+
+export function create(options: CreateOptions): WebhooksApi {
+  const requestor = options.requestor;
+
+  const optionsToSend = {
+    ...options.clientOptions,
+  };
+
+  const createWebhook = (
+    postOptions: RequestOptions<undefined, CreateWebhookBody>,
+    callback?: RequestCallback<CreateWebhookResponse>
+  ) => {
+    const urlOptions = { url: buildUrl() };
+    return requestor.post({ ...optionsToSend, ...urlOptions, ...postOptions }, callback);
+  };
+
+  const deleteWebhook = (deleteOptions: DeleteWebhookOptions, callback?: RequestCallback<DeleteWebhookResponse>) => {
+    const urlOptions = { url: buildUrl(deleteOptions.webhookId) };
+    return requestor.delete({ ...optionsToSend, ...urlOptions, ...deleteOptions }, callback);
+  };
+
+  const updateWebhook = (putOptions: UpdateWebhookOptions, callback?: RequestCallback<UpdateWebhookResponse>) => {
+    const urlOptions = { url: buildUrl(putOptions.webhookId) };
+    return requestor.put({ ...optionsToSend, ...urlOptions, ...putOptions }, callback);
+  };
+
+  const getWebhook = (getOptions: GetWebhookOptions, callback?: RequestCallback<Webhook>) => {
+    const urlOptions = { url: buildUrl(getOptions.webhookId) };
+    return requestor.get({ ...optionsToSend, ...urlOptions, ...getOptions }, callback);
+  };
+
+  const listWebhooks = (
+    getOptions: RequestOptions<ListWebhooksQueryParameters, undefined>,
+    callback?: RequestCallback<ListWebhooksResponse>
+  ) => {
+    const urlOptions = { url: buildUrl() };
+    return requestor.get({ ...optionsToSend, ...urlOptions, ...getOptions }, callback);
+  };
+
+  const resetSharedSecret = (
+    postOptions: ResetSharedSecretOptions,
+    callback?: RequestCallback<ResetSharedSecretResponse>
+  ) => {
+    const urlOptions = { url: buildUrl(postOptions.webhookId) + '/resetsharedsecret' };
+    return requestor.post({ ...optionsToSend, ...urlOptions, ...postOptions }, callback);
+  };
+
+  const buildUrl = (webhookId?: number) => {
+    if (webhookId !== undefined) {
+      return options.apiUrls.webhooks + '/' + webhookId;
+    }
+    return options.apiUrls.webhooks;
+  };
+
+  return {
+    createWebhook: createWebhook,
+    getWebhook: getWebhook,
+    listWebhooks: listWebhooks,
+    deleteWebhook: deleteWebhook,
+    updateWebhook: updateWebhook,
+    resetSharedSecret: resetSharedSecret,
+  };
+}