newscatcher-catchall-sdk 1.3.1 → 1.4.0

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

@@ -10,7 +10,9 @@ exports.EnrichmentType = void 0;
  * - `date`: ISO format dates (YYYY-MM-DD)
  * - `option`: Enum-like fixed values (status, category)
  * - `url`: Web URLs
- * - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`. See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
+ * - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`.
+ *
+ * See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
  */
 exports.EnrichmentType = {
     Text: "text",

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

@@ -0,0 +1,11 @@
+import type * as CatchAllApi from "../index.js";
+export interface EntityListResponse {
+    /** Array of entity objects for this page. */
+    entities: CatchAllApi.EntityResponse[];
+    /** Total number of entities matching the filter criteria. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of entities per page. */
+    page_size: number;
+}

package/dist/cjs/api/types/EntityListResponse.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/EntityResponse.d.ts

@@ -0,0 +1,20 @@
+import type * as CatchAllApi from "../index.js";
+export interface EntityResponse {
+    /** Unique identifier of the entity. */
+    id: string;
+    entity_type: CatchAllApi.EntityType;
+    /** Organization that owns this entity. */
+    organization_id: string;
+    /** Entity name. */
+    name: string;
+    /** Free-text description. */
+    description?: (string | null) | undefined;
+    additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
+    status: CatchAllApi.EntityStatus;
+    /** ID of the user who created this entity. */
+    created_by_user_id?: string | undefined;
+    /** ISO 8601 timestamp of when the entity was created. Returned without timezone offset (server-local time). */
+    created_at?: string | undefined;
+    /** ISO 8601 timestamp of when the entity was last updated. Returned without timezone offset (server-local time). */
+    updated_at?: string | undefined;
+}

package/dist/cjs/api/types/EntityResponse.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/EntitySortBy.d.ts

@@ -0,0 +1,7 @@
+/** Fields available for sorting entity list results. */
+export declare const EntitySortBy: {
+    readonly CreatedAt: "created_at";
+    readonly Name: "name";
+    readonly Status: "status";
+};
+export type EntitySortBy = (typeof EntitySortBy)[keyof typeof EntitySortBy];

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

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntitySortBy = void 0;
+/** Fields available for sorting entity list results. */
+exports.EntitySortBy = {
+    CreatedAt: "created_at",
+    Name: "name",
+    Status: "status",
+};

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

@@ -0,0 +1,15 @@
+/**
+ * Processing status of an entity.
+ *
+ * - `pending`: Entity has been created and is queued for enrichment.
+ * - `enriching`: Enrichment is in progress.
+ * - `ready`: Enrichment complete — entity is indexed and ready for use in jobs.
+ * - `failed`: Enrichment failed. The entity may still be used but matching quality may be reduced.
+ */
+export declare const EntityStatus: {
+    readonly Pending: "pending";
+    readonly Enriching: "enriching";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type EntityStatus = (typeof EntityStatus)[keyof typeof EntityStatus];

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

@@ -0,0 +1,18 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityStatus = void 0;
+/**
+ * Processing status of an entity.
+ *
+ * - `pending`: Entity has been created and is queued for enrichment.
+ * - `enriching`: Enrichment is in progress.
+ * - `ready`: Enrichment complete — entity is indexed and ready for use in jobs.
+ * - `failed`: Enrichment failed. The entity may still be used but matching quality may be reduced.
+ */
+exports.EntityStatus = {
+    Pending: "pending",
+    Enriching: "enriching",
+    Ready: "ready",
+    Failed: "failed",
+};

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

@@ -0,0 +1,18 @@
+import type * as CatchAllApi from "../index.js";
+/**
+ * Abbreviated entity object returned when listing entities within a
+ * dataset. Uses a flat `attributes` key rather than the nested
+ * `additional_attributes.company_attributes` structure used in
+ * standalone entity endpoints.
+ */
+export interface EntitySummary {
+    /** Unique identifier of the entity. */
+    id: string;
+    /** Entity name. */
+    name: string;
+    entity_type: CatchAllApi.EntityType;
+    status: CatchAllApi.EntityStatus;
+    /** Free-text description. */
+    description?: (string | null) | undefined;
+    attributes?: CatchAllApi.CompanyAttributes | undefined;
+}

package/dist/cjs/api/types/EntitySummary.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/EntityType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The type of entity.
+ *
+ * - `company`: A company or organization (default).
+ * - `person`: An individual person.
+ */
+export declare const EntityType: {
+    readonly Company: "company";
+    readonly Person: "person";
+};
+export type EntityType = (typeof EntityType)[keyof typeof EntityType];

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

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityType = void 0;
+/**
+ * The type of entity.
+ *
+ * - `company`: A company or organization (default).
+ * - `person`: An individual person.
+ */
+exports.EntityType = {
+    Company: "company",
+    Person: "person",
+};

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

@@ -0,0 +1,16 @@
+/**
+ * Error body returned by entity endpoints for field-level validation
+ * failures. Uses a different structure from the standard `Error` schema
+ * (`{"detail": "..."}`) used elsewhere in the API.
+ */
+export interface EntityValidationErrorBody {
+    /**
+     * Human-readable description of all validation errors, including
+     * field path, failure message, and error type.
+     */
+    message: string;
+    /** HTTP status text. */
+    status: string;
+    /** HTTP status code. */
+    status_code: number;
+}

package/dist/cjs/api/types/EntityValidationErrorBody.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/ManageEntitiesResponse.d.ts

@@ -0,0 +1,6 @@
+export interface ManageEntitiesResponse {
+    /** ID of the dataset that was modified. */
+    dataset_id: string;
+    /** Number of entities that were added or removed. */
+    affected_count: number;
+}

package/dist/cjs/api/types/ManageEntitiesResponse.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/MonitorRecord.d.ts

@@ -1,6 +1,7 @@
 import type * as CatchAllApi from "../index.js";
 /**
  * Record with monitor-specific metadata. Used in monitor results and webhook payloads.
+ *
  * Includes timestamps tracking when records were added and updated, and citations include job tracking.
  */
 export interface MonitorRecord extends CatchAllApi.BaseRecord {

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

@@ -2,4 +2,9 @@ import type * as CatchAllApi from "../index.js";
 export interface Record_ extends CatchAllApi.BaseRecord {
     /** Source documents that were used to extract this record. */
     citations: CatchAllApi.Citation[];
+    /**
+     * Entities from the connected dataset that are relevant to this record.
+     * Only present when the job was submitted with `connected_dataset_ids`.
+     */
+    connected_entities?: CatchAllApi.ConnectedEntity[] | undefined;
 }

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

@@ -0,0 +1,13 @@
+/**
+ * Details about a CSV row that was skipped during processing.
+ */
+export interface SkippedRow {
+    /**
+     * 1-based row number in the CSV file (including the header row).
+     *
+     * A value of `3` means the third line of the file (second data row).
+     */
+    row: number;
+    /** Human-readable explanation of why the row was skipped. */
+    reason: string;
+}

package/dist/cjs/api/types/SkippedRow.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/SortOrder.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Sort direction for list results.
+ *
+ * - `asc`: ascending (oldest or smallest first)
+ * - `desc`: descending (newest or largest first)
+ */
+export declare const SortOrder: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];

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

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = void 0;
+/**
+ * Sort direction for list results.
+ *
+ * - `asc`: ascending (oldest or smallest first)
+ * - `desc`: descending (newest or largest first)
+ */
+exports.SortOrder = {
+    Asc: "asc",
+    Desc: "desc",
+};

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

@@ -0,0 +1,8 @@
+import type * as CatchAllApi from "../index.js";
+export interface UploadCsvToDatasetResponse {
+    /** ID of the dataset that was updated. */
+    dataset_id: string;
+    /** Number of new entities created from the CSV. */
+    entities_created: number;
+    validation_report: CatchAllApi.ValidationReport;
+}

package/dist/cjs/api/types/UploadCsvToDatasetResponse.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/ValidationReport.d.ts

@@ -0,0 +1,17 @@
+import type * as CatchAllApi from "../index.js";
+/**
+ * Summary of CSV processing results.
+ */
+export interface ValidationReport {
+    /**
+     * Total number of data rows in the uploaded CSV (excluding the
+     * header row).
+     */
+    total_rows: number;
+    /** Number of rows successfully processed into entities. */
+    valid_rows: number;
+    /** Number of rows skipped due to validation errors. */
+    skipped_count: number;
+    /** Details for each skipped row. */
+    skipped_rows: CatchAllApi.SkippedRow[];
+}

package/dist/cjs/api/types/ValidationReport.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/index.d.ts

@@ -1,12 +1,34 @@
+export * from "./AdditionalAttributes.js";
 export * from "./BaseRecord.js";
 export * from "./Citation.js";
+export * from "./CompanyAttributes.js";
 export * from "./CompanyEnrichmentOutput.js";
+export * from "./ConnectedEntity.js";
 export * from "./Context.js";
 export * from "./ContinueResponseDto.js";
+export * from "./CreateDatasetCsvResponse.js";
+export * from "./CreateEntitiesBatchResponse.js";
+export * from "./CreateEntityRequest.js";
+export * from "./CreateEntityResponse.js";
 export * from "./CreateMonitorResponseDto.js";
+export * from "./DatasetEntityIdsRequest.js";
+export * from "./DatasetEntityListResponse.js";
+export * from "./DatasetListResponse.js";
+export * from "./DatasetResponse.js";
+export * from "./DatasetSortBy.js";
+export * from "./DatasetStatus.js";
+export * from "./DatasetStatusEntry.js";
+export * from "./DatasetStatusHistoryResponse.js";
 export * from "./EndDate.js";
 export * from "./EnrichmentSchema.js";
 export * from "./EnrichmentType.js";
+export * from "./EntityListResponse.js";
+export * from "./EntityResponse.js";
+export * from "./EntitySortBy.js";
+export * from "./EntityStatus.js";
+export * from "./EntitySummary.js";
+export * from "./EntityType.js";
+export * from "./EntityValidationErrorBody.js";
 export * from "./Error_.js";
 export * from "./GetPlanLimitsResponseDto.js";
 export * from "./InitializeResponseDto.js";
@@ -14,6 +36,7 @@ export * from "./JobStep.js";
 export * from "./Limit.js";
 export * from "./ListMonitorsResponseDto.js";
 export * from "./ListUserJobsResponseDto.js";
+export * from "./ManageEntitiesResponse.js";
 export * from "./MonitorCitation.js";
 export * from "./MonitorJobItem.js";
 export * from "./MonitorListItemDto.js";
@@ -25,13 +48,17 @@ export * from "./PullMonitorResponseDto.js";
 export * from "./Query.js";
 export * from "./Record_.js";
 export * from "./ReferenceJob.js";
+export * from "./SkippedRow.js";
+export * from "./SortOrder.js";
 export * from "./StartDate.js";
 export * from "./StatusResponseDto.js";
 export * from "./SubmitResponseDto.js";
 export * from "./UpdateMonitorResponseDto.js";
+export * from "./UploadCsvToDatasetResponse.js";
 export * from "./UserJob.js";
 export * from "./ValidationErrorDetail.js";
 export * from "./ValidationErrorResponse.js";
+export * from "./ValidationReport.js";
 export * from "./ValidatorSchema.js";
 export * from "./WebhookDto.js";
 export * from "./WebhookPayload.js";

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

@@ -14,15 +14,37 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AdditionalAttributes.js"), exports);
 __exportStar(require("./BaseRecord.js"), exports);
 __exportStar(require("./Citation.js"), exports);
+__exportStar(require("./CompanyAttributes.js"), exports);
 __exportStar(require("./CompanyEnrichmentOutput.js"), exports);
+__exportStar(require("./ConnectedEntity.js"), exports);
 __exportStar(require("./Context.js"), exports);
 __exportStar(require("./ContinueResponseDto.js"), exports);
+__exportStar(require("./CreateDatasetCsvResponse.js"), exports);
+__exportStar(require("./CreateEntitiesBatchResponse.js"), exports);
+__exportStar(require("./CreateEntityRequest.js"), exports);
+__exportStar(require("./CreateEntityResponse.js"), exports);
 __exportStar(require("./CreateMonitorResponseDto.js"), exports);
+__exportStar(require("./DatasetEntityIdsRequest.js"), exports);
+__exportStar(require("./DatasetEntityListResponse.js"), exports);
+__exportStar(require("./DatasetListResponse.js"), exports);
+__exportStar(require("./DatasetResponse.js"), exports);
+__exportStar(require("./DatasetSortBy.js"), exports);
+__exportStar(require("./DatasetStatus.js"), exports);
+__exportStar(require("./DatasetStatusEntry.js"), exports);
+__exportStar(require("./DatasetStatusHistoryResponse.js"), exports);
 __exportStar(require("./EndDate.js"), exports);
 __exportStar(require("./EnrichmentSchema.js"), exports);
 __exportStar(require("./EnrichmentType.js"), exports);
+__exportStar(require("./EntityListResponse.js"), exports);
+__exportStar(require("./EntityResponse.js"), exports);
+__exportStar(require("./EntitySortBy.js"), exports);
+__exportStar(require("./EntityStatus.js"), exports);
+__exportStar(require("./EntitySummary.js"), exports);
+__exportStar(require("./EntityType.js"), exports);
+__exportStar(require("./EntityValidationErrorBody.js"), exports);
 __exportStar(require("./Error_.js"), exports);
 __exportStar(require("./GetPlanLimitsResponseDto.js"), exports);
 __exportStar(require("./InitializeResponseDto.js"), exports);
@@ -30,6 +52,7 @@ __exportStar(require("./JobStep.js"), exports);
 __exportStar(require("./Limit.js"), exports);
 __exportStar(require("./ListMonitorsResponseDto.js"), exports);
 __exportStar(require("./ListUserJobsResponseDto.js"), exports);
+__exportStar(require("./ManageEntitiesResponse.js"), exports);
 __exportStar(require("./MonitorCitation.js"), exports);
 __exportStar(require("./MonitorJobItem.js"), exports);
 __exportStar(require("./MonitorListItemDto.js"), exports);
@@ -41,13 +64,17 @@ __exportStar(require("./PullMonitorResponseDto.js"), exports);
 __exportStar(require("./Query.js"), exports);
 __exportStar(require("./Record_.js"), exports);
 __exportStar(require("./ReferenceJob.js"), exports);
+__exportStar(require("./SkippedRow.js"), exports);
+__exportStar(require("./SortOrder.js"), exports);
 __exportStar(require("./StartDate.js"), exports);
 __exportStar(require("./StatusResponseDto.js"), exports);
 __exportStar(require("./SubmitResponseDto.js"), exports);
 __exportStar(require("./UpdateMonitorResponseDto.js"), exports);
+__exportStar(require("./UploadCsvToDatasetResponse.js"), exports);
 __exportStar(require("./UserJob.js"), exports);
 __exportStar(require("./ValidationErrorDetail.js"), exports);
 __exportStar(require("./ValidationErrorResponse.js"), exports);
+__exportStar(require("./ValidationReport.js"), exports);
 __exportStar(require("./ValidatorSchema.js"), exports);
 __exportStar(require("./WebhookDto.js"), exports);
 __exportStar(require("./WebhookPayload.js"), exports);

package/dist/cjs/core/auth/BasicAuth.d.ts

@@ -1,6 +1,6 @@
 export interface BasicAuth {
-    username: string;
-    password: string;
+    username?: string;
+    password?: string;
 }
 export declare const BasicAuth: {
     toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;

package/dist/cjs/core/auth/BasicAuth.js

@@ -5,10 +5,16 @@ const base64_js_1 = require("../base64.js");
 const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
 exports.BasicAuth = {
     toAuthorizationHeader: (basicAuth) => {
+        var _a, _b;
         if (basicAuth == null) {
             return undefined;
         }
-        const token = (0, base64_js_1.base64Encode)(`${basicAuth.username}:${basicAuth.password}`);
+        const username = (_a = basicAuth.username) !== null && _a !== void 0 ? _a : "";
+        const password = (_b = basicAuth.password) !== null && _b !== void 0 ? _b : "";
+        if (username === "" && password === "") {
+            return undefined;
+        }
+        const token = (0, base64_js_1.base64Encode)(`${username}:${password}`);
         return `Basic ${token}`;
     },
     fromAuthorizationHeader: (header) => {

package/dist/cjs/core/exports.d.ts

@@ -1 +1,2 @@
+export * from "./file/exports.js";
 export * from "./logging/exports.js";

package/dist/cjs/core/exports.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./file/exports.js"), exports);
 __exportStar(require("./logging/exports.js"), exports);

package/dist/cjs/core/fetcher/Fetcher.d.ts

@@ -38,10 +38,12 @@ export declare namespace Fetcher {
     }
     interface TimeoutError {
         reason: "timeout";
+        cause?: unknown;
     }
     interface UnknownError {
         reason: "unknown";
         errorMessage: string;
+        cause?: unknown;
     }
 }
 export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;

package/dist/cjs/core/fetcher/Fetcher.js

@@ -261,6 +261,7 @@ function fetcherImpl(args) {
                     error: {
                         reason: "unknown",
                         errorMessage: "The user aborted a request",
+                        cause: error,
                     },
                     rawResponse: RawResponse_js_1.abortRawResponse,
                 };
@@ -278,6 +279,7 @@ function fetcherImpl(args) {
                     ok: false,
                     error: {
                         reason: "timeout",
+                        cause: error,
                     },
                     rawResponse: RawResponse_js_1.abortRawResponse,
                 };
@@ -296,6 +298,7 @@ function fetcherImpl(args) {
                     error: {
                         reason: "unknown",
                         errorMessage: error.message,
+                        cause: error,
                     },
                     rawResponse: RawResponse_js_1.unknownRawResponse,
                 };
@@ -313,6 +316,7 @@ function fetcherImpl(args) {
                 error: {
                     reason: "unknown",
                     errorMessage: (0, json_js_1.toJson)(error),
+                    cause: error,
                 },
                 rawResponse: RawResponse_js_1.unknownRawResponse,
             };

package/dist/cjs/core/file/exports.d.ts

@@ -0,0 +1 @@
+export type { Uploadable } from "./types.js";

package/dist/cjs/core/file/exports.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/core/file/file.d.ts

@@ -0,0 +1,10 @@
+import type { Uploadable } from "./types.js";
+export declare function toBinaryUploadRequest(file: Uploadable): Promise<{
+    body: Uploadable.FileLike;
+    headers?: Record<string, string>;
+}>;
+export declare function toMultipartDataPart(file: Uploadable): Promise<{
+    data: Uploadable.FileLike;
+    filename?: string;
+    contentType?: string;
+}>;