newscatcher-catchall-sdk 2.0.0 → 3.0.0

package/dist/cjs/api/resources/projects/client/Client.d.ts

@@ -0,0 +1,178 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as CatchAllApi from "../../../index.js";
+export declare namespace ProjectsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Operations to create, organize, and manage projects.
+ *
+ * A project is a named container for jobs, monitors, and datasets. Group
+ * related resources by use case, team, or client, and share them with
+ * teammates. Resources can be assigned at creation time or post-hoc.
+ */
+export declare class ProjectsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ProjectsClient.Options>;
+    constructor(options?: ProjectsClient.Options);
+    /**
+     * Returns all projects visible to the authenticated user.
+     *
+     * @param {CatchAllApi.ListProjectsRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.listProjects({
+     *         search: "M&A"
+     *     })
+     */
+    listProjects(request?: CatchAllApi.ListProjectsRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectListResponseDto>;
+    private __listProjects;
+    /**
+     * Creates a new project.
+     *
+     * @param {CatchAllApi.CreateProjectRequestDto} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.createProject({
+     *         name: "AI M&A Tracking",
+     *         description: "Tracks AI-related M&A activity for our investment team."
+     *     })
+     */
+    createProject(request: CatchAllApi.CreateProjectRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateProjectResponseDto>;
+    private __createProject;
+    /**
+     * Returns a single project by ID.
+     *
+     * @param {CatchAllApi.GetProjectRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.getProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    getProject(request: CatchAllApi.GetProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectResponseDto>;
+    private __getProject;
+    /**
+     * Deletes a project. By default, assigned resources are unassigned but not deleted.
+     *
+     * @param {CatchAllApi.DeleteProjectRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.deleteProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    deleteProject(request: CatchAllApi.DeleteProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteProject;
+    /**
+     * Updates the name or description of an existing project.
+     *
+     * @param {CatchAllApi.UpdateProjectRequestDto} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.updateProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+     *         name: "AI M&A Tracking (Q2 2026)"
+     *     })
+     */
+    updateProject(request: CatchAllApi.UpdateProjectRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateProjectResponseDto>;
+    private __updateProject;
+    /**
+     * Returns resource counts for a project, grouped by type and status.
+     *
+     * For `jobs` and `monitors`, counts are broken down by status (for example, `completed`, `failed`). For `datasets` and `monitor_groups`, only a `total` count is returned.
+     *
+     * @param {CatchAllApi.GetProjectOverviewRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.getProjectOverview({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    getProjectOverview(request: CatchAllApi.GetProjectOverviewRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectOverviewResponseDto>;
+    private __getProjectOverview;
+    /**
+     * Returns all resources assigned to a project, with optional filtering by type.
+     *
+     * @param {CatchAllApi.ListProjectResourcesRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.listProjectResources({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    listProjectResources(request: CatchAllApi.ListProjectResourcesRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectResourceListResponseDto>;
+    private __listProjectResources;
+    /**
+     * Assigns one or more existing resources to a project in a single request.
+     *
+     * @param {CatchAllApi.AddResourceRequestDto} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.addResourceToProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+     *         resources: [{
+     *                 resource_type: "job",
+     *                 resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
+     *             }]
+     *     })
+     */
+    addResourceToProject(request: CatchAllApi.AddResourceRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.AddResourceResponseDto>;
+    private __addResourceToProject;
+    /**
+     * Removes a resource from a project. The resource itself is not
+     * deleted — it becomes unassigned and continues to exist.
+     *
+     * @param {CatchAllApi.RemoveResourceFromProjectRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.removeResourceFromProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+     *         resource_type: "job",
+     *         resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
+     *     })
+     */
+    removeResourceFromProject(request: CatchAllApi.RemoveResourceFromProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.RemoveResourceResponseDto>;
+    private __removeResourceFromProject;
+}