@schedulin/sdk 0.1.2 → 0.3.0

package/cjs/api/resources/webhooks/client/Client.d.ts

@@ -0,0 +1,155 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Schedulin from "../../../index.js";
+export declare namespace WebhooksClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class WebhooksClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<WebhooksClient.Options>;
+    constructor(options: WebhooksClient.Options);
+    /**
+     * List the organization's webhook endpoints. Signing secrets are masked.
+     *
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.list()
+     */
+    list(requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __list;
+    /**
+     * Register an HTTPS endpoint for event deliveries. The response includes the signing secret ONCE — store it; later reads return a masked value.
+     *
+     * @param {Schedulin.CreateWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.create({
+     *         url: "url",
+     *         events: ["post.published"]
+     *     })
+     */
+    create(request: Schedulin.CreateWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __create;
+    /**
+     * Retrieve one webhook endpoint, including failure counters. The signing secret is masked.
+     *
+     * @param {Schedulin.RetrieveWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.retrieve({
+     *         id: "id"
+     *     })
+     */
+    retrieve(request: Schedulin.RetrieveWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __retrieve;
+    /**
+     * Delete a webhook endpoint and its delivery history. Deliveries already in flight are dropped.
+     *
+     * @param {Schedulin.DeleteWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.delete({
+     *         id: "id"
+     *     })
+     */
+    delete(request: Schedulin.DeleteWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __delete;
+    /**
+     * Update URL, subscribed events, description, or enabled state. Re-enabling resets the failure streak.
+     *
+     * @param {Schedulin.UpdateWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.update({
+     *         id: "id"
+     *     })
+     */
+    update(request: Schedulin.UpdateWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __update;
+    /**
+     * Generate a new signing secret for the endpoint and return it ONCE. The old secret stops signing immediately.
+     *
+     * @param {Schedulin.RotateSecretWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.rotateSecret({
+     *         id: "id"
+     *     })
+     */
+    rotateSecret(request: Schedulin.RotateSecretWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __rotateSecret;
+    /**
+     * Send a signed `ping` event to the endpoint URL and record it in the delivery history.
+     *
+     * @param {Schedulin.TestWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.test({
+     *         id: "id"
+     *     })
+     */
+    test(request: Schedulin.TestWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __test;
+    /**
+     * Delivery history for a webhook endpoint: event, status, attempts, last response code, and payload.
+     *
+     * @param {Schedulin.ListDeliveriesWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     * @throws {@link errors.SchedulinError}
+     * @throws {@link errors.SchedulinTimeoutError}
+     *
+     * @example
+     *     await client.webhooks.listDeliveries({
+     *         id: "id"
+     *     })
+     */
+    listDeliveries(request: Schedulin.ListDeliveriesWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __listDeliveries;
+}