newscatcher-catchall-sdk 3.0.1 → 4.0.1

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";
@@ -44,6 +45,7 @@ export * from "./EntitySummary.mjs";
 export * from "./EntityType.mjs";
 export * from "./EntityValidationErrorBody.mjs";
 export * from "./Error_.mjs";
+export * from "./FormatterConfigDto.mjs";
 export * from "./GetPlanLimitsResponseDto.mjs";
 export * from "./GetWebhookResponseDto.mjs";
 export * from "./HttpMethod.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";
@@ -44,6 +45,7 @@ export * from "./EntitySummary.mjs";
 export * from "./EntityType.mjs";
 export * from "./EntityValidationErrorBody.mjs";
 export * from "./Error_.mjs";
+export * from "./FormatterConfigDto.mjs";
 export * from "./GetPlanLimitsResponseDto.mjs";
 export * from "./GetWebhookResponseDto.mjs";
 export * from "./HttpMethod.mjs";

package/dist/esm/core/file/file.mjs

@@ -41,6 +41,9 @@ export function toMultipartDataPart(file) {
 function getFileWithMetadata(file_1) {
     return __awaiter(this, arguments, void 0, function* (file, { noSniffFileSize } = {}) {
         var _a, _b, _c, _d, _e;
+        if (file == null) {
+            throw new Error(`Expected file to be a Blob, Buffer, ReadableStream, or an object with a "path" or "data" property, but received ${file === null ? "null" : "undefined"}.`);
+        }
         if (isFileLike(file)) {
             return getFileWithMetadata({
                 data: file,

package/dist/esm/core/form-data-utils/FormDataWrapper.mjs

@@ -36,6 +36,9 @@ export class FormDataWrapper {
     }
     appendFile(key, value) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (value == null) {
+                throw new Error(`File upload for "${key}" received ${value === null ? "null" : "undefined"}. The generated code should not call appendFile with null/undefined — check that optional file fields are guarded before this call.`);
+            }
             const { data, filename, contentType } = yield toMultipartDataPart(value);
             const blob = yield convertToBlob(data, contentType);
             if (filename) {

package/dist/esm/core/requestBody.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
+ * additional body parameters are provided, the original body is returned unchanged so serialization
+ * is unaffected.
+ *
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
+ * SDK, which only merges additional body parameters into mapping bodies.
+ */
+export declare function mergeAdditionalBodyParameters(body: unknown, additionalBodyParameters: Record<string, unknown> | undefined): unknown;

package/dist/esm/core/requestBody.mjs

@@ -0,0 +1,23 @@
+/**
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
+ * additional body parameters are provided, the original body is returned unchanged so serialization
+ * is unaffected.
+ *
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
+ * SDK, which only merges additional body parameters into mapping bodies.
+ */
+export function mergeAdditionalBodyParameters(body, additionalBodyParameters) {
+    if (additionalBodyParameters == null) {
+        return body;
+    }
+    if (body == null) {
+        return Object.assign({}, additionalBodyParameters);
+    }
+    if (typeof body === "object" && !Array.isArray(body)) {
+        return Object.assign(Object.assign({}, body), additionalBodyParameters);
+    }
+    return body;
+}

package/dist/esm/core/url/qs.mjs

@@ -16,7 +16,7 @@ function stringifyObject(obj, prefix = "", options) {
     const parts = [];
     for (const [key, value] of Object.entries(obj)) {
         const fullKey = prefix ? `${prefix}[${key}]` : key;
-        if (value === undefined) {
+        if (value == null) {
             continue;
         }
         if (Array.isArray(value)) {
@@ -36,7 +36,7 @@ function stringifyObject(obj, prefix = "", options) {
             else {
                 for (let i = 0; i < value.length; i++) {
                     const item = value[i];
-                    if (item === undefined) {
+                    if (item == null) {
                         continue;
                     }
                     if (typeof item === "object" && !Array.isArray(item) && item !== null) {

package/dist/esm/errors/CatchAllApiError.d.mts

@@ -11,4 +11,5 @@ export declare class CatchAllApiError extends Error {
         rawResponse?: core.RawResponse;
         cause?: unknown;
     });
+    get requestId(): string | undefined;
 }

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;
@@ -15,6 +15,10 @@ export class CatchAllApiError extends Error {
             this.cause = cause;
         }
     }
+    get requestId() {
+        var _a, _b, _c;
+        return (_c = (_b = (_a = this.rawResponse) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b.get("x-request-id")) !== null && _c !== void 0 ? _c : undefined;
+    }
 }
 function buildMessage({ message, statusCode, body, }) {
     const lines = [];

package/dist/esm/errors/CatchAllApiTimeoutError.d.mts

@@ -1,5 +1,5 @@
-export declare class CatchAllApiTimeoutError extends Error {
-    readonly cause?: unknown;
+import * as errors from "./index.mjs";
+export declare class CatchAllApiTimeoutError extends errors.CatchAllApiError {
     constructor(message: string, opts?: {
         cause?: unknown;
     });

package/dist/esm/errors/CatchAllApiTimeoutError.mjs

@@ -1,14 +1,15 @@
 // This file was auto-generated by Fern from our API Definition.
-export class CatchAllApiTimeoutError extends Error {
+import * as errors from "./index.mjs";
+export class CatchAllApiTimeoutError extends errors.CatchAllApiError {
     constructor(message, opts) {
-        super(message);
+        super({
+            message: message,
+            cause: opts === null || opts === void 0 ? void 0 : opts.cause,
+        });
         Object.setPrototypeOf(this, new.target.prototype);
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
-        this.name = this.constructor.name;
-        if ((opts === null || opts === void 0 ? void 0 : opts.cause) != null) {
-            this.cause = opts.cause;
-        }
+        this.name = "CatchAllApiTimeoutError";
     }
 }

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "newscatcher-catchall-sdk",
-    "version": "3.0.1",
+    "version": "4.0.1",
     "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>
@@ -1802,6 +1932,79 @@ await client.webhooks.listWebhooksForResource({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">triggerWebhook</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Manually dispatches a webhook delivery for a resource on demand, without
+waiting for the next job or monitor cycle.
+
+Use this to re-deliver results after a failed delivery, replay a specific
+job's results, or validate a webhook against live data. The webhook must
+already be assigned to the resource.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.webhooks.triggerWebhook({
+    resource_type: "job",
+    resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4",
+    webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+    job_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.TriggerWebhookRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebhooksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1954,10 +2157,10 @@ await client.entities.listEntities({
 
 Creates a new company entity and begins background enrichment.
 
+Each entity requires a `name` plus at least one of: a `description` or a `domain`. Providing both is recommended — `domain` is the highest-signal identifier because it is unambiguous; a well-written `description` is the best alternative when no domain is available.
+
 The entity status starts as `pending` and transitions to `ready` once
-enrichment completes. Provide as much identifying information as
-possible — `domain` is the highest-signal field because it is
-unambiguous.
+enrichment completes.
 </dd>
 </dl>
 </dd>
@@ -1975,12 +2178,12 @@ unambiguous.
 await client.entities.createEntity({
     name: "NewsCatcher",
     entity_type: "company",
-    description: "AI-powered news data provider",
+    description: "NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries).",
     additional_attributes: {
         company_attributes: {
             domain: "newscatcherapi.com",
             key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
-            alternative_names: ["NC", "NewsCatcher API"]
+            alternative_names: ["NewsCatcher CatchAll", "NewsCatcher API"]
         }
     }
 });
@@ -2033,6 +2236,8 @@ await client.entities.createEntity({
 
 Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
 
+Each entity requires a `name` plus at least one of: a `description` or a `domain`. See [Create entity](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entity) for the full field reference.
+
 Returns an array of `{id, status}` objects in the same order as the input array.
 </dd>
 </dl>
@@ -2270,7 +2475,7 @@ await client.entities.updateEntity({
     description: "Updated description",
     additional_attributes: {
         company_attributes: {
-            alternative_names: ["NC", "NewsCatcher API", "NCA"]
+            alternative_names: ["NewsCatcher CatchAll", "NewsCatcher API", "NCA"]
         }
     }
 });
@@ -2388,7 +2593,9 @@ await client.datasets.listDatasets({
 <dl>
 <dd>
 
-Creates a new dataset from a list of existing entity IDs.
+Creates a new dataset from a list of existing entity IDs. The optional `description` field here describes the dataset itself — it is separate from the entity-level `description` used for matching.
+
+Entities must be created before adding them to a dataset. Each entity requires a `name` plus at least one of: a `description` or a `domain`. Use [Create entity](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entity) or [Create entities batch](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entities-batch) to create entities first.
 
 If any of the provided entity IDs do not exist or do not belong to
 your organization, the request fails with `400`. All entity IDs must
@@ -2462,12 +2669,12 @@ await client.datasets.createDataset({
 <dl>
 <dd>
 
-Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
+Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. Each row requires a `name` plus at least one of: a `description` or a `domain`; all other columns are optional. Note: `description` in the CSV is the entity's matching description — it is separate from the dataset-level `description` field in the form data.
 
 **CSV format:**
 ```csv
 name,description,domain,alternative_names,key_persons
-NewsCatcher,"AI-powered news data provider",newscatcherapi.com,"NC;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
+NewsCatcher,"NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries).",newscatcherapi.com,"NewsCatcher CatchAll;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
 OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
 ```