newscatcher-catchall-sdk 3.0.1 → 4.0.0

package/README.md

@@ -376,3 +376,4 @@ On the other hand, contributions to the README are always very welcome!
 
 
 
+

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "newscatcher-catchall-sdk",
-        "X-Fern-SDK-Version": "3.0.1",
-        "User-Agent": "newscatcher-catchall-sdk/3.0.1",
+        "X-Fern-SDK-Version": "4.0.0",
+        "User-Agent": "newscatcher-catchall-sdk/4.0.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/errors/BadRequestError.js

@@ -48,7 +48,7 @@ class BadRequestError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "BadRequestError";
     }
 }
 exports.BadRequestError = BadRequestError;

package/dist/cjs/api/errors/ForbiddenError.js

@@ -48,7 +48,7 @@ class ForbiddenError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "ForbiddenError";
     }
 }
 exports.ForbiddenError = ForbiddenError;

package/dist/cjs/api/errors/NotFoundError.js

@@ -48,7 +48,7 @@ class NotFoundError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "NotFoundError";
     }
 }
 exports.NotFoundError = NotFoundError;

package/dist/cjs/api/errors/UnauthorizedError.js

@@ -48,7 +48,7 @@ class UnauthorizedError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "UnauthorizedError";
     }
 }
 exports.UnauthorizedError = UnauthorizedError;

package/dist/cjs/api/errors/UnprocessableEntityError.js

@@ -48,7 +48,7 @@ class UnprocessableEntityError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "UnprocessableEntityError";
     }
 }
 exports.UnprocessableEntityError = UnprocessableEntityError;

package/dist/cjs/api/resources/entities/client/requests/UpdateEntityRequest.d.ts

@@ -18,5 +18,7 @@ export interface UpdateEntityRequest {
     name?: string;
     /** Updated description. */
     description?: string;
+    /** Updated external identifier for this entity. */
+    external_entity_id?: string;
     additional_attributes?: CatchAllApi.AdditionalAttributes;
 }

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

@@ -117,6 +117,22 @@ export declare class JobsClient {
      */
     getJobResults(request: CatchAllApi.GetJobResultsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullJobResponseDto>;
     private __getJobResults;
+    /**
+     * Returns a completed job's result records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.GetJobResultsCsvRequest} request
+     * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.jobs.getJobResultsCsv({
+     *         job_id: "job_id"
+     *     })
+     */
+    getJobResultsCsv(request: CatchAllApi.GetJobResultsCsvRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __getJobResultsCsv;
     /**
      * Continue an existing job to process more records beyond the initial limit.
      *

package/dist/cjs/api/resources/jobs/client/Client.js

@@ -415,6 +415,61 @@ class JobsClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/pull/{job_id}");
         });
     }
+    /**
+     * Returns a completed job's result records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.GetJobResultsCsvRequest} request
+     * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.jobs.getJobResultsCsv({
+     *         job_id: "job_id"
+     *     })
+     */
+    getJobResultsCsv(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getJobResultsCsv(request, requestOptions));
+    }
+    __getJobResultsCsv(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { job_id: jobId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/pull/${core.url.encodePathParam(jobId)}/csv`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "text",
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/pull/{job_id}/csv");
+        });
+    }
     /**
      * Continue an existing job to process more records beyond the initial limit.
      *

package/dist/cjs/api/resources/jobs/client/requests/GetJobResultsCsvRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         job_id: "job_id"
+ *     }
+ */
+export interface GetJobResultsCsvRequest {
+    /** Unique job identifier returned from [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/create-job). */
+    job_id: string;
+}

package/dist/cjs/api/resources/jobs/client/requests/GetJobResultsCsvRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/jobs/client/requests/index.d.ts

@@ -1,5 +1,6 @@
 export type { ContinueRequestDto } from "./ContinueRequestDto.js";
 export type { DeleteJobRequest } from "./DeleteJobRequest.js";
+export type { GetJobResultsCsvRequest } from "./GetJobResultsCsvRequest.js";
 export type { GetJobResultsRequest } from "./GetJobResultsRequest.js";
 export type { GetJobStatusRequest } from "./GetJobStatusRequest.js";
 export type { GetUserJobsRequest } from "./GetUserJobsRequest.js";

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

@@ -65,6 +65,22 @@ export declare class MonitorsClient {
      */
     pullMonitorResults(request: CatchAllApi.PullMonitorResultsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullMonitorResponseDto>;
     private __pullMonitorResults;
+    /**
+     * Returns the most recent run's records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.PullMonitorResultsCsvRequest} request
+     * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.monitors.pullMonitorResultsCsv({
+     *         monitor_id: "monitor_id"
+     *     })
+     */
+    pullMonitorResultsCsv(request: CatchAllApi.PullMonitorResultsCsvRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __pullMonitorResultsCsv;
     /**
      * Return all jobs executed by a monitor.
      *

package/dist/cjs/api/resources/monitors/client/Client.js

@@ -246,6 +246,61 @@ class MonitorsClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}");
         });
     }
+    /**
+     * Returns the most recent run's records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.PullMonitorResultsCsvRequest} request
+     * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.monitors.pullMonitorResultsCsv({
+     *         monitor_id: "monitor_id"
+     *     })
+     */
+    pullMonitorResultsCsv(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pullMonitorResultsCsv(request, requestOptions));
+    }
+    __pullMonitorResultsCsv(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { monitor_id: monitorId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/pull/${core.url.encodePathParam(monitorId)}/csv`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "text",
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}/csv");
+        });
+    }
     /**
      * Return all jobs executed by a monitor.
      *

package/dist/cjs/api/resources/monitors/client/requests/PullMonitorResultsCsvRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         monitor_id: "monitor_id"
+ *     }
+ */
+export interface PullMonitorResultsCsvRequest {
+    /** Monitor identifier. */
+    monitor_id: string;
+}

package/dist/cjs/api/resources/monitors/client/requests/PullMonitorResultsCsvRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/monitors/client/requests/index.d.ts

@@ -5,5 +5,6 @@ export type { EnableMonitorRequestDto } from "./EnableMonitorRequestDto.js";
 export type { GetMonitorStatusHistoryRequest } from "./GetMonitorStatusHistoryRequest.js";
 export type { ListMonitorJobsRequest } from "./ListMonitorJobsRequest.js";
 export type { ListMonitorsRequest } from "./ListMonitorsRequest.js";
+export type { PullMonitorResultsCsvRequest } from "./PullMonitorResultsCsvRequest.js";
 export type { PullMonitorResultsRequest } from "./PullMonitorResultsRequest.js";
 export type { UpdateMonitorRequestDto } from "./UpdateMonitorRequestDto.js";

package/dist/cjs/api/types/ConnectedDataset.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A dataset used to narrow the retrieval scope of a job or monitor, returned with its identifier and name.
+ */
+export interface ConnectedDataset {
+    /** Dataset identifier. */
+    id: string;
+    /** Dataset name as stored. Check `is_deleted` to determine whether the dataset is still active. */
+    name: string;
+    /** True when the dataset has been deleted. */
+    is_deleted?: boolean | undefined;
+}

package/dist/cjs/api/types/ConnectedDataset.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConnectedEntity.d.ts

@@ -26,6 +26,8 @@ export interface ConnectedEntity {
     association_type?: string | undefined;
     /** The entity type. */
     type: string;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     /**
      * The stored attributes for this entity. Present only when attributes exist in the database.
      *

package/dist/cjs/api/types/CreateEntityRequest.d.ts

@@ -9,5 +9,7 @@ export interface CreateEntityRequest {
     entity_type?: CatchAllApi.EntityType | undefined;
     /** Free-text description of the entity used for disambiguation when similar names exist. */
     description?: string | undefined;
+    /** Optional external identifier for this entity. Free-form string, not enforced as unique. Use it to store your own CRM, data warehouse, or internal database ID so you can join CatchAll results back to your systems. */
+    external_entity_id?: string | undefined;
     additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
 }

package/dist/cjs/api/types/EntityResponse.d.ts

@@ -9,6 +9,8 @@ export interface EntityResponse {
     name: string;
     /** Free-text description. */
     description?: (string | null) | undefined;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
     status: CatchAllApi.EntityStatus;
     /** ID of the user who created this entity. */

package/dist/cjs/api/types/EntitySummary.d.ts

@@ -14,5 +14,7 @@ export interface EntitySummary {
     status: CatchAllApi.EntityStatus;
     /** Free-text description. */
     description?: (string | null) | undefined;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     attributes?: CatchAllApi.CompanyAttributes | undefined;
 }

package/dist/cjs/api/types/PullJobResponseDto.d.ts

@@ -37,6 +37,10 @@ export interface PullJobResponseDto {
     total_pages?: number | undefined;
     /** Processing mode used for this job. */
     mode?: PullJobResponseDto.Mode | undefined;
+    /** Datasets used to narrow retrieval scope, each with `id` and `name`. */
+    connected_datasets?: CatchAllApi.ConnectedDataset[] | undefined;
+    /** True when the query was submitted as an all-news (watchlist-generic) query. */
+    is_all_news_query?: boolean | undefined;
     /** Present when the job was shared with the authenticated user by another organization member. `null` when the user owns the job. */
     sharing_info?: (CatchAllApi.SharingInfo | null) | undefined;
     /** Array of extracted records with structured data and citations. */

package/dist/cjs/api/types/PullMonitorResponseDto.d.ts

@@ -21,6 +21,10 @@ export interface PullMonitorResponseDto {
     all_records?: CatchAllApi.MonitorRecord[] | undefined;
     /** Record limit applied to this monitor's jobs. */
     limit?: (number | null) | undefined;
+    /** Datasets used to narrow retrieval scope, each with `id` and `name`. */
+    connected_datasets?: CatchAllApi.ConnectedDataset[] | undefined;
+    /** True when the reference job was submitted as an all-news (watchlist-generic) query. */
+    is_all_news_query?: boolean | undefined;
 }
 export declare namespace PullMonitorResponseDto {
     /**

package/dist/cjs/api/types/index.d.ts

@@ -8,6 +8,7 @@ export * from "./BearerAuthDto.js";
 export * from "./Citation.js";
 export * from "./CompanyAttributes.js";
 export * from "./CompanyEnrichmentOutput.js";
+export * from "./ConnectedDataset.js";
 export * from "./ConnectedEntity.js";
 export * from "./Context.js";
 export * from "./ContinueResponseDto.js";

package/dist/cjs/api/types/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./BearerAuthDto.js"), exports);
 __exportStar(require("./Citation.js"), exports);
 __exportStar(require("./CompanyAttributes.js"), exports);
 __exportStar(require("./CompanyEnrichmentOutput.js"), exports);
+__exportStar(require("./ConnectedDataset.js"), exports);
 __exportStar(require("./ConnectedEntity.js"), exports);
 __exportStar(require("./Context.js"), exports);
 __exportStar(require("./ContinueResponseDto.js"), exports);

package/dist/cjs/errors/CatchAllApiError.js

@@ -10,7 +10,7 @@ class CatchAllApiError extends Error {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "CatchAllApiError";
         this.statusCode = statusCode;
         this.body = body;
         this.rawResponse = rawResponse;

package/dist/cjs/errors/CatchAllApiTimeoutError.js

@@ -9,7 +9,7 @@ class CatchAllApiTimeoutError extends Error {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "CatchAllApiTimeoutError";
         if ((opts === null || opts === void 0 ? void 0 : opts.cause) != null) {
             this.cause = opts.cause;
         }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.0.1";
+export declare const SDK_VERSION = "4.0.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "3.0.1";
+exports.SDK_VERSION = "4.0.0";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "newscatcher-catchall-sdk",
-        "X-Fern-SDK-Version": "3.0.1",
-        "User-Agent": "newscatcher-catchall-sdk/3.0.1",
+        "X-Fern-SDK-Version": "4.0.0",
+        "User-Agent": "newscatcher-catchall-sdk/4.0.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/errors/BadRequestError.mjs

@@ -12,6 +12,6 @@ export class BadRequestError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "BadRequestError";
     }
 }

package/dist/esm/api/errors/ForbiddenError.mjs

@@ -12,6 +12,6 @@ export class ForbiddenError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "ForbiddenError";
     }
 }

package/dist/esm/api/errors/NotFoundError.mjs

@@ -12,6 +12,6 @@ export class NotFoundError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "NotFoundError";
     }
 }

package/dist/esm/api/errors/UnauthorizedError.mjs

@@ -12,6 +12,6 @@ export class UnauthorizedError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "UnauthorizedError";
     }
 }

package/dist/esm/api/errors/UnprocessableEntityError.mjs

@@ -12,6 +12,6 @@ export class UnprocessableEntityError extends errors.CatchAllApiError {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "UnprocessableEntityError";
     }
 }

package/dist/esm/api/resources/entities/client/requests/UpdateEntityRequest.d.mts

@@ -18,5 +18,7 @@ export interface UpdateEntityRequest {
     name?: string;
     /** Updated description. */
     description?: string;
+    /** Updated external identifier for this entity. */
+    external_entity_id?: string;
     additional_attributes?: CatchAllApi.AdditionalAttributes;
 }

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

@@ -117,6 +117,22 @@ export declare class JobsClient {
      */
     getJobResults(request: CatchAllApi.GetJobResultsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullJobResponseDto>;
     private __getJobResults;
+    /**
+     * Returns a completed job's result records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.GetJobResultsCsvRequest} request
+     * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.jobs.getJobResultsCsv({
+     *         job_id: "job_id"
+     *     })
+     */
+    getJobResultsCsv(request: CatchAllApi.GetJobResultsCsvRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __getJobResultsCsv;
     /**
      * Continue an existing job to process more records beyond the initial limit.
      *

package/dist/esm/api/resources/jobs/client/Client.mjs

@@ -379,6 +379,61 @@ export class JobsClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/pull/{job_id}");
         });
     }
+    /**
+     * Returns a completed job's result records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.GetJobResultsCsvRequest} request
+     * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.jobs.getJobResultsCsv({
+     *         job_id: "job_id"
+     *     })
+     */
+    getJobResultsCsv(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getJobResultsCsv(request, requestOptions));
+    }
+    __getJobResultsCsv(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { job_id: jobId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/pull/${core.url.encodePathParam(jobId)}/csv`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "text",
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/pull/{job_id}/csv");
+        });
+    }
     /**
      * Continue an existing job to process more records beyond the initial limit.
      *

package/dist/esm/api/resources/jobs/client/requests/GetJobResultsCsvRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         job_id: "job_id"
+ *     }
+ */
+export interface GetJobResultsCsvRequest {
+    /** Unique job identifier returned from [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/create-job). */
+    job_id: string;
+}

package/dist/esm/api/resources/jobs/client/requests/GetJobResultsCsvRequest.mjs

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

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

@@ -1,5 +1,6 @@
 export type { ContinueRequestDto } from "./ContinueRequestDto.mjs";
 export type { DeleteJobRequest } from "./DeleteJobRequest.mjs";
+export type { GetJobResultsCsvRequest } from "./GetJobResultsCsvRequest.mjs";
 export type { GetJobResultsRequest } from "./GetJobResultsRequest.mjs";
 export type { GetJobStatusRequest } from "./GetJobStatusRequest.mjs";
 export type { GetUserJobsRequest } from "./GetUserJobsRequest.mjs";

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

@@ -65,6 +65,22 @@ export declare class MonitorsClient {
      */
     pullMonitorResults(request: CatchAllApi.PullMonitorResultsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullMonitorResponseDto>;
     private __pullMonitorResults;
+    /**
+     * Returns the most recent run's records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.PullMonitorResultsCsvRequest} request
+     * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.monitors.pullMonitorResultsCsv({
+     *         monitor_id: "monitor_id"
+     *     })
+     */
+    pullMonitorResultsCsv(request: CatchAllApi.PullMonitorResultsCsvRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __pullMonitorResultsCsv;
     /**
      * Return all jobs executed by a monitor.
      *

package/dist/esm/api/resources/monitors/client/Client.mjs

@@ -210,6 +210,61 @@ export class MonitorsClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}");
         });
     }
+    /**
+     * Returns the most recent run's records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.PullMonitorResultsCsvRequest} request
+     * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.monitors.pullMonitorResultsCsv({
+     *         monitor_id: "monitor_id"
+     *     })
+     */
+    pullMonitorResultsCsv(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pullMonitorResultsCsv(request, requestOptions));
+    }
+    __pullMonitorResultsCsv(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { monitor_id: monitorId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/pull/${core.url.encodePathParam(monitorId)}/csv`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "text",
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}/csv");
+        });
+    }
     /**
      * Return all jobs executed by a monitor.
      *

package/dist/esm/api/resources/monitors/client/requests/PullMonitorResultsCsvRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         monitor_id: "monitor_id"
+ *     }
+ */
+export interface PullMonitorResultsCsvRequest {
+    /** Monitor identifier. */
+    monitor_id: string;
+}

package/dist/esm/api/resources/monitors/client/requests/PullMonitorResultsCsvRequest.mjs

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

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

@@ -5,5 +5,6 @@ export type { EnableMonitorRequestDto } from "./EnableMonitorRequestDto.mjs";
 export type { GetMonitorStatusHistoryRequest } from "./GetMonitorStatusHistoryRequest.mjs";
 export type { ListMonitorJobsRequest } from "./ListMonitorJobsRequest.mjs";
 export type { ListMonitorsRequest } from "./ListMonitorsRequest.mjs";
+export type { PullMonitorResultsCsvRequest } from "./PullMonitorResultsCsvRequest.mjs";
 export type { PullMonitorResultsRequest } from "./PullMonitorResultsRequest.mjs";
 export type { UpdateMonitorRequestDto } from "./UpdateMonitorRequestDto.mjs";

package/dist/esm/api/types/ConnectedDataset.d.mts

@@ -0,0 +1,11 @@
+/**
+ * A dataset used to narrow the retrieval scope of a job or monitor, returned with its identifier and name.
+ */
+export interface ConnectedDataset {
+    /** Dataset identifier. */
+    id: string;
+    /** Dataset name as stored. Check `is_deleted` to determine whether the dataset is still active. */
+    name: string;
+    /** True when the dataset has been deleted. */
+    is_deleted?: boolean | undefined;
+}

package/dist/esm/api/types/ConnectedDataset.mjs

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

package/dist/esm/api/types/ConnectedEntity.d.mts

@@ -26,6 +26,8 @@ export interface ConnectedEntity {
     association_type?: string | undefined;
     /** The entity type. */
     type: string;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     /**
      * The stored attributes for this entity. Present only when attributes exist in the database.
      *

package/dist/esm/api/types/CreateEntityRequest.d.mts

@@ -9,5 +9,7 @@ export interface CreateEntityRequest {
     entity_type?: CatchAllApi.EntityType | undefined;
     /** Free-text description of the entity used for disambiguation when similar names exist. */
     description?: string | undefined;
+    /** Optional external identifier for this entity. Free-form string, not enforced as unique. Use it to store your own CRM, data warehouse, or internal database ID so you can join CatchAll results back to your systems. */
+    external_entity_id?: string | undefined;
     additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
 }

package/dist/esm/api/types/EntityResponse.d.mts

@@ -9,6 +9,8 @@ export interface EntityResponse {
     name: string;
     /** Free-text description. */
     description?: (string | null) | undefined;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
     status: CatchAllApi.EntityStatus;
     /** ID of the user who created this entity. */

package/dist/esm/api/types/EntitySummary.d.mts

@@ -14,5 +14,7 @@ export interface EntitySummary {
     status: CatchAllApi.EntityStatus;
     /** Free-text description. */
     description?: (string | null) | undefined;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     attributes?: CatchAllApi.CompanyAttributes | undefined;
 }

package/dist/esm/api/types/PullJobResponseDto.d.mts

@@ -37,6 +37,10 @@ export interface PullJobResponseDto {
     total_pages?: number | undefined;
     /** Processing mode used for this job. */
     mode?: PullJobResponseDto.Mode | undefined;
+    /** Datasets used to narrow retrieval scope, each with `id` and `name`. */
+    connected_datasets?: CatchAllApi.ConnectedDataset[] | undefined;
+    /** True when the query was submitted as an all-news (watchlist-generic) query. */
+    is_all_news_query?: boolean | undefined;
     /** Present when the job was shared with the authenticated user by another organization member. `null` when the user owns the job. */
     sharing_info?: (CatchAllApi.SharingInfo | null) | undefined;
     /** Array of extracted records with structured data and citations. */

package/dist/esm/api/types/PullMonitorResponseDto.d.mts

@@ -21,6 +21,10 @@ export interface PullMonitorResponseDto {
     all_records?: CatchAllApi.MonitorRecord[] | undefined;
     /** Record limit applied to this monitor's jobs. */
     limit?: (number | null) | undefined;
+    /** Datasets used to narrow retrieval scope, each with `id` and `name`. */
+    connected_datasets?: CatchAllApi.ConnectedDataset[] | undefined;
+    /** True when the reference job was submitted as an all-news (watchlist-generic) query. */
+    is_all_news_query?: boolean | undefined;
 }
 export declare namespace PullMonitorResponseDto {
     /**

package/dist/esm/api/types/index.d.mts

@@ -8,6 +8,7 @@ export * from "./BearerAuthDto.mjs";
 export * from "./Citation.mjs";
 export * from "./CompanyAttributes.mjs";
 export * from "./CompanyEnrichmentOutput.mjs";
+export * from "./ConnectedDataset.mjs";
 export * from "./ConnectedEntity.mjs";
 export * from "./Context.mjs";
 export * from "./ContinueResponseDto.mjs";

package/dist/esm/api/types/index.mjs

@@ -8,6 +8,7 @@ export * from "./BearerAuthDto.mjs";
 export * from "./Citation.mjs";
 export * from "./CompanyAttributes.mjs";
 export * from "./CompanyEnrichmentOutput.mjs";
+export * from "./ConnectedDataset.mjs";
 export * from "./ConnectedEntity.mjs";
 export * from "./Context.mjs";
 export * from "./ContinueResponseDto.mjs";

package/dist/esm/errors/CatchAllApiError.mjs

@@ -7,7 +7,7 @@ export class CatchAllApiError extends Error {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "CatchAllApiError";
         this.statusCode = statusCode;
         this.body = body;
         this.rawResponse = rawResponse;

package/dist/esm/errors/CatchAllApiTimeoutError.mjs

@@ -6,7 +6,7 @@ export class CatchAllApiTimeoutError extends Error {
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
+        this.name = "CatchAllApiTimeoutError";
         if ((opts === null || opts === void 0 ? void 0 : opts.cause) != null) {
             this.cause = opts.cause;
         }

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.0.1";
+export declare const SDK_VERSION = "4.0.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "3.0.1";
+export const SDK_VERSION = "4.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "newscatcher-catchall-sdk",
-    "version": "3.0.1",
+    "version": "4.0.0",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -394,6 +394,71 @@ await client.jobs.getJobResults({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getJobResultsCsv</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a completed job's result records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.jobs.getJobResultsCsv({
+    job_id: "job_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.GetJobResultsCsvRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `JobsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -730,6 +795,71 @@ await client.monitors.pullMonitorResults({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">pullMonitorResultsCsv</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the most recent run's records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.monitors.pullMonitorResultsCsv({
+    monitor_id: "monitor_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.PullMonitorResultsCsvRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MonitorsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>