newscatcher-catchall-sdk 1.0.0 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/README.md +41 -25
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/Client.d.ts +12 -0
  4. package/dist/cjs/Client.js +67 -0
  5. package/dist/cjs/api/resources/jobs/client/Client.d.ts +14 -17
  6. package/dist/cjs/api/resources/jobs/client/Client.js +13 -19
  7. package/dist/cjs/api/resources/jobs/client/requests/ContinueRequestDto.d.ts +3 -3
  8. package/dist/cjs/api/resources/jobs/client/requests/GetJobResultsRequest.d.ts +2 -2
  9. package/dist/cjs/api/resources/jobs/client/requests/GetJobStatusRequest.d.ts +2 -2
  10. package/dist/cjs/api/resources/jobs/client/requests/InitializeRequestDto.d.ts +2 -1
  11. package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +26 -6
  12. package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.js +14 -0
  13. package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +1 -1
  14. package/dist/cjs/api/resources/jobs/client/requests/index.js +3 -0
  15. package/dist/cjs/api/resources/jobs/exports.d.ts +2 -0
  16. package/dist/cjs/api/resources/jobs/exports.js +21 -0
  17. package/dist/cjs/api/resources/meta/client/Client.d.ts +15 -3
  18. package/dist/cjs/api/resources/meta/client/Client.js +49 -1
  19. package/dist/cjs/api/resources/meta/exports.d.ts +2 -0
  20. package/dist/cjs/api/resources/meta/exports.js +21 -0
  21. package/dist/cjs/api/resources/meta/types/GetVersionResponse.d.ts +1 -1
  22. package/dist/cjs/api/resources/meta/types/HealthCheckResponse.d.ts +1 -1
  23. package/dist/cjs/api/resources/monitors/client/Client.d.ts +23 -37
  24. package/dist/cjs/api/resources/monitors/client/Client.js +35 -41
  25. package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +23 -6
  26. package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequestDto.d.ts +17 -0
  27. package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +10 -0
  28. package/dist/cjs/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.ts +2 -0
  29. package/dist/cjs/api/resources/monitors/client/requests/index.d.ts +2 -1
  30. package/dist/cjs/api/resources/monitors/exports.d.ts +2 -0
  31. package/dist/cjs/api/resources/monitors/exports.js +21 -0
  32. package/dist/cjs/api/types/BaseRecord.d.ts +38 -0
  33. package/dist/cjs/api/types/BaseRecord.js +16 -0
  34. package/dist/cjs/api/types/Citation.d.ts +3 -3
  35. package/dist/cjs/api/types/CompanyEnrichmentOutput.d.ts +29 -0
  36. package/dist/cjs/api/types/CompanyEnrichmentOutput.js +16 -0
  37. package/dist/cjs/api/types/ContinueResponseDto.d.ts +2 -2
  38. package/dist/cjs/api/types/CreateMonitorResponseDto.d.ts +1 -1
  39. package/dist/cjs/api/types/EndDate.d.ts +4 -2
  40. package/dist/cjs/api/types/EnrichmentType.d.ts +1 -3
  41. package/dist/cjs/api/types/EnrichmentType.js +1 -3
  42. package/dist/cjs/api/types/Error_.d.ts +1 -1
  43. package/dist/cjs/api/types/GetPlanLimitsResponseDto.d.ts +5 -0
  44. package/dist/cjs/api/types/InitializeResponseDto.d.ts +8 -9
  45. package/dist/cjs/api/types/JobStep.d.ts +2 -2
  46. package/dist/cjs/api/types/Limit.d.ts +1 -1
  47. package/dist/cjs/api/types/ListMonitorsResponseDto.d.ts +7 -1
  48. package/dist/cjs/api/types/MonitorCitation.d.ts +3 -8
  49. package/dist/cjs/api/types/MonitorListItemDto.d.ts +10 -8
  50. package/dist/cjs/api/types/MonitorRecord.d.ts +4 -14
  51. package/dist/cjs/api/types/PlanFeature.d.ts +12 -0
  52. package/dist/cjs/api/types/PlanFeature.js +3 -0
  53. package/dist/{esm/api/types/JobStatus.d.mts → cjs/api/types/PublicJobStatus.d.ts} +4 -4
  54. package/dist/cjs/api/types/{JobStatus.js → PublicJobStatus.js} +4 -4
  55. package/dist/cjs/api/types/PullJobResponseDto.d.ts +34 -25
  56. package/dist/cjs/api/types/PullJobResponseDto.js +9 -0
  57. package/dist/cjs/api/types/PullMonitorResponseDto.d.ts +12 -12
  58. package/dist/cjs/api/types/Query.d.ts +1 -1
  59. package/dist/cjs/api/types/Record_.d.ts +2 -12
  60. package/dist/cjs/api/types/ReferenceJob.d.ts +3 -3
  61. package/dist/cjs/api/types/StartDate.d.ts +4 -2
  62. package/dist/cjs/api/types/StatusResponseDto.d.ts +2 -2
  63. package/dist/cjs/api/types/{SubmitResponseBody.d.ts → SubmitResponseDto.d.ts} +1 -1
  64. package/dist/cjs/api/types/SubmitResponseDto.js +3 -0
  65. package/dist/cjs/api/types/UserJob.d.ts +13 -1
  66. package/dist/cjs/api/types/UserJob.js +9 -0
  67. package/dist/cjs/api/types/ValidationErrorDetail.d.ts +3 -3
  68. package/dist/cjs/api/types/ValidationErrorResponse.d.ts +1 -1
  69. package/dist/cjs/api/types/ValidatorSchema.d.ts +3 -3
  70. package/dist/cjs/api/types/WebhookDto.d.ts +4 -4
  71. package/dist/cjs/api/types/WebhookPayload.d.ts +9 -9
  72. package/dist/cjs/api/types/index.d.ts +6 -3
  73. package/dist/cjs/api/types/index.js +6 -3
  74. package/dist/cjs/core/fetcher/BinaryResponse.d.ts +1 -1
  75. package/dist/cjs/core/fetcher/Fetcher.js +8 -2
  76. package/dist/cjs/core/fetcher/index.d.ts +2 -0
  77. package/dist/cjs/core/fetcher/index.js +3 -1
  78. package/dist/cjs/core/fetcher/makePassthroughRequest.d.ts +49 -0
  79. package/dist/cjs/core/fetcher/makePassthroughRequest.js +135 -0
  80. package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -1
  81. package/dist/cjs/core/fetcher/makeRequest.js +30 -9
  82. package/dist/cjs/core/runtime/runtime.js +8 -7
  83. package/dist/cjs/version.d.ts +1 -1
  84. package/dist/cjs/version.js +1 -1
  85. package/dist/esm/BaseClient.mjs +2 -2
  86. package/dist/esm/Client.d.mts +12 -0
  87. package/dist/esm/Client.mjs +34 -0
  88. package/dist/esm/api/resources/jobs/client/Client.d.mts +14 -17
  89. package/dist/esm/api/resources/jobs/client/Client.mjs +13 -19
  90. package/dist/esm/api/resources/jobs/client/requests/ContinueRequestDto.d.mts +3 -3
  91. package/dist/esm/api/resources/jobs/client/requests/GetJobResultsRequest.d.mts +2 -2
  92. package/dist/esm/api/resources/jobs/client/requests/GetJobStatusRequest.d.mts +2 -2
  93. package/dist/esm/api/resources/jobs/client/requests/InitializeRequestDto.d.mts +2 -1
  94. package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +26 -6
  95. package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.mjs +13 -1
  96. package/dist/esm/api/resources/jobs/client/requests/index.d.mts +1 -1
  97. package/dist/esm/api/resources/jobs/client/requests/index.mjs +1 -1
  98. package/dist/esm/api/resources/jobs/exports.d.mts +2 -0
  99. package/dist/esm/api/resources/jobs/exports.mjs +3 -0
  100. package/dist/esm/api/resources/meta/client/Client.d.mts +15 -3
  101. package/dist/esm/api/resources/meta/client/Client.mjs +50 -2
  102. package/dist/esm/api/resources/meta/exports.d.mts +2 -0
  103. package/dist/esm/api/resources/meta/exports.mjs +3 -0
  104. package/dist/esm/api/resources/meta/types/GetVersionResponse.d.mts +1 -1
  105. package/dist/esm/api/resources/meta/types/HealthCheckResponse.d.mts +1 -1
  106. package/dist/esm/api/resources/monitors/client/Client.d.mts +23 -37
  107. package/dist/esm/api/resources/monitors/client/Client.mjs +35 -41
  108. package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +23 -6
  109. package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequestDto.d.mts +17 -0
  110. package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +10 -0
  111. package/dist/esm/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.mts +2 -0
  112. package/dist/esm/api/resources/monitors/client/requests/index.d.mts +2 -1
  113. package/dist/esm/api/resources/monitors/exports.d.mts +2 -0
  114. package/dist/esm/api/resources/monitors/exports.mjs +3 -0
  115. package/dist/esm/api/types/BaseRecord.d.mts +38 -0
  116. package/dist/esm/api/types/BaseRecord.mjs +13 -0
  117. package/dist/esm/api/types/Citation.d.mts +3 -3
  118. package/dist/esm/api/types/CompanyEnrichmentOutput.d.mts +29 -0
  119. package/dist/esm/api/types/CompanyEnrichmentOutput.mjs +13 -0
  120. package/dist/esm/api/types/ContinueResponseDto.d.mts +2 -2
  121. package/dist/esm/api/types/CreateMonitorResponseDto.d.mts +1 -1
  122. package/dist/esm/api/types/EndDate.d.mts +4 -2
  123. package/dist/esm/api/types/EnrichmentType.d.mts +1 -3
  124. package/dist/esm/api/types/EnrichmentType.mjs +1 -3
  125. package/dist/esm/api/types/Error_.d.mts +1 -1
  126. package/dist/esm/api/types/GetPlanLimitsResponseDto.d.mts +5 -0
  127. package/dist/esm/api/types/InitializeResponseDto.d.mts +8 -9
  128. package/dist/esm/api/types/JobStep.d.mts +2 -2
  129. package/dist/esm/api/types/Limit.d.mts +1 -1
  130. package/dist/esm/api/types/ListMonitorsResponseDto.d.mts +7 -1
  131. package/dist/esm/api/types/MonitorCitation.d.mts +3 -8
  132. package/dist/esm/api/types/MonitorListItemDto.d.mts +10 -8
  133. package/dist/esm/api/types/MonitorRecord.d.mts +4 -14
  134. package/dist/esm/api/types/PlanFeature.d.mts +12 -0
  135. package/dist/esm/api/types/PlanFeature.mjs +2 -0
  136. package/dist/{cjs/api/types/JobStatus.d.ts → esm/api/types/PublicJobStatus.d.mts} +4 -4
  137. package/dist/esm/api/types/{JobStatus.mjs → PublicJobStatus.mjs} +3 -3
  138. package/dist/esm/api/types/PullJobResponseDto.d.mts +34 -25
  139. package/dist/esm/api/types/PullJobResponseDto.mjs +8 -1
  140. package/dist/esm/api/types/PullMonitorResponseDto.d.mts +12 -12
  141. package/dist/esm/api/types/Query.d.mts +1 -1
  142. package/dist/esm/api/types/Record_.d.mts +2 -12
  143. package/dist/esm/api/types/ReferenceJob.d.mts +3 -3
  144. package/dist/esm/api/types/StartDate.d.mts +4 -2
  145. package/dist/esm/api/types/StatusResponseDto.d.mts +2 -2
  146. package/dist/esm/api/types/{SubmitResponseBody.d.mts → SubmitResponseDto.d.mts} +1 -1
  147. package/dist/esm/api/types/SubmitResponseDto.mjs +2 -0
  148. package/dist/esm/api/types/UserJob.d.mts +13 -1
  149. package/dist/esm/api/types/UserJob.mjs +8 -1
  150. package/dist/esm/api/types/ValidationErrorDetail.d.mts +3 -3
  151. package/dist/esm/api/types/ValidationErrorResponse.d.mts +1 -1
  152. package/dist/esm/api/types/ValidatorSchema.d.mts +3 -3
  153. package/dist/esm/api/types/WebhookDto.d.mts +4 -4
  154. package/dist/esm/api/types/WebhookPayload.d.mts +9 -9
  155. package/dist/esm/api/types/index.d.mts +6 -3
  156. package/dist/esm/api/types/index.mjs +6 -3
  157. package/dist/esm/core/fetcher/BinaryResponse.d.mts +1 -1
  158. package/dist/esm/core/fetcher/Fetcher.mjs +8 -2
  159. package/dist/esm/core/fetcher/index.d.mts +2 -0
  160. package/dist/esm/core/fetcher/index.mjs +1 -0
  161. package/dist/esm/core/fetcher/makePassthroughRequest.d.mts +49 -0
  162. package/dist/esm/core/fetcher/makePassthroughRequest.mjs +132 -0
  163. package/dist/esm/core/fetcher/makeRequest.d.mts +6 -1
  164. package/dist/esm/core/fetcher/makeRequest.mjs +28 -9
  165. package/dist/esm/core/runtime/runtime.mjs +8 -7
  166. package/dist/esm/version.d.mts +1 -1
  167. package/dist/esm/version.mjs +1 -1
  168. package/package.json +37 -4
  169. package/reference.md +99 -53
  170. package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequest.d.ts +0 -10
  171. package/dist/cjs/api/types/Schema.d.ts +0 -6
  172. package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequest.d.mts +0 -10
  173. package/dist/esm/api/types/Schema.d.mts +0 -6
  174. /package/dist/cjs/api/resources/monitors/client/requests/{EnableMonitorRequest.js → EnableMonitorRequestDto.js} +0 -0
  175. /package/dist/cjs/api/{types/Schema.js → resources/monitors/client/requests/ListMonitorsRequest.js} +0 -0
  176. /package/dist/cjs/api/types/{SubmitResponseBody.js → GetPlanLimitsResponseDto.js} +0 -0
  177. /package/dist/esm/api/resources/monitors/client/requests/{EnableMonitorRequest.mjs → EnableMonitorRequestDto.mjs} +0 -0
  178. /package/dist/esm/api/{types/Schema.mjs → resources/monitors/client/requests/ListMonitorsRequest.mjs} +0 -0
  179. /package/dist/esm/api/types/{SubmitResponseBody.mjs → GetPlanLimitsResponseDto.mjs} +0 -0
package/README.md CHANGED
@@ -14,6 +14,7 @@ The Newscatcher TypeScript library provides convenient access to the Newscatcher
14
14
  - [Request and Response Types](#request-and-response-types)
15
15
  - [Exception Handling](#exception-handling)
16
16
  - [Advanced](#advanced)
17
+ - [Subpackage Exports](#subpackage-exports)
17
18
  - [Additional Headers](#additional-headers)
18
19
  - [Additional Query String Parameters](#additional-query-string-parameters)
19
20
  - [Retries](#retries)
@@ -21,14 +22,14 @@ The Newscatcher TypeScript library provides convenient access to the Newscatcher
21
22
  - [Aborting Requests](#aborting-requests)
22
23
  - [Access Raw Response Data](#access-raw-response-data)
23
24
  - [Logging](#logging)
25
+ - [Custom Fetch](#custom-fetch)
24
26
  - [Runtime Compatibility](#runtime-compatibility)
25
- - [Beta Status](#beta-status)
26
27
  - [Contributing](#contributing)
27
28
  - [Support](#support)
28
29
 
29
30
  ## Documentation
30
31
 
31
- API reference documentation is available [here](https://www.newscatcherapi.com/docs/v3/catch-all/endpoints/create-job).
32
+ API reference documentation is available [here](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/initialize-job).
32
33
 
33
34
  ## Installation
34
35
 
@@ -49,11 +50,12 @@ import { CatchAllApiClient } from "newscatcher-catchall-sdk";
49
50
 
50
51
  const client = new CatchAllApiClient({ apiKey: "YOUR_API_KEY" });
51
52
  await client.jobs.createJob({
52
- query: "AI company acquisitions",
53
- context: "Focus on deal size and acquiring company details",
53
+ query: "Series B funding rounds for SaaS startups",
54
+ context: "Focus on funding amount and company name",
54
55
  limit: 10,
55
- start_date: "2026-01-30T00:00:00Z",
56
- end_date: "2026-02-05T00:00:00Z"
56
+ start_date: "2026-02-18T00:00:00Z",
57
+ end_date: "2026-02-23T00:00:00Z",
58
+ mode: "base"
57
59
  });
58
60
  ```
59
61
 
@@ -92,6 +94,16 @@ try {
92
94
 
93
95
  ## Advanced
94
96
 
97
+ ### Subpackage Exports
98
+
99
+ This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.
100
+
101
+ ```typescript
102
+ import { JobsClient } from 'newscatcher-catchall-sdk/jobs';
103
+
104
+ const client = new JobsClient({...});
105
+ ```
106
+
95
107
  ### Additional Headers
96
108
 
97
109
  If you would like to send additional headers as part of the request, use the `headers` request option.
@@ -242,6 +254,26 @@ const logger: logging.ILogger = {
242
254
  </details>
243
255
 
244
256
 
257
+ ### Custom Fetch
258
+
259
+ The SDK provides a low-level `fetch` method for making custom HTTP requests while still
260
+ benefiting from SDK-level configuration like authentication, retries, timeouts, and logging.
261
+ This is useful for calling API endpoints not yet supported in the SDK.
262
+
263
+ ```typescript
264
+ const response = await client.fetch("/v1/custom/endpoint", {
265
+ method: "GET",
266
+ }, {
267
+ timeoutInSeconds: 30,
268
+ maxRetries: 3,
269
+ headers: {
270
+ "X-Custom-Header": "custom-value",
271
+ },
272
+ });
273
+
274
+ const data = await response.json();
275
+ ```
276
+
245
277
  ### Runtime Compatibility
246
278
 
247
279
 
@@ -256,23 +288,6 @@ The SDK works in the following runtimes:
256
288
  - Bun 1.0+
257
289
  - React Native
258
290
 
259
- ### Customizing Fetch Client
260
-
261
- The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
262
- unsupported environment, this provides a way for you to break glass and ensure the SDK works.
263
-
264
- ```typescript
265
- import { CatchAllApiClient } from "newscatcher-catchall-sdk";
266
-
267
- const client = new CatchAllApiClient({
268
- ...
269
- fetcher: // provide your implementation here
270
- });
271
- ```
272
-
273
- ## Beta status
274
-
275
- CatchAll API is in beta. Breaking changes may occur in minor version updates. See the [Changelog](https://www.newscatcherapi.com/docs/v3/catch-all/overview/changelog) for updates.
276
291
 
277
292
  ## Contributing
278
293
 
@@ -285,5 +300,6 @@ an issue first to discuss with us!
285
300
  On the other hand, contributions to the README are always very welcome!
286
301
  ## Support
287
302
 
288
- - Documentation: [https://www.newscatcherapi.com/docs/v3/catch-all](https://www.newscatcherapi.com/docs/v3/catch-all)
289
- - Support: <support@newscatcherapi.com>
303
+ - Documentation: [www.newscatcherapi.com/docs/web-search-api](https://www.newscatcherapi.com/docs/web-search-api/get-started/introduction)
304
+ - Support: <support@newscatcherapi.com>
305
+
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "newscatcher-catchall-sdk",
46
- "X-Fern-SDK-Version": "1.0.0",
47
- "User-Agent": "newscatcher-catchall-sdk/1.0.0",
46
+ "X-Fern-SDK-Version": "1.3.1",
47
+ "User-Agent": "newscatcher-catchall-sdk/1.3.1",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -3,6 +3,7 @@ import { MetaClient } from "./api/resources/meta/client/Client.js";
3
3
  import { MonitorsClient } from "./api/resources/monitors/client/Client.js";
4
4
  import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
5
5
  import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
6
+ import * as core from "./core/index.js";
6
7
  export declare namespace CatchAllApiClient {
7
8
  type Options = BaseClientOptions;
8
9
  interface RequestOptions extends BaseRequestOptions {
@@ -17,4 +18,15 @@ export declare class CatchAllApiClient {
17
18
  get jobs(): JobsClient;
18
19
  get monitors(): MonitorsClient;
19
20
  get meta(): MetaClient;
21
+ /**
22
+ * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
23
+ * This is useful for making requests to endpoints not yet supported in the SDK.
24
+ * The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.
25
+ *
26
+ * @param {Request | string | URL} input - The URL, path, or Request object.
27
+ * @param {RequestInit} init - Standard fetch RequestInit options.
28
+ * @param {core.PassthroughRequest.RequestOptions} requestOptions - Per-request overrides (timeout, retries, headers, abort signal).
29
+ * @returns {Promise<Response>} A standard Response object.
30
+ */
31
+ fetch(input: Request | string | URL, init?: RequestInit, requestOptions?: core.PassthroughRequest.RequestOptions): Promise<Response>;
20
32
  }
@@ -1,11 +1,54 @@
1
1
  "use strict";
2
2
  // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
37
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
38
+ return new (P || (P = Promise))(function (resolve, reject) {
39
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
40
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
41
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
42
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
43
+ });
44
+ };
3
45
  Object.defineProperty(exports, "__esModule", { value: true });
4
46
  exports.CatchAllApiClient = void 0;
5
47
  const Client_js_1 = require("./api/resources/jobs/client/Client.js");
6
48
  const Client_js_2 = require("./api/resources/meta/client/Client.js");
7
49
  const Client_js_3 = require("./api/resources/monitors/client/Client.js");
8
50
  const BaseClient_js_1 = require("./BaseClient.js");
51
+ const core = __importStar(require("./core/index.js"));
9
52
  class CatchAllApiClient {
10
53
  constructor(options = {}) {
11
54
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
@@ -22,5 +65,29 @@ class CatchAllApiClient {
22
65
  var _a;
23
66
  return ((_a = this._meta) !== null && _a !== void 0 ? _a : (this._meta = new Client_js_2.MetaClient(this._options)));
24
67
  }
68
+ /**
69
+ * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
70
+ * This is useful for making requests to endpoints not yet supported in the SDK.
71
+ * The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.
72
+ *
73
+ * @param {Request | string | URL} input - The URL, path, or Request object.
74
+ * @param {RequestInit} init - Standard fetch RequestInit options.
75
+ * @param {core.PassthroughRequest.RequestOptions} requestOptions - Per-request overrides (timeout, retries, headers, abort signal).
76
+ * @returns {Promise<Response>} A standard Response object.
77
+ */
78
+ fetch(input, init, requestOptions) {
79
+ return __awaiter(this, void 0, void 0, function* () {
80
+ var _a;
81
+ return core.makePassthroughRequest(input, init, {
82
+ baseUrl: (_a = this._options.baseUrl) !== null && _a !== void 0 ? _a : this._options.environment,
83
+ headers: this._options.headers,
84
+ timeoutInSeconds: this._options.timeoutInSeconds,
85
+ maxRetries: this._options.maxRetries,
86
+ fetch: this._options.fetch,
87
+ logging: this._options.logging,
88
+ getAuthHeaders: () => __awaiter(this, void 0, void 0, function* () { return (yield this._options.authProvider.getAuthRequest()).headers; }),
89
+ }, requestOptions);
90
+ });
91
+ }
25
92
  }
26
93
  exports.CatchAllApiClient = CatchAllApiClient;
@@ -14,9 +14,7 @@ export declare class JobsClient {
14
14
  protected readonly _options: NormalizedClientOptionsWithAuth<JobsClient.Options>;
15
15
  constructor(options?: JobsClient.Options);
16
16
  /**
17
- * Get suggested validators, enrichments, and date ranges for a query before submitting a job.
18
- *
19
- * Returns LLM-generated suggestions based on query analysis and validates against plan limits.
17
+ * Get suggested validators, enrichments, and date ranges for a query.
20
18
  *
21
19
  * @param {CatchAllApi.InitializeRequestDto} request
22
20
  * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -26,16 +24,14 @@ export declare class JobsClient {
26
24
  *
27
25
  * @example
28
26
  * await client.jobs.initialize({
29
- * query: "AI company acquisitions in fintech last week"
27
+ * query: "Series B funding rounds for SaaS startups",
28
+ * context: "Focus on funding amount and company name"
30
29
  * })
31
30
  */
32
31
  initialize(request: CatchAllApi.InitializeRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.InitializeResponseDto>;
33
32
  private __initialize;
34
33
  /**
35
- * Submit a natural language query to create a new processing job.
36
- *
37
- * Optionally specify context, date ranges, limit, custom validators, and enrichments.
38
- * If dates exceed plan limits, returns 400 error.
34
+ * Submit a query to create a new processing job.
39
35
  *
40
36
  * @param {CatchAllApi.SubmitRequestDto} request
41
37
  * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,14 +42,15 @@ export declare class JobsClient {
46
42
  *
47
43
  * @example
48
44
  * await client.jobs.createJob({
49
- * query: "AI company acquisitions",
50
- * context: "Focus on deal size and acquiring company details",
45
+ * query: "Series B funding rounds for SaaS startups",
46
+ * context: "Focus on funding amount and company name",
51
47
  * limit: 10,
52
- * start_date: "2026-01-30T00:00:00Z",
53
- * end_date: "2026-02-05T00:00:00Z"
48
+ * start_date: "2026-02-18T00:00:00Z",
49
+ * end_date: "2026-02-23T00:00:00Z",
50
+ * mode: "base"
54
51
  * })
55
52
  */
56
- createJob(request: CatchAllApi.SubmitRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.SubmitResponseBody>;
53
+ createJob(request: CatchAllApi.SubmitRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.SubmitResponseDto>;
57
54
  private __createJob;
58
55
  /**
59
56
  * Continue an existing job to process more records beyond the initial limit.
@@ -67,7 +64,7 @@ export declare class JobsClient {
67
64
  *
68
65
  * @example
69
66
  * await client.jobs.continueJob({
70
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
67
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
71
68
  * new_limit: 100
72
69
  * })
73
70
  */
@@ -84,7 +81,7 @@ export declare class JobsClient {
84
81
  *
85
82
  * @example
86
83
  * await client.jobs.getJobStatus({
87
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
84
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
88
85
  * })
89
86
  */
90
87
  getJobStatus(request: CatchAllApi.GetJobStatusRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.StatusResponseDto>;
@@ -100,7 +97,7 @@ export declare class JobsClient {
100
97
  * @example
101
98
  * await client.jobs.getUserJobs()
102
99
  */
103
- getUserJobs(request?: CatchAllApi.GetUserJobsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListUserJobsResponseDto[]>;
100
+ getUserJobs(request?: CatchAllApi.GetUserJobsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListUserJobsResponseDto>;
104
101
  private __getUserJobs;
105
102
  /**
106
103
  * Retrieve the final results for a completed job.
@@ -113,7 +110,7 @@ export declare class JobsClient {
113
110
  *
114
111
  * @example
115
112
  * await client.jobs.getJobResults({
116
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
113
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
117
114
  * })
118
115
  */
119
116
  getJobResults(request: CatchAllApi.GetJobResultsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullJobResponseDto>;
@@ -59,9 +59,7 @@ class JobsClient {
59
59
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
60
60
  }
61
61
  /**
62
- * Get suggested validators, enrichments, and date ranges for a query before submitting a job.
63
- *
64
- * Returns LLM-generated suggestions based on query analysis and validates against plan limits.
62
+ * Get suggested validators, enrichments, and date ranges for a query.
65
63
  *
66
64
  * @param {CatchAllApi.InitializeRequestDto} request
67
65
  * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -71,7 +69,8 @@ class JobsClient {
71
69
  *
72
70
  * @example
73
71
  * await client.jobs.initialize({
74
- * query: "AI company acquisitions in fintech last week"
72
+ * query: "Series B funding rounds for SaaS startups",
73
+ * context: "Focus on funding amount and company name"
75
74
  * })
76
75
  */
77
76
  initialize(request, requestOptions) {
@@ -117,10 +116,7 @@ class JobsClient {
117
116
  });
118
117
  }
119
118
  /**
120
- * Submit a natural language query to create a new processing job.
121
- *
122
- * Optionally specify context, date ranges, limit, custom validators, and enrichments.
123
- * If dates exceed plan limits, returns 400 error.
119
+ * Submit a query to create a new processing job.
124
120
  *
125
121
  * @param {CatchAllApi.SubmitRequestDto} request
126
122
  * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -131,11 +127,12 @@ class JobsClient {
131
127
  *
132
128
  * @example
133
129
  * await client.jobs.createJob({
134
- * query: "AI company acquisitions",
135
- * context: "Focus on deal size and acquiring company details",
130
+ * query: "Series B funding rounds for SaaS startups",
131
+ * context: "Focus on funding amount and company name",
136
132
  * limit: 10,
137
- * start_date: "2026-01-30T00:00:00Z",
138
- * end_date: "2026-02-05T00:00:00Z"
133
+ * start_date: "2026-02-18T00:00:00Z",
134
+ * end_date: "2026-02-23T00:00:00Z",
135
+ * mode: "base"
139
136
  * })
140
137
  */
141
138
  createJob(request, requestOptions) {
@@ -194,7 +191,7 @@ class JobsClient {
194
191
  *
195
192
  * @example
196
193
  * await client.jobs.continueJob({
197
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
194
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
198
195
  * new_limit: 100
199
196
  * })
200
197
  */
@@ -253,7 +250,7 @@ class JobsClient {
253
250
  *
254
251
  * @example
255
252
  * await client.jobs.getJobStatus({
256
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
253
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
257
254
  * })
258
255
  */
259
256
  getJobStatus(request, requestOptions) {
@@ -332,10 +329,7 @@ class JobsClient {
332
329
  logging: this._options.logging,
333
330
  });
334
331
  if (_response.ok) {
335
- return {
336
- data: _response.body,
337
- rawResponse: _response.rawResponse,
338
- };
332
+ return { data: _response.body, rawResponse: _response.rawResponse };
339
333
  }
340
334
  if (_response.error.reason === "status-code") {
341
335
  switch (_response.error.statusCode) {
@@ -363,7 +357,7 @@ class JobsClient {
363
357
  *
364
358
  * @example
365
359
  * await client.jobs.getJobResults({
366
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
360
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
367
361
  * })
368
362
  */
369
363
  getJobResults(request, requestOptions) {
@@ -1,13 +1,13 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
4
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
5
5
  * new_limit: 100
6
6
  * }
7
7
  */
8
8
  export interface ContinueRequestDto {
9
9
  /** Job identifier of the completed job to continue. */
10
10
  job_id: string;
11
- /** New record limit for continued processing. Must be greater than the previous limit. */
12
- new_limit: number;
11
+ /** New record limit for continued processing. Must be greater than the previous limit. If not provided, defaults to the plan maximum. */
12
+ new_limit?: number;
13
13
  }
@@ -1,11 +1,11 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
4
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
5
5
  * }
6
6
  */
7
7
  export interface GetJobResultsRequest {
8
- /** Unique job identifier returned from the [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/v3/catch-all/endpoints/create-job) endpoint. */
8
+ /** Unique job identifier returned from [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/create-job). */
9
9
  job_id: string;
10
10
  /** Page number to retrieve. */
11
11
  page?: number;
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
4
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
5
5
  * }
6
6
  */
7
7
  export interface GetJobStatusRequest {
8
- /** Unique job identifier returned from the [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/v3/catch-all/endpoints/create-job) endpoint. */
8
+ /** Unique job identifier returned from [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/create-job). */
9
9
  job_id: string;
10
10
  }
@@ -2,7 +2,8 @@ import type * as CatchAllApi from "../../../../index.js";
2
2
  /**
3
3
  * @example
4
4
  * {
5
- * query: "AI company acquisitions in fintech last week"
5
+ * query: "Series B funding rounds for SaaS startups",
6
+ * context: "Focus on funding amount and company name"
6
7
  * }
7
8
  */
8
9
  export interface InitializeRequestDto {
@@ -2,22 +2,22 @@ import type * as CatchAllApi from "../../../../index.js";
2
2
  /**
3
3
  * @example
4
4
  * {
5
- * query: "AI company acquisitions",
6
- * context: "Focus on deal size and acquiring company details",
5
+ * query: "Series B funding rounds for SaaS startups",
6
+ * context: "Focus on funding amount and company name",
7
7
  * limit: 10,
8
- * start_date: "2026-01-30T00:00:00Z",
9
- * end_date: "2026-02-05T00:00:00Z"
8
+ * start_date: "2026-02-18T00:00:00Z",
9
+ * end_date: "2026-02-23T00:00:00Z",
10
+ * mode: "base"
10
11
  * }
11
12
  */
12
13
  export interface SubmitRequestDto {
13
14
  query: CatchAllApi.Query;
14
- schema?: CatchAllApi.Schema;
15
15
  context?: CatchAllApi.Context;
16
16
  limit?: CatchAllApi.Limit;
17
17
  start_date?: CatchAllApi.StartDate;
18
18
  end_date?: CatchAllApi.EndDate;
19
19
  /**
20
- * Custom validators for filtering article clusters.
20
+ * Custom validators for filtering web page clusters.
21
21
  *
22
22
  * If not provided, validators are generated automatically based on the query.
23
23
  */
@@ -28,4 +28,24 @@ export interface SubmitRequestDto {
28
28
  * If not provided, enrichments are generated automatically based on the query.
29
29
  */
30
30
  enrichments?: CatchAllApi.EnrichmentSchema[];
31
+ /**
32
+ * Job processing mode.
33
+ *
34
+ * - `base`: Full pipeline with validation and enrichment.
35
+ * - `lite`: Lightweight extraction with faster processing. Returns titles and citations only.
36
+ */
37
+ mode?: SubmitRequestDto.Mode;
38
+ }
39
+ export declare namespace SubmitRequestDto {
40
+ /**
41
+ * Job processing mode.
42
+ *
43
+ * - `base`: Full pipeline with validation and enrichment.
44
+ * - `lite`: Lightweight extraction with faster processing. Returns titles and citations only.
45
+ */
46
+ const Mode: {
47
+ readonly Lite: "lite";
48
+ readonly Base: "base";
49
+ };
50
+ type Mode = (typeof Mode)[keyof typeof Mode];
31
51
  }
@@ -1,3 +1,17 @@
1
1
  "use strict";
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.SubmitRequestDto = void 0;
5
+ var SubmitRequestDto;
6
+ (function (SubmitRequestDto) {
7
+ /**
8
+ * Job processing mode.
9
+ *
10
+ * - `base`: Full pipeline with validation and enrichment.
11
+ * - `lite`: Lightweight extraction with faster processing. Returns titles and citations only.
12
+ */
13
+ SubmitRequestDto.Mode = {
14
+ Lite: "lite",
15
+ Base: "base",
16
+ };
17
+ })(SubmitRequestDto || (exports.SubmitRequestDto = SubmitRequestDto = {}));
@@ -3,4 +3,4 @@ export type { GetJobResultsRequest } from "./GetJobResultsRequest.js";
3
3
  export type { GetJobStatusRequest } from "./GetJobStatusRequest.js";
4
4
  export type { GetUserJobsRequest } from "./GetUserJobsRequest.js";
5
5
  export type { InitializeRequestDto } from "./InitializeRequestDto.js";
6
- export type { SubmitRequestDto } from "./SubmitRequestDto.js";
6
+ export { SubmitRequestDto } from "./SubmitRequestDto.js";
@@ -1,2 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SubmitRequestDto = void 0;
4
+ var SubmitRequestDto_js_1 = require("./SubmitRequestDto.js");
5
+ Object.defineProperty(exports, "SubmitRequestDto", { enumerable: true, get: function () { return SubmitRequestDto_js_1.SubmitRequestDto; } });
@@ -0,0 +1,2 @@
1
+ export { JobsClient } from "./client/Client.js";
2
+ export * from "./client/index.js";
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
+ };
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.JobsClient = void 0;
19
+ var Client_js_1 = require("./client/Client.js");
20
+ Object.defineProperty(exports, "JobsClient", { enumerable: true, get: function () { return Client_js_1.JobsClient; } });
21
+ __exportStar(require("./client/index.js"), exports);
@@ -1,7 +1,7 @@
1
1
  import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
2
- import { type NormalizedClientOptions } from "../../../../BaseClient.js";
2
+ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
3
3
  import * as core from "../../../../core/index.js";
4
- import type * as CatchAllApi from "../../../index.js";
4
+ import * as CatchAllApi from "../../../index.js";
5
5
  export declare namespace MetaClient {
6
6
  type Options = BaseClientOptions;
7
7
  interface RequestOptions extends BaseRequestOptions {
@@ -11,7 +11,7 @@ export declare namespace MetaClient {
11
11
  * Operations to check API health and version.
12
12
  */
13
13
  export declare class MetaClient {
14
- protected readonly _options: NormalizedClientOptions<MetaClient.Options>;
14
+ protected readonly _options: NormalizedClientOptionsWithAuth<MetaClient.Options>;
15
15
  constructor(options?: MetaClient.Options);
16
16
  /**
17
17
  * Check API availability.
@@ -33,4 +33,16 @@ export declare class MetaClient {
33
33
  */
34
34
  getVersion(requestOptions?: MetaClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.GetVersionResponse>;
35
35
  private __getVersion;
36
+ /**
37
+ * Returns plan features and current usage for the authenticated organization.
38
+ *
39
+ * @param {MetaClient.RequestOptions} requestOptions - Request-specific configuration.
40
+ *
41
+ * @throws {@link CatchAllApi.ForbiddenError}
42
+ *
43
+ * @example
44
+ * await client.meta.getPlanLimits()
45
+ */
46
+ getPlanLimits(requestOptions?: MetaClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.GetPlanLimitsResponseDto>;
47
+ private __getPlanLimits;
36
48
  }