@orq-ai/node 4.12.0-rc.34 → 4.12.0-rc.37

package/src/sdk/webhooks.ts

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { webhooksCount } from "../funcs/webhooksCount.js";
+import { webhooksCreate } from "../funcs/webhooksCreate.js";
+import { webhooksDelete } from "../funcs/webhooksDelete.js";
+import { webhooksGenerateSecret } from "../funcs/webhooksGenerateSecret.js";
+import { webhooksGet } from "../funcs/webhooksGet.js";
+import { webhooksList } from "../funcs/webhooksList.js";
+import { webhooksQuery } from "../funcs/webhooksQuery.js";
+import { webhooksUpdate } from "../funcs/webhooksUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Webhooks extends ClientSDK {
+  /**
+   * List webhooks
+   *
+   * @remarks
+   * Returns a page of webhooks in the current workspace. By default, the first 20 matching webhooks are ordered by creation time, newest first. Supplied filters are combined, `count` reports the total number of matches before pagination, and `has_more` indicates whether another page is available.
+   */
+  async list(
+    request?: operations.WebhookListRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ListWebhooksResponse> {
+    return unwrapAsync(webhooksList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a webhook
+   *
+   * @remarks
+   * Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with `GET /v2/webhooks/secret`.
+   */
+  async create(
+    request: components.CreateWebhookRequest,
+    options?: RequestOptions,
+  ): Promise<components.Webhook> {
+    return unwrapAsync(webhooksCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Count webhooks
+   *
+   * @remarks
+   * Returns the total number of enabled and disabled webhooks in the current workspace.
+   */
+  async count(
+    options?: RequestOptions,
+  ): Promise<components.CountWebhooksResponse> {
+    return unwrapAsync(webhooksCount(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Query webhooks
+   *
+   * @remarks
+   * **Deprecated.** Returns webhooks matching legacy query filters. Use `GET /v2/webhooks` for pagination, search, event filtering, and sorting.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async query(
+    request: components.QueryWebhooksRequest,
+    options?: RequestOptions,
+  ): Promise<components.QueryWebhooksResponse> {
+    return unwrapAsync(webhooksQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Generate a webhook secret
+   *
+   * @remarks
+   * Generates a signing secret for verifying webhook deliveries. The secret is not persisted until it is used to create or update a webhook; store it securely.
+   */
+  async generateSecret(
+    options?: RequestOptions,
+  ): Promise<components.GenerateWebhookSecretResponse> {
+    return unwrapAsync(webhooksGenerateSecret(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a webhook
+   *
+   * @remarks
+   * Retrieves a webhook in the current workspace by ID. The response includes its signing secret; treat it as sensitive.
+   */
+  async get(
+    request: operations.WebhookGetRequest,
+    options?: RequestOptions,
+  ): Promise<components.Webhook> {
+    return unwrapAsync(webhooksGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a webhook
+   *
+   * @remarks
+   * Deletes a webhook in the current workspace and returns the deleted webhook ID.
+   */
+  async delete(
+    request: operations.WebhookDeleteRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteWebhookResponse> {
+    return unwrapAsync(webhooksDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a webhook
+   *
+   * @remarks
+   * Updates the supplied fields on a webhook in the current workspace. Omitted fields are unchanged. The response contains the applied fields rather than the complete webhook.
+   */
+  async update(
+    request: operations.WebhookUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<operations.WebhookUpdateResponseBody> {
+    return unwrapAsync(webhooksUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+}