newscatcher-catchall-sdk 2.0.0 → 3.0.0

package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+ *     }
+ */
+export interface GetProjectOverviewRequest {
+    /** Unique project identifier. */
+    project_id: string;
+}

package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+ *     }
+ */
+export interface GetProjectRequest {
+    /** Unique project identifier. */
+    project_id: string;
+}

package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.d.mts

@@ -0,0 +1,16 @@
+import type * as CatchAllApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+ *     }
+ */
+export interface ListProjectResourcesRequest {
+    /** Unique project identifier. */
+    project_id: string;
+    resource_type?: CatchAllApi.ProjectResourceType;
+    /** Page number to retrieve. */
+    page?: number;
+    /** Number of records per page. */
+    page_size?: number;
+}

package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.d.mts

@@ -0,0 +1,16 @@
+import type * as CatchAllApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         search: "M&A"
+ *     }
+ */
+export interface ListProjectsRequest {
+    /** Page number to retrieve. */
+    page?: number;
+    /** Number of records per page. */
+    page_size?: number;
+    /** Filter by project name (case-insensitive substring match). */
+    search?: string;
+    ownership?: CatchAllApi.OwnershipFilter;
+}

package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.d.mts

@@ -0,0 +1,16 @@
+import type * as CatchAllApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+ *         resource_type: "job",
+ *         resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
+ *     }
+ */
+export interface RemoveResourceFromProjectRequest {
+    /** Unique project identifier. */
+    project_id: string;
+    resource_type: CatchAllApi.ProjectResourceType;
+    /** ID of the resource to remove. */
+    resource_id: string;
+}

package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.d.mts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+ *         name: "AI M&A Tracking (Q2 2026)"
+ *     }
+ */
+export interface UpdateProjectRequestDto {
+    /** Unique project identifier. */
+    project_id: string;
+    /** New name for the project. */
+    name?: string;
+    /** New description for the project. */
+    description?: string;
+}

package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/projects/client/requests/index.d.mts

@@ -0,0 +1,9 @@
+export type { AddResourceRequestDto } from "./AddResourceRequestDto.mjs";
+export type { CreateProjectRequestDto } from "./CreateProjectRequestDto.mjs";
+export type { DeleteProjectRequest } from "./DeleteProjectRequest.mjs";
+export type { GetProjectOverviewRequest } from "./GetProjectOverviewRequest.mjs";
+export type { GetProjectRequest } from "./GetProjectRequest.mjs";
+export type { ListProjectResourcesRequest } from "./ListProjectResourcesRequest.mjs";
+export type { ListProjectsRequest } from "./ListProjectsRequest.mjs";
+export type { RemoveResourceFromProjectRequest } from "./RemoveResourceFromProjectRequest.mjs";
+export type { UpdateProjectRequestDto } from "./UpdateProjectRequestDto.mjs";

package/dist/esm/api/resources/projects/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/projects/exports.d.mts

@@ -0,0 +1,2 @@
+export { ProjectsClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/projects/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { ProjectsClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/projects/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/projects/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/webhooks/client/Client.d.mts

@@ -0,0 +1,231 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as CatchAllApi from "../../../index.mjs";
+export declare namespace WebhooksClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Operations to create and manage reusable webhook endpoints.
+ *
+ * A webhook is a named HTTP endpoint that receives a POST notification
+ * when a job or monitor completes. Create webhooks once at the organization
+ * level and attach them to any number of jobs or monitors via `webhook_ids`.
+ * Supports Slack, Microsoft Teams, and generic HTTP targets with configurable
+ * delivery modes, authentication, and headers.
+ */
+export declare class WebhooksClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<WebhooksClient.Options>;
+    constructor(options?: WebhooksClient.Options);
+    /**
+     * Returns a paginated list of webhooks belonging to the organization.
+     *
+     * @param {CatchAllApi.ListWebhooksRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.listWebhooks()
+     */
+    listWebhooks(request?: CatchAllApi.ListWebhooksRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListWebhooksResponseDto>;
+    private __listWebhooks;
+    /**
+     * Creates a new webhook endpoint for the organization.
+     *
+     * @param {CatchAllApi.CreateWebhookRequestDto} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.createWebhook({
+     *         name: "Layoffs Alert",
+     *         url: "https://hooks.slack.com/services/T000/B000/xxx",
+     *         type: "slack",
+     *         delivery_mode: "full"
+     *     })
+     */
+    createWebhook(request: CatchAllApi.CreateWebhookRequestDto, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateWebhookResponseDto>;
+    private __createWebhook;
+    /**
+     * Returns the full configuration of a single webhook by ID.
+     *
+     * @param {CatchAllApi.GetWebhookRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.getWebhook({
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     *     })
+     */
+    getWebhook(request: CatchAllApi.GetWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.GetWebhookResponseDto>;
+    private __getWebhook;
+    /**
+     * Permanently deletes a webhook and removes all resource assignments.
+     *
+     * Assigned jobs and monitors no longer trigger delivery to this webhook. This operation cannot be undone.
+     *
+     * @param {CatchAllApi.DeleteWebhookRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.webhooks.deleteWebhook({
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     *     })
+     */
+    deleteWebhook(request: CatchAllApi.DeleteWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteWebhook;
+    /**
+     * Updates one or more fields of an existing webhook.
+     *
+     * @param {CatchAllApi.UpdateWebhookRequestDto} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.updateWebhook({
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+     *         name: "Layoffs Alert (EU)",
+     *         is_active: false
+     *     })
+     */
+    updateWebhook(request: CatchAllApi.UpdateWebhookRequestDto, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateWebhookResponseDto>;
+    private __updateWebhook;
+    /**
+     * Sends a test HTTP request to the webhook URL using the webhook's configured method, headers, and auth. Returns the response from the target endpoint.
+     *
+     * Use this to verify URL reachability and authentication before attaching the webhook to a live job or monitor.
+     *
+     * @param {CatchAllApi.TestWebhookRequestDto} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.testWebhook({
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+     *         payload: {
+     *             "test": true,
+     *             "message": "CatchAll webhook test"
+     *         }
+     *     })
+     */
+    testWebhook(request: CatchAllApi.TestWebhookRequestDto, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.TestWebhookResponseDto>;
+    private __testWebhook;
+    /**
+     * Returns a paginated list of resources currently assigned to this webhook.
+     *
+     * @param {CatchAllApi.ListWebhookResourcesRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.listWebhookResources({
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     *     })
+     */
+    listWebhookResources(request: CatchAllApi.ListWebhookResourcesRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListWebhookResourcesResponseDto>;
+    private __listWebhookResources;
+    /**
+     * Attaches a job, monitor, or monitor group to the webhook. When the
+     * resource completes, the webhook receives a delivery.
+     *
+     * A single webhook can be assigned to multiple resources. Each resource
+     * can have up to 5 webhooks assigned.
+     *
+     * @param {CatchAllApi.AssignWebhookResourceRequestDto} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.assignWebhookResource({
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+     *         resource_type: "monitor",
+     *         resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+     *     })
+     */
+    assignWebhookResource(request: CatchAllApi.AssignWebhookResourceRequestDto, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.AssignWebhookResourceResponseDto>;
+    private __assignWebhookResource;
+    /**
+     * Detaches a resource from this webhook. Completions of the resource no longer trigger delivery to this webhook.
+     *
+     * The webhook and the resource itself are not deleted.
+     *
+     * @param {CatchAllApi.RemoveWebhookResourceRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.webhooks.removeWebhookResource({
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+     *         resource_type: "job",
+     *         resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+     *     })
+     */
+    removeWebhookResource(request: CatchAllApi.RemoveWebhookResourceRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __removeWebhookResource;
+    /**
+     * Returns all webhooks currently assigned to the given resource.
+     *
+     * @param {CatchAllApi.ListWebhooksForResourceRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.listWebhooksForResource({
+     *         resource_type: "job",
+     *         resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+     *     })
+     */
+    listWebhooksForResource(request: CatchAllApi.ListWebhooksForResourceRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListWebhooksResponseDto>;
+    private __listWebhooksForResource;
+    /**
+     * Returns a paginated delivery log for a given resource, ordered by timestamp descending.
+     *
+     * Each record shows the webhook dispatched, the HTTP status code returned, delivery outcome, and any error or warning messages. Use this to debug failed deliveries or audit dispatch activity.
+     *
+     * @param {CatchAllApi.GetWebhookDeliveryHistoryRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.getWebhookDeliveryHistory({
+     *         resource_type: "job",
+     *         resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+     *     })
+     */
+    getWebhookDeliveryHistory(request: CatchAllApi.GetWebhookDeliveryHistoryRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DeliveryHistoryResponseDto>;
+    private __getWebhookDeliveryHistory;
+}