newscatcher-catchall-sdk 1.3.1 → 1.4.0

package/reference.md

@@ -1,5 +1,68 @@
 # Reference
 ## Jobs
+<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getUserJobs</a>({ ...params }) -> CatchAllApi.ListUserJobsResponseDto</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns all jobs created by the authenticated user.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.jobs.getUserJobs();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.GetUserJobsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `JobsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">initialize</a>({ ...params }) -> CatchAllApi.InitializeResponseDto</code></summary>
 <dl>
 <dd>
@@ -136,7 +199,7 @@ await client.jobs.createJob({
 </dl>
 </details>
 
-<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">continueJob</a>({ ...params }) -> CatchAllApi.ContinueResponseDto</code></summary>
+<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getJobStatus</a>({ ...params }) -> CatchAllApi.StatusResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -148,7 +211,7 @@ await client.jobs.createJob({
 <dl>
 <dd>
 
-Continue an existing job to process more records beyond the initial limit.
+Retrieve the current processing status of a job.
 </dd>
 </dl>
 </dd>
@@ -163,9 +226,8 @@ Continue an existing job to process more records beyond the initial limit.
 <dd>
 
 ```typescript
-await client.jobs.continueJob({
-    job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
-    new_limit: 100
+await client.jobs.getJobStatus({
+    job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
 });
 
 ```
@@ -182,7 +244,7 @@ await client.jobs.continueJob({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.ContinueRequestDto` 
+**request:** `CatchAllApi.GetJobStatusRequest` 
     
 </dd>
 </dl>
@@ -202,7 +264,7 @@ await client.jobs.continueJob({
 </dl>
 </details>
 
-<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getJobStatus</a>({ ...params }) -> CatchAllApi.StatusResponseDto</code></summary>
+<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getJobResults</a>({ ...params }) -> CatchAllApi.PullJobResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -214,7 +276,7 @@ await client.jobs.continueJob({
 <dl>
 <dd>
 
-Retrieve the current processing status of a job.
+Retrieve the final results for a completed job.
 </dd>
 </dl>
 </dd>
@@ -229,7 +291,7 @@ Retrieve the current processing status of a job.
 <dd>
 
 ```typescript
-await client.jobs.getJobStatus({
+await client.jobs.getJobResults({
     job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
 });
 
@@ -247,7 +309,7 @@ await client.jobs.getJobStatus({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.GetJobStatusRequest` 
+**request:** `CatchAllApi.GetJobResultsRequest` 
     
 </dd>
 </dl>
@@ -267,7 +329,7 @@ await client.jobs.getJobStatus({
 </dl>
 </details>
 
-<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getUserJobs</a>({ ...params }) -> CatchAllApi.ListUserJobsResponseDto</code></summary>
+<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">continueJob</a>({ ...params }) -> CatchAllApi.ContinueResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -279,7 +341,7 @@ await client.jobs.getJobStatus({
 <dl>
 <dd>
 
-Returns all jobs created by the authenticated user.
+Continue an existing job to process more records beyond the initial limit.
 </dd>
 </dl>
 </dd>
@@ -294,7 +356,10 @@ Returns all jobs created by the authenticated user.
 <dd>
 
 ```typescript
-await client.jobs.getUserJobs();
+await client.jobs.continueJob({
+    job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
+    new_limit: 100
+});
 
 ```
 </dd>
@@ -310,7 +375,7 @@ await client.jobs.getUserJobs();
 <dl>
 <dd>
 
-**request:** `CatchAllApi.GetUserJobsRequest` 
+**request:** `CatchAllApi.ContinueRequestDto` 
     
 </dd>
 </dl>
@@ -330,7 +395,8 @@ await client.jobs.getUserJobs();
 </dl>
 </details>
 
-<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getJobResults</a>({ ...params }) -> CatchAllApi.PullJobResponseDto</code></summary>
+## Monitors
+<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">listMonitors</a>({ ...params }) -> CatchAllApi.ListMonitorsResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -342,7 +408,7 @@ await client.jobs.getUserJobs();
 <dl>
 <dd>
 
-Retrieve the final results for a completed job.
+Returns all monitors created by the authenticated user.
 </dd>
 </dl>
 </dd>
@@ -357,9 +423,7 @@ Retrieve the final results for a completed job.
 <dd>
 
 ```typescript
-await client.jobs.getJobResults({
-    job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
-});
+await client.monitors.listMonitors();
 
 ```
 </dd>
@@ -375,7 +439,7 @@ await client.jobs.getJobResults({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.GetJobResultsRequest` 
+**request:** `CatchAllApi.ListMonitorsRequest` 
     
 </dd>
 </dl>
@@ -383,7 +447,7 @@ await client.jobs.getJobResults({
 <dl>
 <dd>
 
-**requestOptions:** `JobsClient.RequestOptions` 
+**requestOptions:** `MonitorsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -395,7 +459,6 @@ await client.jobs.getJobResults({
 </dl>
 </details>
 
-## Monitors
 <details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">createMonitor</a>({ ...params }) -> CatchAllApi.CreateMonitorResponseDto</code></summary>
 <dl>
 <dd>
@@ -471,7 +534,7 @@ await client.monitors.createMonitor({
 </dl>
 </details>
 
-<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">updateMonitor</a>({ ...params }) -> CatchAllApi.UpdateMonitorResponseDto</code></summary>
+<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">pullMonitorResults</a>({ ...params }) -> CatchAllApi.PullMonitorResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -483,7 +546,7 @@ await client.monitors.createMonitor({
 <dl>
 <dd>
 
-Update the webhook configuration for an existing monitor.
+Retrieve aggregated results from all jobs executed by a monitor.
 </dd>
 </dl>
 </dd>
@@ -498,15 +561,8 @@ Update the webhook configuration for an existing monitor.
 <dd>
 
 ```typescript
-await client.monitors.updateMonitor({
-    monitor_id: "monitor_id",
-    webhook: {
-        url: "https://new-endpoint.com/webhook",
-        method: "POST",
-        headers: {
-            "Authorization": "Bearer new_token_xyz"
-        }
-    }
+await client.monitors.pullMonitorResults({
+    monitor_id: "monitor_id"
 });
 
 ```
@@ -523,7 +579,7 @@ await client.monitors.updateMonitor({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.UpdateMonitorRequestDto` 
+**request:** `CatchAllApi.PullMonitorResultsRequest` 
     
 </dd>
 </dl>
@@ -608,7 +664,7 @@ await client.monitors.listMonitorJobs({
 </dl>
 </details>
 
-<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">pullMonitorResults</a>({ ...params }) -> CatchAllApi.PullMonitorResponseDto</code></summary>
+<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">enableMonitor</a>({ ...params }) -> CatchAllApi.EnableMonitorResponse</code></summary>
 <dl>
 <dd>
 
@@ -620,7 +676,7 @@ await client.monitors.listMonitorJobs({
 <dl>
 <dd>
 
-Retrieve aggregated results from all jobs executed by a monitor.
+Resume scheduled job execution for a monitor.
 </dd>
 </dl>
 </dd>
@@ -635,8 +691,9 @@ Retrieve aggregated results from all jobs executed by a monitor.
 <dd>
 
 ```typescript
-await client.monitors.pullMonitorResults({
-    monitor_id: "monitor_id"
+await client.monitors.enableMonitor({
+    monitor_id: "monitor_id",
+    backfill: true
 });
 
 ```
@@ -653,7 +710,7 @@ await client.monitors.pullMonitorResults({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.PullMonitorResultsRequest` 
+**request:** `CatchAllApi.EnableMonitorRequestDto` 
     
 </dd>
 </dl>
@@ -738,7 +795,7 @@ await client.monitors.disableMonitor({
 </dl>
 </details>
 
-<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">enableMonitor</a>({ ...params }) -> CatchAllApi.EnableMonitorResponse</code></summary>
+<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">updateMonitor</a>({ ...params }) -> CatchAllApi.UpdateMonitorResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -750,7 +807,7 @@ await client.monitors.disableMonitor({
 <dl>
 <dd>
 
-Resume scheduled job execution for a monitor.
+Update the webhook configuration for an existing monitor.
 </dd>
 </dl>
 </dd>
@@ -765,9 +822,15 @@ Resume scheduled job execution for a monitor.
 <dd>
 
 ```typescript
-await client.monitors.enableMonitor({
+await client.monitors.updateMonitor({
     monitor_id: "monitor_id",
-    backfill: true
+    webhook: {
+        url: "https://new-endpoint.com/webhook",
+        method: "POST",
+        headers: {
+            "Authorization": "Bearer new_token_xyz"
+        }
+    }
 });
 
 ```
@@ -784,7 +847,7 @@ await client.monitors.enableMonitor({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.EnableMonitorRequestDto` 
+**request:** `CatchAllApi.UpdateMonitorRequestDto` 
     
 </dd>
 </dl>
@@ -804,7 +867,8 @@ await client.monitors.enableMonitor({
 </dl>
 </details>
 
-<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">listMonitors</a>({ ...params }) -> CatchAllApi.ListMonitorsResponseDto</code></summary>
+## Entities
+<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntities</a>({ ...params }) -> CatchAllApi.EntityListResponse</code></summary>
 <dl>
 <dd>
 
@@ -816,7 +880,9 @@ await client.monitors.enableMonitor({
 <dl>
 <dd>
 
-Returns all monitors created by the authenticated user.
+Returns a paginated list of entities belonging to the authenticated
+organization. Supports filtering by status and entity type, and
+sorting by name, status, or creation date.
 </dd>
 </dl>
 </dd>
@@ -831,7 +897,9 @@ Returns all monitors created by the authenticated user.
 <dd>
 
 ```typescript
-await client.monitors.listMonitors();
+await client.entities.listEntities({
+    search: "NewsCatcher"
+});
 
 ```
 </dd>
@@ -847,7 +915,7 @@ await client.monitors.listMonitors();
 <dl>
 <dd>
 
-**request:** `CatchAllApi.ListMonitorsRequest` 
+**request:** `CatchAllApi.ListEntitiesRequest` 
     
 </dd>
 </dl>
@@ -855,7 +923,1137 @@ await client.monitors.listMonitors();
 <dl>
 <dd>
 
-**requestOptions:** `MonitorsClient.RequestOptions` 
+**requestOptions:** `EntitiesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntity</a>({ ...params }) -> CatchAllApi.CreateEntityResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new company entity and begins background enrichment.
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.entities.createEntity({
+    name: "NewsCatcher",
+    entity_type: "company",
+    description: "AI-powered news data provider",
+    additional_attributes: {
+        company_attributes: {
+            domain: "newscatcherapi.com",
+            key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
+            alternative_names: ["NC", "NewsCatcher API"]
+        }
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.CreateEntityRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EntitiesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntitiesBatch</a>({ ...params }) -> CatchAllApi.CreateEntitiesBatchResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates multiple entities in a single request. Each entity is
+processed independently — a failure in one does not affect others.
+
+Returns an array of `{id, status}` objects in the same order as
+the input array.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.entities.createEntitiesBatch({
+    entities: [{
+            name: "OpenAI",
+            entity_type: "company",
+            description: "Artificial intelligence research company",
+            additional_attributes: {
+                company_attributes: {
+                    domain: "openai.com",
+                    key_persons: ["Sam Altman"],
+                    alternative_names: ["Open AI"]
+                }
+            }
+        }, {
+            name: "Stripe",
+            entity_type: "company",
+            description: "Online payment processing platform",
+            additional_attributes: {
+                company_attributes: {
+                    domain: "stripe.com",
+                    key_persons: ["Patrick Collison", "John Collison"]
+                }
+            }
+        }]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.CreateEntitiesBatchRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EntitiesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntity</a>({ ...params }) -> CatchAllApi.EntityResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a single entity by ID with all attributes and current status.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.entities.getEntity({
+    entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.GetEntityRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EntitiesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">deleteEntity</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Permanently deletes an entity. The entity is removed from all
+datasets and the search index. This operation cannot be undone.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.entities.deleteEntity({
+    entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.DeleteEntityRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EntitiesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">updateEntity</a>({ ...params }) -> CatchAllApi.EntityResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates one or more fields of an existing entity.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.entities.updateEntity({
+    entity_id: "854198fa-f702-49db-a381-0427fa87f173",
+    description: "Updated description",
+    additional_attributes: {
+        company_attributes: {
+            alternative_names: ["NC", "NewsCatcher API", "NCA"]
+        }
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.UpdateEntityRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EntitiesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Datasets
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listDatasets</a>({ ...params }) -> CatchAllApi.DatasetListResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a paginated list of datasets belonging to the authenticated
+organization. Supports filtering by status and sorting by name,
+status, or creation date.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.listDatasets({
+    search: "Portfolio"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.ListDatasetsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">createDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new dataset from a list of existing entity IDs.
+
+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
+be valid before the dataset is created.
+
+To create a dataset and entities in one step, use the [`Create dataset from CSV`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/datasets/create-dataset-from-csv)
+endpoint instead.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.createDataset({
+    name: "My Portfolio",
+    description: "Companies in our investment portfolio",
+    entity_ids: ["854198fa-f702-49db-a381-0427fa87f173", "a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.CreateDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">createDatasetFromCsv</a>({ ...params }) -> CatchAllApi.CreateDatasetCsvResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new dataset by uploading a CSV file. Each row in the CSV
+becomes an entity. The `name` column is required; all other columns
+are optional.
+
+**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"
+OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
+```
+
+Use semicolons (`;`) to separate multiple values in `alternative_names` and `key_persons`. Rows with empty `name` are skipped and reported in `validation_report`. 
+
+**Note**: The response shape differs from the JSON dataset creation endpoint: it returns `dataset_id` (not `id`) and includes a `validation_report` with details on skipped rows.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.createDatasetFromCsv({
+    file: fs.createReadStream("/path/to/your/file"),
+    name: "name"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.CreateDatasetFromCsvRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">getDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a single dataset by ID including entity count and current status.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.getDataset({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.GetDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">deleteDataset</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Permanently deletes a dataset. The entities within the dataset are
+not deleted — only the dataset itself. This operation cannot be
+undone.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.deleteDataset({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.DeleteDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">updateDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates the name or description of a dataset.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.updateDataset({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+    name: "My Portfolio (updated)",
+    description: "Updated Q1 2026 watchlist"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.UpdateDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listEntitiesInDataset</a>({ ...params }) -> CatchAllApi.DatasetEntityListResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a paginated list of entities in a dataset. Supports filtering by status and entity type.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.listEntitiesInDataset({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.ListEntitiesInDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">addEntitiesToDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds one or more existing entities to a dataset. Returns the number of entities added.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.addEntitiesToDataset({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+    body: {
+        entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.AddEntitiesToDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">removeEntitiesFromDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Removes one or more entities from a dataset. The entities themselves
+are not deleted — they are only removed from this dataset. Returns
+the number of entities removed.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.removeEntitiesFromDataset({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+    body: {
+        entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.RemoveEntitiesFromDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">getDatasetStatusHistory</a>({ ...params }) -> CatchAllApi.DatasetStatusHistoryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the full status change history for a dataset, ordered
+chronologically from oldest to newest.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.getDatasetStatusHistory({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.GetDatasetStatusHistoryRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">uploadCsvToDataset</a>({ ...params }) -> CatchAllApi.UploadCsvToDatasetResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Appends new companies to an existing dataset by uploading a CSV file.
+Uses the same CSV format as the dataset creation endpoint.
+
+The response omits `dataset_name` compared to the create-from-CSV
+endpoint since the dataset already exists.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.datasets.uploadCsvToDataset({
+    file: fs.createReadStream("/path/to/your/file"),
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.UploadCsvToDatasetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DatasetsClient.RequestOptions` 
     
 </dd>
 </dl>