newscatcher-catchall-sdk 0.3.1 → 1.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "newscatcher-catchall-sdk",
-    "version": "0.3.1",
+    "version": "1.1.2",
     "private": false,
     "repository": {
         "type": "git",
@@ -13,7 +13,6 @@
     "types": "./dist/cjs/index.d.ts",
     "exports": {
         ".": {
-            "types": "./dist/cjs/index.d.ts",
             "import": {
                 "types": "./dist/esm/index.d.mts",
                 "default": "./dist/esm/index.mjs"
@@ -24,6 +23,39 @@
             },
             "default": "./dist/cjs/index.js"
         },
+        "./jobs": {
+            "import": {
+                "types": "./dist/esm/api/resources/jobs/exports.d.mts",
+                "default": "./dist/esm/api/resources/jobs/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/jobs/exports.d.ts",
+                "default": "./dist/cjs/api/resources/jobs/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/jobs/exports.js"
+        },
+        "./monitors": {
+            "import": {
+                "types": "./dist/esm/api/resources/monitors/exports.d.mts",
+                "default": "./dist/esm/api/resources/monitors/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/monitors/exports.d.ts",
+                "default": "./dist/cjs/api/resources/monitors/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/monitors/exports.js"
+        },
+        "./meta": {
+            "import": {
+                "types": "./dist/esm/api/resources/meta/exports.d.mts",
+                "default": "./dist/esm/api/resources/meta/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/meta/exports.d.ts",
+                "default": "./dist/cjs/api/resources/meta/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/meta/exports.js"
+        },
         "./package.json": "./package.json"
     },
     "files": [
@@ -54,13 +86,14 @@
         "msw": "2.11.2",
         "@types/node": "^18.19.70",
         "typescript": "~5.7.2",
-        "@biomejs/biome": "2.3.11"
+        "@biomejs/biome": "2.4.3"
     },
     "browser": {
         "fs": false,
         "os": false,
         "path": false,
-        "stream": false
+        "stream": false,
+        "crypto": false
     },
     "packageManager": "pnpm@10.20.0",
     "engines": {

package/reference.md

@@ -1,6 +1,6 @@
 # Reference
 ## Jobs
-<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">createJob</a>({ ...params }) -> CatchAllApi.SubmitResponseBody</code></summary>
+<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">initialize</a>({ ...params }) -> CatchAllApi.InitializeResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -12,7 +12,73 @@
 <dl>
 <dd>
 
-Submit a natural language query to create a new processing job.
+Get suggested validators, enrichments, and date ranges for a query.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.jobs.initialize({
+    query: "Series B funding rounds for SaaS startups",
+    context: "Focus on funding amount and company name"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CatchAllApi.InitializeRequestDto` 
+    
+</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">createJob</a>({ ...params }) -> CatchAllApi.SubmitResponseDto</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Submit a query to create a new processing job.
 </dd>
 </dl>
 </dd>
@@ -28,8 +94,11 @@ Submit a natural language query to create a new processing job.
 
 ```typescript
 await client.jobs.createJob({
-    query: "AI company acquisitions",
-    context: "Focus on deal size and acquiring company details"
+    query: "Series B funding rounds for SaaS startups",
+    context: "Focus on funding amount and company name",
+    limit: 10,
+    start_date: "2026-02-18T00:00:00Z",
+    end_date: "2026-02-23T00:00:00Z"
 });
 
 ```
@@ -94,7 +163,7 @@ Continue an existing job to process more records beyond the initial limit.
 
 ```typescript
 await client.jobs.continueJob({
-    job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
+    job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
     new_limit: 100
 });
 
@@ -160,7 +229,7 @@ Retrieve the current processing status of a job.
 
 ```typescript
 await client.jobs.getJobStatus({
-    job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
+    job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
 });
 
 ```
@@ -197,7 +266,7 @@ await client.jobs.getJobStatus({
 </dl>
 </details>
 
-<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getUserJobs</a>() -> CatchAllApi.ListUserJobsResponseDto[]</code></summary>
+<details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">getUserJobs</a>({ ...params }) -> CatchAllApi.ListUserJobsResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -240,6 +309,14 @@ await client.jobs.getUserJobs();
 <dl>
 <dd>
 
+**request:** `CatchAllApi.GetUserJobsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `JobsClient.RequestOptions` 
     
 </dd>
@@ -280,7 +357,7 @@ Retrieve the final results for a completed job.
 
 ```typescript
 await client.jobs.getJobResults({
-    job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
+    job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
 });
 
 ```
@@ -330,16 +407,7 @@ await client.jobs.getJobResults({
 <dl>
 <dd>
 
-Create a monitor that runs jobs based on a reference job with a specified schedule.
-
-**Schedule requirements:**
-- Minimum 24-hour interval between executions
-- Natural language format (e.g., "every day at 12 PM UTC", "every 48 hours")
-
-**Validation:**
-- Schedules below minimum frequency return error with descriptive message.
-- Invalid job IDs return 400 Bad Request.
-- Duplicate monitors (same job already monitored) return error.
+Create a scheduled monitor based on a reference job.
 </dd>
 </dl>
 </dd>
@@ -355,8 +423,17 @@ Create a monitor that runs jobs based on a reference job with a specified schedu
 
 ```typescript
 await client.monitors.createMonitor({
-    reference_job_id: "reference_job_id",
-    schedule: "every day at 12 PM UTC"
+    reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
+    schedule: "every day at 12 PM UTC",
+    webhook: {
+        url: "https://your-endpoint.com/webhook",
+        method: "POST",
+        headers: {
+            "Authorization": "Bearer your_token_here"
+        }
+    },
+    limit: 10,
+    backfill: true
 });
 
 ```
@@ -405,15 +482,7 @@ await client.monitors.createMonitor({
 <dl>
 <dd>
 
-Update webhook configuration for an existing monitor without recreating it.
-
-**Supported updates:**
-- Webhook URL
-- HTTP method (POST/PUT)
-- Headers and authentication
-- Query parameters
-
-**Note:** Schedule and reference job cannot be modified. To change these, create a new monitor.
+Update the webhook configuration for an existing monitor.
 </dd>
 </dl>
 </dd>
@@ -485,8 +554,7 @@ await client.monitors.updateMonitor({
 <dl>
 <dd>
 
-Returns all jobs associated with a monitor, sorted by start_date.
-Each job includes job_id, start_date, and end_date.
+Return all jobs executed by a monitor.
 </dd>
 </dl>
 </dd>
@@ -551,8 +619,7 @@ await client.monitors.listMonitorJobs({
 <dl>
 <dd>
 
-Retrieve aggregated results from all jobs executed by this monitor.
-Includes monitor configuration, execution history, and all records collected.
+Retrieve aggregated results from all jobs executed by a monitor.
 </dd>
 </dl>
 </dd>
@@ -617,8 +684,7 @@ await client.monitors.pullMonitorResults({
 <dl>
 <dd>
 
-Disables a monitor to stop executing scheduled jobs.
-Validates that the provided API key is associated with the monitor.
+Stop scheduled job execution for a monitor.
 </dd>
 </dl>
 </dd>
@@ -683,8 +749,7 @@ await client.monitors.disableMonitor({
 <dl>
 <dd>
 
-Enables a monitor to resume executing scheduled jobs.
-Validates that the provided API key is associated with the monitor.
+Resume scheduled job execution for a monitor.
 </dd>
 </dl>
 </dd>
@@ -700,7 +765,8 @@ Validates that the provided API key is associated with the monitor.
 
 ```typescript
 await client.monitors.enableMonitor({
-    monitor_id: "monitor_id"
+    monitor_id: "monitor_id",
+    backfill: true
 });
 
 ```
@@ -717,7 +783,7 @@ await client.monitors.enableMonitor({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.EnableMonitorRequest` 
+**request:** `CatchAllApi.EnableMonitorRequestDto` 
     
 </dd>
 </dl>
@@ -737,7 +803,7 @@ await client.monitors.enableMonitor({
 </dl>
 </details>
 
-<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">listMonitors</a>() -> CatchAllApi.ListMonitorsResponseDto</code></summary>
+<details><summary><code>client.monitors.<a href="/src/api/resources/monitors/client/Client.ts">listMonitors</a>({ ...params }) -> CatchAllApi.ListMonitorsResponseDto</code></summary>
 <dl>
 <dd>
 
@@ -780,6 +846,14 @@ await client.monitors.listMonitors();
 <dl>
 <dd>
 
+**request:** `CatchAllApi.ListMonitorsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `MonitorsClient.RequestOptions` 
     
 </dd>
@@ -902,3 +976,4 @@ await client.meta.getVersion();
 </dd>
 </dl>
 </details>
+

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

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

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

@@ -1,6 +0,0 @@
-/**
- * Template string to guide record summary formatting. Use placeholder syntax with brackets to indicate desired fields: [COMPANY], [REVENUE], [TARGET], [AMOUNT], etc.
- *
- * When provided, the system generates a `schema_based_summary` field for each record following this template.
- */
-export type Schema = string;

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

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

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

@@ -1,6 +0,0 @@
-/**
- * Template string to guide record summary formatting. Use placeholder syntax with brackets to indicate desired fields: [COMPANY], [REVENUE], [TARGET], [AMOUNT], etc.
- *
- * When provided, the system generates a `schema_based_summary` field for each record following this template.
- */
-export type Schema = string;