newscatcher-catchall-sdk 1.0.0 → 1.1.2

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 (143) hide show
  1. package/README.md +284 -289
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/api/resources/jobs/client/Client.d.ts +13 -17
  4. package/dist/cjs/api/resources/jobs/client/Client.js +12 -19
  5. package/dist/cjs/api/resources/jobs/client/requests/ContinueRequestDto.d.ts +3 -3
  6. package/dist/cjs/api/resources/jobs/client/requests/GetJobResultsRequest.d.ts +2 -2
  7. package/dist/cjs/api/resources/jobs/client/requests/GetJobStatusRequest.d.ts +2 -2
  8. package/dist/cjs/api/resources/jobs/client/requests/InitializeRequestDto.d.ts +2 -1
  9. package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +5 -6
  10. package/dist/cjs/api/resources/jobs/exports.d.ts +2 -0
  11. package/dist/cjs/api/resources/jobs/exports.js +21 -0
  12. package/dist/cjs/api/resources/meta/exports.d.ts +2 -0
  13. package/dist/cjs/api/resources/meta/exports.js +21 -0
  14. package/dist/cjs/api/resources/meta/types/GetVersionResponse.d.ts +1 -1
  15. package/dist/cjs/api/resources/meta/types/HealthCheckResponse.d.ts +1 -1
  16. package/dist/cjs/api/resources/monitors/client/Client.d.ts +23 -37
  17. package/dist/cjs/api/resources/monitors/client/Client.js +35 -41
  18. package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +23 -6
  19. package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequestDto.d.ts +17 -0
  20. package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +10 -0
  21. package/dist/cjs/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.ts +2 -0
  22. package/dist/cjs/api/resources/monitors/client/requests/index.d.ts +2 -1
  23. package/dist/cjs/api/resources/monitors/exports.d.ts +2 -0
  24. package/dist/cjs/api/resources/monitors/exports.js +21 -0
  25. package/dist/cjs/api/types/BaseRecord.d.ts +38 -0
  26. package/dist/cjs/api/types/BaseRecord.js +16 -0
  27. package/dist/cjs/api/types/Citation.d.ts +3 -3
  28. package/dist/cjs/api/types/CompanyEnrichmentOutput.d.ts +29 -0
  29. package/dist/cjs/api/types/CompanyEnrichmentOutput.js +16 -0
  30. package/dist/cjs/api/types/ContinueResponseDto.d.ts +2 -2
  31. package/dist/cjs/api/types/CreateMonitorResponseDto.d.ts +1 -1
  32. package/dist/cjs/api/types/EndDate.d.ts +4 -2
  33. package/dist/cjs/api/types/EnrichmentType.d.ts +1 -3
  34. package/dist/cjs/api/types/EnrichmentType.js +1 -3
  35. package/dist/cjs/api/types/Error_.d.ts +1 -1
  36. package/dist/cjs/api/types/InitializeResponseDto.d.ts +8 -9
  37. package/dist/cjs/api/types/JobStep.d.ts +2 -2
  38. package/dist/cjs/api/types/Limit.d.ts +1 -1
  39. package/dist/cjs/api/types/ListMonitorsResponseDto.d.ts +7 -1
  40. package/dist/cjs/api/types/MonitorCitation.d.ts +3 -8
  41. package/dist/cjs/api/types/MonitorListItemDto.d.ts +7 -7
  42. package/dist/cjs/api/types/MonitorRecord.d.ts +4 -14
  43. package/dist/{esm/api/types/JobStatus.d.mts → cjs/api/types/PublicJobStatus.d.ts} +4 -4
  44. package/dist/cjs/api/types/{JobStatus.js → PublicJobStatus.js} +4 -4
  45. package/dist/cjs/api/types/PullJobResponseDto.d.ts +27 -22
  46. package/dist/cjs/api/types/PullMonitorResponseDto.d.ts +12 -12
  47. package/dist/cjs/api/types/Query.d.ts +1 -1
  48. package/dist/cjs/api/types/Record_.d.ts +2 -12
  49. package/dist/cjs/api/types/ReferenceJob.d.ts +3 -3
  50. package/dist/cjs/api/types/StartDate.d.ts +4 -2
  51. package/dist/cjs/api/types/StatusResponseDto.d.ts +2 -2
  52. package/dist/cjs/api/types/{SubmitResponseBody.d.ts → SubmitResponseDto.d.ts} +1 -1
  53. package/dist/cjs/api/types/UserJob.d.ts +1 -1
  54. package/dist/cjs/api/types/ValidationErrorDetail.d.ts +3 -3
  55. package/dist/cjs/api/types/ValidationErrorResponse.d.ts +1 -1
  56. package/dist/cjs/api/types/ValidatorSchema.d.ts +3 -3
  57. package/dist/cjs/api/types/WebhookDto.d.ts +4 -4
  58. package/dist/cjs/api/types/WebhookPayload.d.ts +9 -9
  59. package/dist/cjs/api/types/index.d.ts +4 -3
  60. package/dist/cjs/api/types/index.js +4 -3
  61. package/dist/cjs/core/fetcher/Fetcher.js +8 -2
  62. package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -1
  63. package/dist/cjs/core/fetcher/makeRequest.js +30 -9
  64. package/dist/cjs/core/runtime/runtime.js +8 -7
  65. package/dist/cjs/version.d.ts +1 -1
  66. package/dist/cjs/version.js +1 -1
  67. package/dist/esm/BaseClient.mjs +2 -2
  68. package/dist/esm/api/resources/jobs/client/Client.d.mts +13 -17
  69. package/dist/esm/api/resources/jobs/client/Client.mjs +12 -19
  70. package/dist/esm/api/resources/jobs/client/requests/ContinueRequestDto.d.mts +3 -3
  71. package/dist/esm/api/resources/jobs/client/requests/GetJobResultsRequest.d.mts +2 -2
  72. package/dist/esm/api/resources/jobs/client/requests/GetJobStatusRequest.d.mts +2 -2
  73. package/dist/esm/api/resources/jobs/client/requests/InitializeRequestDto.d.mts +2 -1
  74. package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +5 -6
  75. package/dist/esm/api/resources/jobs/exports.d.mts +2 -0
  76. package/dist/esm/api/resources/jobs/exports.mjs +3 -0
  77. package/dist/esm/api/resources/meta/exports.d.mts +2 -0
  78. package/dist/esm/api/resources/meta/exports.mjs +3 -0
  79. package/dist/esm/api/resources/meta/types/GetVersionResponse.d.mts +1 -1
  80. package/dist/esm/api/resources/meta/types/HealthCheckResponse.d.mts +1 -1
  81. package/dist/esm/api/resources/monitors/client/Client.d.mts +23 -37
  82. package/dist/esm/api/resources/monitors/client/Client.mjs +35 -41
  83. package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +23 -6
  84. package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequestDto.d.mts +17 -0
  85. package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +10 -0
  86. package/dist/esm/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.mts +2 -0
  87. package/dist/esm/api/resources/monitors/client/requests/index.d.mts +2 -1
  88. package/dist/esm/api/resources/monitors/exports.d.mts +2 -0
  89. package/dist/esm/api/resources/monitors/exports.mjs +3 -0
  90. package/dist/esm/api/types/BaseRecord.d.mts +38 -0
  91. package/dist/esm/api/types/BaseRecord.mjs +13 -0
  92. package/dist/esm/api/types/Citation.d.mts +3 -3
  93. package/dist/esm/api/types/CompanyEnrichmentOutput.d.mts +29 -0
  94. package/dist/esm/api/types/CompanyEnrichmentOutput.mjs +13 -0
  95. package/dist/esm/api/types/ContinueResponseDto.d.mts +2 -2
  96. package/dist/esm/api/types/CreateMonitorResponseDto.d.mts +1 -1
  97. package/dist/esm/api/types/EndDate.d.mts +4 -2
  98. package/dist/esm/api/types/EnrichmentType.d.mts +1 -3
  99. package/dist/esm/api/types/EnrichmentType.mjs +1 -3
  100. package/dist/esm/api/types/Error_.d.mts +1 -1
  101. package/dist/esm/api/types/InitializeResponseDto.d.mts +8 -9
  102. package/dist/esm/api/types/JobStep.d.mts +2 -2
  103. package/dist/esm/api/types/Limit.d.mts +1 -1
  104. package/dist/esm/api/types/ListMonitorsResponseDto.d.mts +7 -1
  105. package/dist/esm/api/types/MonitorCitation.d.mts +3 -8
  106. package/dist/esm/api/types/MonitorListItemDto.d.mts +7 -7
  107. package/dist/esm/api/types/MonitorRecord.d.mts +4 -14
  108. package/dist/{cjs/api/types/JobStatus.d.ts → esm/api/types/PublicJobStatus.d.mts} +4 -4
  109. package/dist/esm/api/types/{JobStatus.mjs → PublicJobStatus.mjs} +3 -3
  110. package/dist/esm/api/types/PullJobResponseDto.d.mts +27 -22
  111. package/dist/esm/api/types/PullMonitorResponseDto.d.mts +12 -12
  112. package/dist/esm/api/types/Query.d.mts +1 -1
  113. package/dist/esm/api/types/Record_.d.mts +2 -12
  114. package/dist/esm/api/types/ReferenceJob.d.mts +3 -3
  115. package/dist/esm/api/types/StartDate.d.mts +4 -2
  116. package/dist/esm/api/types/StatusResponseDto.d.mts +2 -2
  117. package/dist/esm/api/types/{SubmitResponseBody.d.mts → SubmitResponseDto.d.mts} +1 -1
  118. package/dist/esm/api/types/UserJob.d.mts +1 -1
  119. package/dist/esm/api/types/ValidationErrorDetail.d.mts +3 -3
  120. package/dist/esm/api/types/ValidationErrorResponse.d.mts +1 -1
  121. package/dist/esm/api/types/ValidatorSchema.d.mts +3 -3
  122. package/dist/esm/api/types/WebhookDto.d.mts +4 -4
  123. package/dist/esm/api/types/WebhookPayload.d.mts +9 -9
  124. package/dist/esm/api/types/index.d.mts +4 -3
  125. package/dist/esm/api/types/index.mjs +4 -3
  126. package/dist/esm/core/fetcher/Fetcher.mjs +8 -2
  127. package/dist/esm/core/fetcher/makeRequest.d.mts +6 -1
  128. package/dist/esm/core/fetcher/makeRequest.mjs +28 -9
  129. package/dist/esm/core/runtime/runtime.mjs +8 -7
  130. package/dist/esm/version.d.mts +1 -1
  131. package/dist/esm/version.mjs +1 -1
  132. package/package.json +37 -4
  133. package/reference.md +43 -53
  134. package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequest.d.ts +0 -10
  135. package/dist/cjs/api/types/Schema.d.ts +0 -6
  136. package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequest.d.mts +0 -10
  137. package/dist/esm/api/types/Schema.d.mts +0 -6
  138. /package/dist/cjs/api/resources/monitors/client/requests/{EnableMonitorRequest.js → EnableMonitorRequestDto.js} +0 -0
  139. /package/dist/cjs/api/{types/Schema.js → resources/monitors/client/requests/ListMonitorsRequest.js} +0 -0
  140. /package/dist/cjs/api/types/{SubmitResponseBody.js → SubmitResponseDto.js} +0 -0
  141. /package/dist/esm/api/resources/monitors/client/requests/{EnableMonitorRequest.mjs → EnableMonitorRequestDto.mjs} +0 -0
  142. /package/dist/esm/api/{types/Schema.mjs → resources/monitors/client/requests/ListMonitorsRequest.mjs} +0 -0
  143. /package/dist/esm/api/types/{SubmitResponseBody.mjs → SubmitResponseDto.mjs} +0 -0
@@ -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,14 @@ 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"
54
50
  * })
55
51
  */
56
- createJob(request: CatchAllApi.SubmitRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.SubmitResponseBody>;
52
+ createJob(request: CatchAllApi.SubmitRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.SubmitResponseDto>;
57
53
  private __createJob;
58
54
  /**
59
55
  * Continue an existing job to process more records beyond the initial limit.
@@ -67,7 +63,7 @@ export declare class JobsClient {
67
63
  *
68
64
  * @example
69
65
  * await client.jobs.continueJob({
70
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
66
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
71
67
  * new_limit: 100
72
68
  * })
73
69
  */
@@ -84,7 +80,7 @@ export declare class JobsClient {
84
80
  *
85
81
  * @example
86
82
  * await client.jobs.getJobStatus({
87
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
83
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
88
84
  * })
89
85
  */
90
86
  getJobStatus(request: CatchAllApi.GetJobStatusRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.StatusResponseDto>;
@@ -100,7 +96,7 @@ export declare class JobsClient {
100
96
  * @example
101
97
  * await client.jobs.getUserJobs()
102
98
  */
103
- getUserJobs(request?: CatchAllApi.GetUserJobsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListUserJobsResponseDto[]>;
99
+ getUserJobs(request?: CatchAllApi.GetUserJobsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListUserJobsResponseDto>;
104
100
  private __getUserJobs;
105
101
  /**
106
102
  * Retrieve the final results for a completed job.
@@ -113,7 +109,7 @@ export declare class JobsClient {
113
109
  *
114
110
  * @example
115
111
  * await client.jobs.getJobResults({
116
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
112
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
117
113
  * })
118
114
  */
119
115
  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,11 @@ 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"
139
135
  * })
140
136
  */
141
137
  createJob(request, requestOptions) {
@@ -194,7 +190,7 @@ class JobsClient {
194
190
  *
195
191
  * @example
196
192
  * await client.jobs.continueJob({
197
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
193
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
198
194
  * new_limit: 100
199
195
  * })
200
196
  */
@@ -253,7 +249,7 @@ class JobsClient {
253
249
  *
254
250
  * @example
255
251
  * await client.jobs.getJobStatus({
256
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
252
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
257
253
  * })
258
254
  */
259
255
  getJobStatus(request, requestOptions) {
@@ -332,10 +328,7 @@ class JobsClient {
332
328
  logging: this._options.logging,
333
329
  });
334
330
  if (_response.ok) {
335
- return {
336
- data: _response.body,
337
- rawResponse: _response.rawResponse,
338
- };
331
+ return { data: _response.body, rawResponse: _response.rawResponse };
339
332
  }
340
333
  if (_response.error.reason === "status-code") {
341
334
  switch (_response.error.statusCode) {
@@ -363,7 +356,7 @@ class JobsClient {
363
356
  *
364
357
  * @example
365
358
  * await client.jobs.getJobResults({
366
- * job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
359
+ * job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
367
360
  * })
368
361
  */
369
362
  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,21 @@ 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
10
  * }
11
11
  */
12
12
  export interface SubmitRequestDto {
13
13
  query: CatchAllApi.Query;
14
- schema?: CatchAllApi.Schema;
15
14
  context?: CatchAllApi.Context;
16
15
  limit?: CatchAllApi.Limit;
17
16
  start_date?: CatchAllApi.StartDate;
18
17
  end_date?: CatchAllApi.EndDate;
19
18
  /**
20
- * Custom validators for filtering article clusters.
19
+ * Custom validators for filtering web page clusters.
21
20
  *
22
21
  * If not provided, validators are generated automatically based on the query.
23
22
  */
@@ -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);
@@ -0,0 +1,2 @@
1
+ export { MetaClient } 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.MetaClient = void 0;
19
+ var Client_js_1 = require("./client/Client.js");
20
+ Object.defineProperty(exports, "MetaClient", { enumerable: true, get: function () { return Client_js_1.MetaClient; } });
21
+ __exportStar(require("./client/index.js"), exports);
@@ -1,3 +1,3 @@
1
1
  export interface GetVersionResponse {
2
- version?: string;
2
+ version?: string | undefined;
3
3
  }
@@ -1,3 +1,3 @@
1
1
  export interface HealthCheckResponse {
2
- healthy?: boolean;
2
+ healthy?: boolean | undefined;
3
3
  }
@@ -14,20 +14,7 @@ export declare class MonitorsClient {
14
14
  protected readonly _options: NormalizedClientOptionsWithAuth<MonitorsClient.Options>;
15
15
  constructor(options?: MonitorsClient.Options);
16
16
  /**
17
- * Create a monitor that runs jobs based on a reference job with a specified schedule.
18
- *
19
- * **Reference job requirements:**
20
- * - Job's `end_date` must be within the last 7 days
21
- *
22
- * **Schedule requirements:**
23
- * - Minimum 24-hour interval between executions
24
- * - Natural language format (e.g., "every day at 12 PM UTC", "every 48 hours")
25
- *
26
- * **Validation:**
27
- * - Reference jobs older than 7 days return 400 Bad Request.
28
- * - Schedules below minimum frequency return error with descriptive message.
29
- * - Invalid job IDs return 400 Bad Request.
30
- * - Duplicate monitors (same job already monitored) return error.
17
+ * Create a scheduled monitor based on a reference job.
31
18
  *
32
19
  * @param {CatchAllApi.CreateMonitorRequestDto} request
33
20
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -36,22 +23,23 @@ export declare class MonitorsClient {
36
23
  *
37
24
  * @example
38
25
  * await client.monitors.createMonitor({
39
- * reference_job_id: "reference_job_id",
40
- * schedule: "every day at 12 PM UTC"
26
+ * reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
27
+ * schedule: "every day at 12 PM UTC",
28
+ * webhook: {
29
+ * url: "https://your-endpoint.com/webhook",
30
+ * method: "POST",
31
+ * headers: {
32
+ * "Authorization": "Bearer your_token_here"
33
+ * }
34
+ * },
35
+ * limit: 10,
36
+ * backfill: true
41
37
  * })
42
38
  */
43
39
  createMonitor(request: CatchAllApi.CreateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateMonitorResponseDto>;
44
40
  private __createMonitor;
45
41
  /**
46
- * Update webhook configuration for an existing monitor without recreating it.
47
- *
48
- * **Supported updates:**
49
- * - Webhook URL
50
- * - HTTP method (POST/PUT)
51
- * - Headers and authentication
52
- * - Query parameters
53
- *
54
- * **Note:** Schedule and reference job cannot be modified. To change these, create a new monitor.
42
+ * Update the webhook configuration for an existing monitor.
55
43
  *
56
44
  * @param {CatchAllApi.UpdateMonitorRequestDto} request
57
45
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -75,8 +63,7 @@ export declare class MonitorsClient {
75
63
  updateMonitor(request: CatchAllApi.UpdateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateMonitorResponseDto>;
76
64
  private __updateMonitor;
77
65
  /**
78
- * Returns all jobs associated with a monitor, sorted by start_date.
79
- * Each job includes job_id, start_date, and end_date.
66
+ * Return all jobs executed by a monitor.
80
67
  *
81
68
  * @param {CatchAllApi.ListMonitorJobsRequest} request
82
69
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -92,8 +79,7 @@ export declare class MonitorsClient {
92
79
  listMonitorJobs(request: CatchAllApi.ListMonitorJobsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorJobsResponse>;
93
80
  private __listMonitorJobs;
94
81
  /**
95
- * Retrieve aggregated results from all jobs executed by this monitor.
96
- * Includes monitor configuration, execution history, and all records collected.
82
+ * Retrieve aggregated results from all jobs executed by a monitor.
97
83
  *
98
84
  * @param {CatchAllApi.PullMonitorResultsRequest} request
99
85
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -109,8 +95,7 @@ export declare class MonitorsClient {
109
95
  pullMonitorResults(request: CatchAllApi.PullMonitorResultsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullMonitorResponseDto>;
110
96
  private __pullMonitorResults;
111
97
  /**
112
- * Disables a monitor to stop executing scheduled jobs.
113
- * Validates that the provided API key is associated with the monitor.
98
+ * Stop scheduled job execution for a monitor.
114
99
  *
115
100
  * @param {CatchAllApi.DisableMonitorRequest} request
116
101
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -127,10 +112,9 @@ export declare class MonitorsClient {
127
112
  disableMonitor(request: CatchAllApi.DisableMonitorRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DisableMonitorResponse>;
128
113
  private __disableMonitor;
129
114
  /**
130
- * Enables a monitor to resume executing scheduled jobs.
131
- * Validates that the provided API key is associated with the monitor.
115
+ * Resume scheduled job execution for a monitor.
132
116
  *
133
- * @param {CatchAllApi.EnableMonitorRequest} request
117
+ * @param {CatchAllApi.EnableMonitorRequestDto} request
134
118
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
135
119
  *
136
120
  * @throws {@link CatchAllApi.ForbiddenError}
@@ -139,14 +123,16 @@ export declare class MonitorsClient {
139
123
  *
140
124
  * @example
141
125
  * await client.monitors.enableMonitor({
142
- * monitor_id: "monitor_id"
126
+ * monitor_id: "monitor_id",
127
+ * backfill: true
143
128
  * })
144
129
  */
145
- enableMonitor(request: CatchAllApi.EnableMonitorRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EnableMonitorResponse>;
130
+ enableMonitor(request: CatchAllApi.EnableMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EnableMonitorResponse>;
146
131
  private __enableMonitor;
147
132
  /**
148
133
  * Returns all monitors created by the authenticated user.
149
134
  *
135
+ * @param {CatchAllApi.ListMonitorsRequest} request
150
136
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
151
137
  *
152
138
  * @throws {@link CatchAllApi.ForbiddenError}
@@ -155,6 +141,6 @@ export declare class MonitorsClient {
155
141
  * @example
156
142
  * await client.monitors.listMonitors()
157
143
  */
158
- listMonitors(requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
144
+ listMonitors(request?: CatchAllApi.ListMonitorsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
159
145
  private __listMonitors;
160
146
  }
@@ -70,20 +70,7 @@ class MonitorsClient {
70
70
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
71
71
  }
72
72
  /**
73
- * Create a monitor that runs jobs based on a reference job with a specified schedule.
74
- *
75
- * **Reference job requirements:**
76
- * - Job's `end_date` must be within the last 7 days
77
- *
78
- * **Schedule requirements:**
79
- * - Minimum 24-hour interval between executions
80
- * - Natural language format (e.g., "every day at 12 PM UTC", "every 48 hours")
81
- *
82
- * **Validation:**
83
- * - Reference jobs older than 7 days return 400 Bad Request.
84
- * - Schedules below minimum frequency return error with descriptive message.
85
- * - Invalid job IDs return 400 Bad Request.
86
- * - Duplicate monitors (same job already monitored) return error.
73
+ * Create a scheduled monitor based on a reference job.
87
74
  *
88
75
  * @param {CatchAllApi.CreateMonitorRequestDto} request
89
76
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -92,8 +79,17 @@ class MonitorsClient {
92
79
  *
93
80
  * @example
94
81
  * await client.monitors.createMonitor({
95
- * reference_job_id: "reference_job_id",
96
- * schedule: "every day at 12 PM UTC"
82
+ * reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
83
+ * schedule: "every day at 12 PM UTC",
84
+ * webhook: {
85
+ * url: "https://your-endpoint.com/webhook",
86
+ * method: "POST",
87
+ * headers: {
88
+ * "Authorization": "Bearer your_token_here"
89
+ * }
90
+ * },
91
+ * limit: 10,
92
+ * backfill: true
97
93
  * })
98
94
  */
99
95
  createMonitor(request, requestOptions) {
@@ -137,15 +133,7 @@ class MonitorsClient {
137
133
  });
138
134
  }
139
135
  /**
140
- * Update webhook configuration for an existing monitor without recreating it.
141
- *
142
- * **Supported updates:**
143
- * - Webhook URL
144
- * - HTTP method (POST/PUT)
145
- * - Headers and authentication
146
- * - Query parameters
147
- *
148
- * **Note:** Schedule and reference job cannot be modified. To change these, create a new monitor.
136
+ * Update the webhook configuration for an existing monitor.
149
137
  *
150
138
  * @param {CatchAllApi.UpdateMonitorRequestDto} request
151
139
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -212,8 +200,7 @@ class MonitorsClient {
212
200
  });
213
201
  }
214
202
  /**
215
- * Returns all jobs associated with a monitor, sorted by start_date.
216
- * Each job includes job_id, start_date, and end_date.
203
+ * Return all jobs executed by a monitor.
217
204
  *
218
205
  * @param {CatchAllApi.ListMonitorJobsRequest} request
219
206
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -270,8 +257,7 @@ class MonitorsClient {
270
257
  });
271
258
  }
272
259
  /**
273
- * Retrieve aggregated results from all jobs executed by this monitor.
274
- * Includes monitor configuration, execution history, and all records collected.
260
+ * Retrieve aggregated results from all jobs executed by a monitor.
275
261
  *
276
262
  * @param {CatchAllApi.PullMonitorResultsRequest} request
277
263
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -325,8 +311,7 @@ class MonitorsClient {
325
311
  });
326
312
  }
327
313
  /**
328
- * Disables a monitor to stop executing scheduled jobs.
329
- * Validates that the provided API key is associated with the monitor.
314
+ * Stop scheduled job execution for a monitor.
330
315
  *
331
316
  * @param {CatchAllApi.DisableMonitorRequest} request
332
317
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -383,10 +368,9 @@ class MonitorsClient {
383
368
  });
384
369
  }
385
370
  /**
386
- * Enables a monitor to resume executing scheduled jobs.
387
- * Validates that the provided API key is associated with the monitor.
371
+ * Resume scheduled job execution for a monitor.
388
372
  *
389
- * @param {CatchAllApi.EnableMonitorRequest} request
373
+ * @param {CatchAllApi.EnableMonitorRequestDto} request
390
374
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
391
375
  *
392
376
  * @throws {@link CatchAllApi.ForbiddenError}
@@ -395,7 +379,8 @@ class MonitorsClient {
395
379
  *
396
380
  * @example
397
381
  * await client.monitors.enableMonitor({
398
- * monitor_id: "monitor_id"
382
+ * monitor_id: "monitor_id",
383
+ * backfill: true
399
384
  * })
400
385
  */
401
386
  enableMonitor(request, requestOptions) {
@@ -404,14 +389,17 @@ class MonitorsClient {
404
389
  __enableMonitor(request, requestOptions) {
405
390
  return __awaiter(this, void 0, void 0, function* () {
406
391
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
407
- const { monitor_id: monitorId } = request;
392
+ const { monitor_id: monitorId } = request, _body = __rest(request, ["monitor_id"]);
408
393
  const _authRequest = yield this._options.authProvider.getAuthRequest();
409
394
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
410
395
  const _response = yield core.fetcher({
411
396
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/${core.url.encodePathParam(monitorId)}/enable`),
412
397
  method: "POST",
413
398
  headers: _headers,
399
+ contentType: "application/json",
414
400
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
401
+ requestType: "json",
402
+ body: _body,
415
403
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
416
404
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
417
405
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -443,6 +431,7 @@ class MonitorsClient {
443
431
  /**
444
432
  * Returns all monitors created by the authenticated user.
445
433
  *
434
+ * @param {CatchAllApi.ListMonitorsRequest} request
446
435
  * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
447
436
  *
448
437
  * @throws {@link CatchAllApi.ForbiddenError}
@@ -451,19 +440,24 @@ class MonitorsClient {
451
440
  * @example
452
441
  * await client.monitors.listMonitors()
453
442
  */
454
- listMonitors(requestOptions) {
455
- return core.HttpResponsePromise.fromPromise(this.__listMonitors(requestOptions));
443
+ listMonitors(request = {}, requestOptions) {
444
+ return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
456
445
  }
457
- __listMonitors(requestOptions) {
458
- return __awaiter(this, void 0, void 0, function* () {
446
+ __listMonitors() {
447
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
459
448
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
449
+ const { page, page_size: pageSize } = request;
450
+ const _queryParams = {
451
+ page,
452
+ page_size: pageSize,
453
+ };
460
454
  const _authRequest = yield this._options.authProvider.getAuthRequest();
461
455
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
462
456
  const _response = yield core.fetcher({
463
457
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, "catchAll/monitors"),
464
458
  method: "GET",
465
459
  headers: _headers,
466
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
460
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
467
461
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
468
462
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
469
463
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,