@paygentic/sdk 0.9.15 → 0.9.17

package/src/sdk/webhooks.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { webhooksDisable } from "../funcs/webhooksDisable.js";
+import { webhooksEnable } from "../funcs/webhooksEnable.js";
+import { webhooksGet } from "../funcs/webhooksGet.js";
+import { webhooksGetPortal } from "../funcs/webhooksGetPortal.js";
+import { webhooksUpdate } from "../funcs/webhooksUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Webhooks extends ClientSDK {
+  /**
+   * Get
+   *
+   * @remarks
+   * Returns the webhook configuration for your account. Returns 404 if webhooks have never been enabled.
+   */
+  async get(
+    request?: operations.GetWebhooksRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.Webhooks> {
+    return unwrapAsync(webhooksGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Enable
+   *
+   * @remarks
+   * Turns on webhook delivery for your account. Call it once: when a configuration already exists, enabled or disabled, the response is 400 with code `DUPLICATE_RESOURCE`. Use the update operation to turn delivery on or off after that. Endpoint URLs, event subscriptions and the signing secret are managed in the webhook portal.
+   */
+  async enable(
+    request?: operations.CreateWebhooksRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.Webhooks> {
+    return unwrapAsync(webhooksEnable(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update
+   *
+   * @remarks
+   * Turns webhook delivery on or off. Set `enabled` to `false` to pause delivery and to `true` to resume it. Endpoints and their event subscriptions are kept. Returns 404 if webhooks have never been enabled.
+   */
+  async update(
+    request: operations.UpdateWebhooksRequest,
+    options?: RequestOptions,
+  ): Promise<models.Webhooks> {
+    return unwrapAsync(webhooksUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Disable
+   *
+   * @remarks
+   * Pauses webhook delivery. This has the same effect as the update operation with `enabled: false`: it does not delete the configuration, the endpoints or their event subscriptions. Use the update operation with `enabled: true` to resume delivery. Returns 404 if webhooks have never been enabled.
+   */
+  async disable(
+    request?: operations.DeleteWebhooksRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(webhooksDisable(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Portal Access
+   *
+   * @remarks
+   * Returns a link to the webhook portal, where you add endpoints, choose event types, read the signing secret and inspect deliveries. The link opens without a login and expires one hour after it is issued, at `expiresAt`. Treat it as a secret. Returns 404 unless webhooks are enabled.
+   */
+  async getPortal(
+    request?: operations.GetWebhookPortalRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.WebhookPortal> {
+    return unwrapAsync(webhooksGetPortal(
+      this,
+      request,
+      options,
+    ));
+  }
+}