newscatcher-catchall-sdk 0.3.1 → 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.
- package/README.md +284 -286
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/jobs/client/Client.d.ts +32 -8
- package/dist/cjs/api/resources/jobs/client/Client.js +93 -20
- package/dist/cjs/api/resources/jobs/client/requests/ContinueRequestDto.d.ts +3 -3
- package/dist/cjs/api/resources/jobs/client/requests/GetJobResultsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/jobs/client/requests/GetJobStatusRequest.d.ts +2 -2
- package/dist/cjs/api/resources/jobs/client/requests/GetUserJobsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/jobs/client/requests/InitializeRequestDto.d.ts +12 -0
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +17 -6
- package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/jobs/exports.d.ts +2 -0
- package/dist/cjs/api/resources/jobs/exports.js +21 -0
- package/dist/cjs/api/resources/meta/exports.d.ts +2 -0
- package/dist/cjs/api/resources/meta/exports.js +21 -0
- package/dist/cjs/api/resources/meta/types/GetVersionResponse.d.ts +1 -1
- package/dist/cjs/api/resources/meta/types/HealthCheckResponse.d.ts +1 -1
- package/dist/cjs/api/resources/monitors/client/Client.d.ts +23 -33
- package/dist/cjs/api/resources/monitors/client/Client.js +35 -37
- package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +26 -5
- package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequestDto.d.ts +17 -0
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.ts +2 -0
- package/dist/cjs/api/resources/monitors/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/monitors/exports.d.ts +2 -0
- package/dist/cjs/api/resources/monitors/exports.js +21 -0
- package/dist/cjs/api/types/BaseRecord.d.ts +38 -0
- package/dist/cjs/api/types/BaseRecord.js +16 -0
- package/dist/cjs/api/types/Citation.d.ts +3 -3
- package/dist/cjs/api/types/CompanyEnrichmentOutput.d.ts +29 -0
- package/dist/cjs/api/types/CompanyEnrichmentOutput.js +16 -0
- package/dist/cjs/api/types/ContinueResponseDto.d.ts +2 -2
- package/dist/cjs/api/types/CreateMonitorResponseDto.d.ts +1 -1
- package/dist/cjs/api/types/EndDate.d.ts +8 -0
- package/dist/cjs/api/types/EndDate.js +3 -0
- package/dist/cjs/api/types/EnrichmentSchema.d.ts +13 -0
- package/dist/cjs/api/types/EnrichmentSchema.js +3 -0
- package/dist/cjs/api/types/EnrichmentType.d.ts +19 -0
- package/dist/cjs/api/types/EnrichmentType.js +22 -0
- package/dist/cjs/api/types/Error_.d.ts +1 -1
- package/dist/cjs/api/types/InitializeResponseDto.d.ts +19 -0
- package/dist/cjs/api/types/InitializeResponseDto.js +3 -0
- package/dist/cjs/api/types/JobStep.d.ts +2 -2
- package/dist/cjs/api/types/Limit.d.ts +6 -0
- package/dist/cjs/api/types/Limit.js +3 -0
- package/dist/cjs/api/types/ListMonitorsResponseDto.d.ts +7 -1
- package/dist/cjs/api/types/ListUserJobsResponseDto.d.ts +11 -8
- package/dist/cjs/api/types/MonitorCitation.d.ts +3 -8
- package/dist/cjs/api/types/MonitorListItemDto.d.ts +7 -7
- package/dist/cjs/api/types/MonitorRecord.d.ts +4 -14
- package/dist/{esm/api/types/JobStatus.d.mts → cjs/api/types/PublicJobStatus.d.ts} +4 -4
- package/dist/cjs/api/types/{JobStatus.js → PublicJobStatus.js} +4 -4
- package/dist/cjs/api/types/PullJobResponseDto.d.ts +28 -23
- package/dist/cjs/api/types/PullMonitorResponseDto.d.ts +12 -12
- package/dist/cjs/api/types/Query.d.ts +1 -1
- package/dist/cjs/api/types/Record_.d.ts +2 -12
- package/dist/cjs/api/types/ReferenceJob.d.ts +3 -3
- package/dist/cjs/api/types/StartDate.d.ts +8 -0
- package/dist/cjs/api/types/StartDate.js +3 -0
- package/dist/cjs/api/types/StatusResponseDto.d.ts +2 -2
- package/dist/cjs/api/types/{SubmitResponseBody.d.ts → SubmitResponseDto.d.ts} +1 -1
- package/dist/cjs/api/types/SubmitResponseDto.js +3 -0
- package/dist/cjs/api/types/UserJob.d.ts +10 -0
- package/dist/cjs/api/types/UserJob.js +3 -0
- package/dist/cjs/api/types/ValidationErrorDetail.d.ts +3 -3
- package/dist/cjs/api/types/ValidationErrorResponse.d.ts +1 -1
- package/dist/cjs/api/types/ValidatorSchema.d.ts +13 -0
- package/dist/cjs/api/types/ValidatorSchema.js +3 -0
- package/dist/cjs/api/types/WebhookDto.d.ts +4 -4
- package/dist/cjs/api/types/WebhookPayload.d.ts +9 -9
- package/dist/cjs/api/types/index.d.ts +12 -3
- package/dist/cjs/api/types/index.js +12 -3
- package/dist/cjs/core/fetcher/Fetcher.js +8 -2
- package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -1
- package/dist/cjs/core/fetcher/makeRequest.js +30 -9
- package/dist/cjs/core/runtime/runtime.js +8 -7
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/jobs/client/Client.d.mts +32 -8
- package/dist/esm/api/resources/jobs/client/Client.mjs +93 -20
- package/dist/esm/api/resources/jobs/client/requests/ContinueRequestDto.d.mts +3 -3
- package/dist/esm/api/resources/jobs/client/requests/GetJobResultsRequest.d.mts +2 -2
- package/dist/esm/api/resources/jobs/client/requests/GetJobStatusRequest.d.mts +2 -2
- package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts +10 -0
- package/dist/esm/api/resources/jobs/client/requests/InitializeRequestDto.d.mts +12 -0
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +17 -6
- package/dist/esm/api/resources/jobs/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/jobs/exports.d.mts +2 -0
- package/dist/esm/api/resources/jobs/exports.mjs +3 -0
- package/dist/esm/api/resources/meta/exports.d.mts +2 -0
- package/dist/esm/api/resources/meta/exports.mjs +3 -0
- package/dist/esm/api/resources/meta/types/GetVersionResponse.d.mts +1 -1
- package/dist/esm/api/resources/meta/types/HealthCheckResponse.d.mts +1 -1
- package/dist/esm/api/resources/monitors/client/Client.d.mts +23 -33
- package/dist/esm/api/resources/monitors/client/Client.mjs +35 -37
- package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +26 -5
- package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequestDto.d.mts +17 -0
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +10 -0
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.mts +2 -0
- package/dist/esm/api/resources/monitors/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/monitors/exports.d.mts +2 -0
- package/dist/esm/api/resources/monitors/exports.mjs +3 -0
- package/dist/esm/api/types/BaseRecord.d.mts +38 -0
- package/dist/esm/api/types/BaseRecord.mjs +13 -0
- package/dist/esm/api/types/Citation.d.mts +3 -3
- package/dist/esm/api/types/CompanyEnrichmentOutput.d.mts +29 -0
- package/dist/esm/api/types/CompanyEnrichmentOutput.mjs +13 -0
- package/dist/esm/api/types/ContinueResponseDto.d.mts +2 -2
- package/dist/esm/api/types/CreateMonitorResponseDto.d.mts +1 -1
- package/dist/esm/api/types/EndDate.d.mts +8 -0
- package/dist/esm/api/types/EndDate.mjs +2 -0
- package/dist/esm/api/types/EnrichmentSchema.d.mts +13 -0
- package/dist/esm/api/types/EnrichmentSchema.mjs +2 -0
- package/dist/esm/api/types/EnrichmentType.d.mts +19 -0
- package/dist/esm/api/types/EnrichmentType.mjs +19 -0
- package/dist/esm/api/types/Error_.d.mts +1 -1
- package/dist/esm/api/types/InitializeResponseDto.d.mts +19 -0
- package/dist/esm/api/types/InitializeResponseDto.mjs +2 -0
- package/dist/esm/api/types/JobStep.d.mts +2 -2
- package/dist/esm/api/types/Limit.d.mts +6 -0
- package/dist/esm/api/types/Limit.mjs +2 -0
- package/dist/esm/api/types/ListMonitorsResponseDto.d.mts +7 -1
- package/dist/esm/api/types/ListUserJobsResponseDto.d.mts +11 -8
- package/dist/esm/api/types/MonitorCitation.d.mts +3 -8
- package/dist/esm/api/types/MonitorListItemDto.d.mts +7 -7
- package/dist/esm/api/types/MonitorRecord.d.mts +4 -14
- package/dist/{cjs/api/types/JobStatus.d.ts → esm/api/types/PublicJobStatus.d.mts} +4 -4
- package/dist/esm/api/types/{JobStatus.mjs → PublicJobStatus.mjs} +3 -3
- package/dist/esm/api/types/PullJobResponseDto.d.mts +28 -23
- package/dist/esm/api/types/PullMonitorResponseDto.d.mts +12 -12
- package/dist/esm/api/types/Query.d.mts +1 -1
- package/dist/esm/api/types/Record_.d.mts +2 -12
- package/dist/esm/api/types/ReferenceJob.d.mts +3 -3
- package/dist/esm/api/types/StartDate.d.mts +8 -0
- package/dist/esm/api/types/StartDate.mjs +2 -0
- package/dist/esm/api/types/StatusResponseDto.d.mts +2 -2
- package/dist/esm/api/types/{SubmitResponseBody.d.mts → SubmitResponseDto.d.mts} +1 -1
- package/dist/esm/api/types/SubmitResponseDto.mjs +2 -0
- package/dist/esm/api/types/UserJob.d.mts +10 -0
- package/dist/esm/api/types/UserJob.mjs +2 -0
- package/dist/esm/api/types/ValidationErrorDetail.d.mts +3 -3
- package/dist/esm/api/types/ValidationErrorResponse.d.mts +1 -1
- package/dist/esm/api/types/ValidatorSchema.d.mts +13 -0
- package/dist/esm/api/types/ValidatorSchema.mjs +2 -0
- package/dist/esm/api/types/WebhookDto.d.mts +4 -4
- package/dist/esm/api/types/WebhookPayload.d.mts +9 -9
- package/dist/esm/api/types/index.d.mts +12 -3
- package/dist/esm/api/types/index.mjs +12 -3
- package/dist/esm/core/fetcher/Fetcher.mjs +8 -2
- package/dist/esm/core/fetcher/makeRequest.d.mts +6 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +28 -9
- package/dist/esm/core/runtime/runtime.mjs +8 -7
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +37 -4
- package/reference.md +115 -40
- package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequest.d.ts +0 -10
- package/dist/cjs/api/types/Schema.d.ts +0 -6
- package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequest.d.mts +0 -10
- package/dist/esm/api/types/Schema.d.mts +0 -6
- /package/dist/cjs/api/resources/{monitors/client/requests/EnableMonitorRequest.js → jobs/client/requests/GetUserJobsRequest.js} +0 -0
- /package/dist/cjs/api/{types/Schema.js → resources/jobs/client/requests/InitializeRequestDto.js} +0 -0
- /package/dist/cjs/api/{types/SubmitResponseBody.js → resources/monitors/client/requests/EnableMonitorRequestDto.js} +0 -0
- /package/dist/esm/api/resources/{monitors/client/requests/EnableMonitorRequest.mjs → jobs/client/requests/GetUserJobsRequest.mjs} +0 -0
- /package/dist/esm/api/{types/Schema.mjs → resources/jobs/client/requests/InitializeRequestDto.mjs} +0 -0
- /package/dist/esm/api/{types/SubmitResponseBody.mjs → resources/monitors/client/requests/EnableMonitorRequestDto.mjs} +0 -0
|
@@ -34,16 +34,7 @@ export class MonitorsClient {
|
|
|
34
34
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* Create a monitor
|
|
38
|
-
*
|
|
39
|
-
* **Schedule requirements:**
|
|
40
|
-
* - Minimum 24-hour interval between executions
|
|
41
|
-
* - Natural language format (e.g., "every day at 12 PM UTC", "every 48 hours")
|
|
42
|
-
*
|
|
43
|
-
* **Validation:**
|
|
44
|
-
* - Schedules below minimum frequency return error with descriptive message.
|
|
45
|
-
* - Invalid job IDs return 400 Bad Request.
|
|
46
|
-
* - Duplicate monitors (same job already monitored) return error.
|
|
37
|
+
* Create a scheduled monitor based on a reference job.
|
|
47
38
|
*
|
|
48
39
|
* @param {CatchAllApi.CreateMonitorRequestDto} request
|
|
49
40
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -52,8 +43,17 @@ export class MonitorsClient {
|
|
|
52
43
|
*
|
|
53
44
|
* @example
|
|
54
45
|
* await client.monitors.createMonitor({
|
|
55
|
-
* reference_job_id: "
|
|
56
|
-
* schedule: "every day at 12 PM UTC"
|
|
46
|
+
* reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
|
|
47
|
+
* schedule: "every day at 12 PM UTC",
|
|
48
|
+
* webhook: {
|
|
49
|
+
* url: "https://your-endpoint.com/webhook",
|
|
50
|
+
* method: "POST",
|
|
51
|
+
* headers: {
|
|
52
|
+
* "Authorization": "Bearer your_token_here"
|
|
53
|
+
* }
|
|
54
|
+
* },
|
|
55
|
+
* limit: 10,
|
|
56
|
+
* backfill: true
|
|
57
57
|
* })
|
|
58
58
|
*/
|
|
59
59
|
createMonitor(request, requestOptions) {
|
|
@@ -97,15 +97,7 @@ export class MonitorsClient {
|
|
|
97
97
|
});
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
|
-
* Update webhook configuration for an existing monitor
|
|
101
|
-
*
|
|
102
|
-
* **Supported updates:**
|
|
103
|
-
* - Webhook URL
|
|
104
|
-
* - HTTP method (POST/PUT)
|
|
105
|
-
* - Headers and authentication
|
|
106
|
-
* - Query parameters
|
|
107
|
-
*
|
|
108
|
-
* **Note:** Schedule and reference job cannot be modified. To change these, create a new monitor.
|
|
100
|
+
* Update the webhook configuration for an existing monitor.
|
|
109
101
|
*
|
|
110
102
|
* @param {CatchAllApi.UpdateMonitorRequestDto} request
|
|
111
103
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -172,8 +164,7 @@ export class MonitorsClient {
|
|
|
172
164
|
});
|
|
173
165
|
}
|
|
174
166
|
/**
|
|
175
|
-
*
|
|
176
|
-
* Each job includes job_id, start_date, and end_date.
|
|
167
|
+
* Return all jobs executed by a monitor.
|
|
177
168
|
*
|
|
178
169
|
* @param {CatchAllApi.ListMonitorJobsRequest} request
|
|
179
170
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -230,8 +221,7 @@ export class MonitorsClient {
|
|
|
230
221
|
});
|
|
231
222
|
}
|
|
232
223
|
/**
|
|
233
|
-
* Retrieve aggregated results from all jobs executed by
|
|
234
|
-
* Includes monitor configuration, execution history, and all records collected.
|
|
224
|
+
* Retrieve aggregated results from all jobs executed by a monitor.
|
|
235
225
|
*
|
|
236
226
|
* @param {CatchAllApi.PullMonitorResultsRequest} request
|
|
237
227
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -285,8 +275,7 @@ export class MonitorsClient {
|
|
|
285
275
|
});
|
|
286
276
|
}
|
|
287
277
|
/**
|
|
288
|
-
*
|
|
289
|
-
* Validates that the provided API key is associated with the monitor.
|
|
278
|
+
* Stop scheduled job execution for a monitor.
|
|
290
279
|
*
|
|
291
280
|
* @param {CatchAllApi.DisableMonitorRequest} request
|
|
292
281
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -343,10 +332,9 @@ export class MonitorsClient {
|
|
|
343
332
|
});
|
|
344
333
|
}
|
|
345
334
|
/**
|
|
346
|
-
*
|
|
347
|
-
* Validates that the provided API key is associated with the monitor.
|
|
335
|
+
* Resume scheduled job execution for a monitor.
|
|
348
336
|
*
|
|
349
|
-
* @param {CatchAllApi.
|
|
337
|
+
* @param {CatchAllApi.EnableMonitorRequestDto} request
|
|
350
338
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
351
339
|
*
|
|
352
340
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -355,7 +343,8 @@ export class MonitorsClient {
|
|
|
355
343
|
*
|
|
356
344
|
* @example
|
|
357
345
|
* await client.monitors.enableMonitor({
|
|
358
|
-
* monitor_id: "monitor_id"
|
|
346
|
+
* monitor_id: "monitor_id",
|
|
347
|
+
* backfill: true
|
|
359
348
|
* })
|
|
360
349
|
*/
|
|
361
350
|
enableMonitor(request, requestOptions) {
|
|
@@ -364,14 +353,17 @@ export class MonitorsClient {
|
|
|
364
353
|
__enableMonitor(request, requestOptions) {
|
|
365
354
|
return __awaiter(this, void 0, void 0, function* () {
|
|
366
355
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
367
|
-
const { monitor_id: monitorId } = request;
|
|
356
|
+
const { monitor_id: monitorId } = request, _body = __rest(request, ["monitor_id"]);
|
|
368
357
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
369
358
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
370
359
|
const _response = yield core.fetcher({
|
|
371
360
|
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`),
|
|
372
361
|
method: "POST",
|
|
373
362
|
headers: _headers,
|
|
363
|
+
contentType: "application/json",
|
|
374
364
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
365
|
+
requestType: "json",
|
|
366
|
+
body: _body,
|
|
375
367
|
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,
|
|
376
368
|
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,
|
|
377
369
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -403,6 +395,7 @@ export class MonitorsClient {
|
|
|
403
395
|
/**
|
|
404
396
|
* Returns all monitors created by the authenticated user.
|
|
405
397
|
*
|
|
398
|
+
* @param {CatchAllApi.ListMonitorsRequest} request
|
|
406
399
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
407
400
|
*
|
|
408
401
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -411,19 +404,24 @@ export class MonitorsClient {
|
|
|
411
404
|
* @example
|
|
412
405
|
* await client.monitors.listMonitors()
|
|
413
406
|
*/
|
|
414
|
-
listMonitors(requestOptions) {
|
|
415
|
-
return core.HttpResponsePromise.fromPromise(this.__listMonitors(requestOptions));
|
|
407
|
+
listMonitors(request = {}, requestOptions) {
|
|
408
|
+
return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
|
|
416
409
|
}
|
|
417
|
-
__listMonitors(
|
|
418
|
-
return __awaiter(this,
|
|
410
|
+
__listMonitors() {
|
|
411
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
419
412
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
413
|
+
const { page, page_size: pageSize } = request;
|
|
414
|
+
const _queryParams = {
|
|
415
|
+
page,
|
|
416
|
+
page_size: pageSize,
|
|
417
|
+
};
|
|
420
418
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
421
419
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
422
420
|
const _response = yield core.fetcher({
|
|
423
421
|
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"),
|
|
424
422
|
method: "GET",
|
|
425
423
|
headers: _headers,
|
|
426
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
424
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
427
425
|
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,
|
|
428
426
|
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,
|
|
429
427
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -2,19 +2,40 @@ import type * as CatchAllApi from "../../../../index.mjs";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* reference_job_id: "
|
|
6
|
-
* schedule: "every day at 12 PM UTC"
|
|
5
|
+
* reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
|
|
6
|
+
* schedule: "every day at 12 PM UTC",
|
|
7
|
+
* webhook: {
|
|
8
|
+
* url: "https://your-endpoint.com/webhook",
|
|
9
|
+
* method: "POST",
|
|
10
|
+
* headers: {
|
|
11
|
+
* "Authorization": "Bearer your_token_here"
|
|
12
|
+
* }
|
|
13
|
+
* },
|
|
14
|
+
* limit: 10,
|
|
15
|
+
* backfill: true
|
|
7
16
|
* }
|
|
8
17
|
*/
|
|
9
18
|
export interface CreateMonitorRequestDto {
|
|
10
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* Job ID to use as template for scheduled runs. Defines the query, validators, and enrichments used for each scheduled run.
|
|
21
|
+
*
|
|
22
|
+
* If [`backfill`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/monitors/create-monitor#body-backfill) is true, the job's `end_date` must be within the last 7 days.
|
|
23
|
+
*/
|
|
11
24
|
reference_job_id: string;
|
|
12
25
|
/**
|
|
13
|
-
*
|
|
26
|
+
* Monitor schedule in plain text format (e.g. 'every day at 12 PM UTC', 'every 48 hours').
|
|
14
27
|
*
|
|
15
|
-
*
|
|
28
|
+
* Minimum frequency depends on your plan.
|
|
16
29
|
*/
|
|
17
30
|
schedule: string;
|
|
18
31
|
/** Optional webhook to receive notifications when jobs complete. */
|
|
19
32
|
webhook?: CatchAllApi.WebhookDto;
|
|
33
|
+
/** Maximum number of records per monitor run. If not provided, defaults to the plan limit. */
|
|
34
|
+
limit?: number;
|
|
35
|
+
/**
|
|
36
|
+
* If true, fills the data gap between the reference job's `end_date` and the first scheduled run. The reference job's `end_date` must be within the last 7 days.
|
|
37
|
+
*
|
|
38
|
+
* If false, no gap filling occurs and the first run uses the current cron window only — the reference job's age does not matter.
|
|
39
|
+
*/
|
|
40
|
+
backfill?: boolean;
|
|
20
41
|
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* monitor_id: "monitor_id",
|
|
5
|
+
* backfill: true
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface EnableMonitorRequestDto {
|
|
9
|
+
/** Monitor identifier. */
|
|
10
|
+
monitor_id: string;
|
|
11
|
+
/**
|
|
12
|
+
* If true, fills the data gap between the last job's `end_date` and the first scheduled run after enabling. The last job's `end_date` must be within the last 7 days.
|
|
13
|
+
*
|
|
14
|
+
* If false, no gap filling occurs and the first run uses the current cron window only — the last job's age does not matter.
|
|
15
|
+
*/
|
|
16
|
+
backfill?: boolean;
|
|
17
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export type { CreateMonitorRequestDto } from "./CreateMonitorRequestDto.mjs";
|
|
2
2
|
export type { DisableMonitorRequest } from "./DisableMonitorRequest.mjs";
|
|
3
|
-
export type {
|
|
3
|
+
export type { EnableMonitorRequestDto } from "./EnableMonitorRequestDto.mjs";
|
|
4
4
|
export type { ListMonitorJobsRequest } from "./ListMonitorJobsRequest.mjs";
|
|
5
|
+
export type { ListMonitorsRequest } from "./ListMonitorsRequest.mjs";
|
|
5
6
|
export type { PullMonitorResultsRequest } from "./PullMonitorResultsRequest.mjs";
|
|
6
7
|
export type { UpdateMonitorRequestDto } from "./UpdateMonitorRequestDto.mjs";
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export interface BaseRecord {
|
|
2
|
+
/** Unique identifier for the record. */
|
|
3
|
+
record_id: string;
|
|
4
|
+
/** Short title summarizing the record. */
|
|
5
|
+
record_title: string;
|
|
6
|
+
/**
|
|
7
|
+
* Structured data extracted from web pages. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
|
|
8
|
+
*
|
|
9
|
+
* **Note:** The system always includes the `enrichment_confidence` field within the `enrichment` object, regardless of whether enrichments are generated or specified by you.
|
|
10
|
+
*
|
|
11
|
+
* For integration guidance, see [Dynamic schemas](https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/dynamic-schemas)
|
|
12
|
+
*/
|
|
13
|
+
enrichment: BaseRecord.Enrichment;
|
|
14
|
+
}
|
|
15
|
+
export declare namespace BaseRecord {
|
|
16
|
+
/**
|
|
17
|
+
* Structured data extracted from web pages. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
|
|
18
|
+
*
|
|
19
|
+
* **Note:** The system always includes the `enrichment_confidence` field within the `enrichment` object, regardless of whether enrichments are generated or specified by you.
|
|
20
|
+
*
|
|
21
|
+
* For integration guidance, see [Dynamic schemas](https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/dynamic-schemas)
|
|
22
|
+
*/
|
|
23
|
+
interface Enrichment {
|
|
24
|
+
/** Overall confidence score for the enrichment extraction. */
|
|
25
|
+
enrichment_confidence?: (Enrichment.EnrichmentConfidence | null) | undefined;
|
|
26
|
+
/** Accepts any additional properties */
|
|
27
|
+
[key: string]: any;
|
|
28
|
+
}
|
|
29
|
+
namespace Enrichment {
|
|
30
|
+
/** Overall confidence score for the enrichment extraction. */
|
|
31
|
+
const EnrichmentConfidence: {
|
|
32
|
+
readonly Low: "low";
|
|
33
|
+
readonly Medium: "medium";
|
|
34
|
+
readonly High: "high";
|
|
35
|
+
};
|
|
36
|
+
type EnrichmentConfidence = (typeof EnrichmentConfidence)[keyof typeof EnrichmentConfidence];
|
|
37
|
+
}
|
|
38
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var BaseRecord;
|
|
3
|
+
(function (BaseRecord) {
|
|
4
|
+
let Enrichment;
|
|
5
|
+
(function (Enrichment) {
|
|
6
|
+
/** Overall confidence score for the enrichment extraction. */
|
|
7
|
+
Enrichment.EnrichmentConfidence = {
|
|
8
|
+
Low: "low",
|
|
9
|
+
Medium: "medium",
|
|
10
|
+
High: "high",
|
|
11
|
+
};
|
|
12
|
+
})(Enrichment = BaseRecord.Enrichment || (BaseRecord.Enrichment = {}));
|
|
13
|
+
})(BaseRecord || (BaseRecord = {}));
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export interface Citation {
|
|
2
|
-
/**
|
|
2
|
+
/** The title of the source document. */
|
|
3
3
|
title: string;
|
|
4
|
-
/** URL to the source
|
|
4
|
+
/** URL to the source document. */
|
|
5
5
|
link: string;
|
|
6
|
-
/**
|
|
6
|
+
/** The publication date of the source document in ISO 8601 format (UTC timezone). */
|
|
7
7
|
published_date: string;
|
|
8
8
|
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Appears as the value of company-typed fields in the `enrichment` object of each record. The `metadata` sub-object is populated by the system based on the identified company.
|
|
3
|
+
*/
|
|
4
|
+
export interface CompanyEnrichmentOutput {
|
|
5
|
+
/** The text span in the source document where the company was identified. */
|
|
6
|
+
source_text: string;
|
|
7
|
+
/** Confidence score for the company identification. */
|
|
8
|
+
confidence: number;
|
|
9
|
+
metadata: CompanyEnrichmentOutput.Metadata;
|
|
10
|
+
}
|
|
11
|
+
export declare namespace CompanyEnrichmentOutput {
|
|
12
|
+
interface Metadata {
|
|
13
|
+
/** Normalized company name. */
|
|
14
|
+
name: string;
|
|
15
|
+
/** Company website domain if resolved, otherwise null. */
|
|
16
|
+
domain_url?: (string | null) | undefined;
|
|
17
|
+
/** Confidence level for the domain URL resolution. */
|
|
18
|
+
domain_url_confidence?: (Metadata.DomainUrlConfidence | null) | undefined;
|
|
19
|
+
}
|
|
20
|
+
namespace Metadata {
|
|
21
|
+
/** Confidence level for the domain URL resolution. */
|
|
22
|
+
const DomainUrlConfidence: {
|
|
23
|
+
readonly Low: "low";
|
|
24
|
+
readonly Medium: "medium";
|
|
25
|
+
readonly High: "high";
|
|
26
|
+
};
|
|
27
|
+
type DomainUrlConfidence = (typeof DomainUrlConfidence)[keyof typeof DomainUrlConfidence];
|
|
28
|
+
}
|
|
29
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var CompanyEnrichmentOutput;
|
|
3
|
+
(function (CompanyEnrichmentOutput) {
|
|
4
|
+
let Metadata;
|
|
5
|
+
(function (Metadata) {
|
|
6
|
+
/** Confidence level for the domain URL resolution. */
|
|
7
|
+
Metadata.DomainUrlConfidence = {
|
|
8
|
+
Low: "low",
|
|
9
|
+
Medium: "medium",
|
|
10
|
+
High: "high",
|
|
11
|
+
};
|
|
12
|
+
})(Metadata = CompanyEnrichmentOutput.Metadata || (CompanyEnrichmentOutput.Metadata = {}));
|
|
13
|
+
})(CompanyEnrichmentOutput || (CompanyEnrichmentOutput = {}));
|
|
@@ -2,9 +2,9 @@ export interface ContinueResponseDto {
|
|
|
2
2
|
/** Job identifier for the continued job. */
|
|
3
3
|
job_id: string;
|
|
4
4
|
/** Previous record limit before continuation. */
|
|
5
|
-
previous_limit?: number;
|
|
5
|
+
previous_limit?: number | undefined;
|
|
6
6
|
/** New record limit after continuation. */
|
|
7
7
|
new_limit: number;
|
|
8
8
|
/** Confirmation that the continuation request was accepted. */
|
|
9
|
-
status
|
|
9
|
+
status: string;
|
|
10
10
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* End date for web search (ISO 8601 format with UTC timezone).
|
|
3
|
+
*
|
|
4
|
+
* Defines the end of the search window by web page discovery date, not event date. Web pages discovered within this range may describe events from any time period.
|
|
5
|
+
*
|
|
6
|
+
* Must be within plan's allowed search depth and after start_date. Default is current date if not specified.
|
|
7
|
+
*/
|
|
8
|
+
export type EndDate = string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Schema for a single enrichment field that extracts structured data.
|
|
4
|
+
*
|
|
5
|
+
* Enrichments are applied during the enriching stage to extract information from validated clusters.
|
|
6
|
+
*/
|
|
7
|
+
export interface EnrichmentSchema {
|
|
8
|
+
/** Enrichment field name (snake_case recommended). */
|
|
9
|
+
name: string;
|
|
10
|
+
/** What information this field extracts. */
|
|
11
|
+
description: string;
|
|
12
|
+
type: CatchAllApi.EnrichmentType;
|
|
13
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Canonical enrichment types supported by the system.
|
|
3
|
+
*
|
|
4
|
+
* - `text`: Free-form text strings (names, descriptions, summaries)
|
|
5
|
+
* - `number`: Numeric values (amounts, counts, percentages)
|
|
6
|
+
* - `date`: ISO format dates (YYYY-MM-DD)
|
|
7
|
+
* - `option`: Enum-like fixed values (status, category)
|
|
8
|
+
* - `url`: Web URLs
|
|
9
|
+
* - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`. See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
|
|
10
|
+
*/
|
|
11
|
+
export declare const EnrichmentType: {
|
|
12
|
+
readonly Text: "text";
|
|
13
|
+
readonly Number: "number";
|
|
14
|
+
readonly Date: "date";
|
|
15
|
+
readonly Option: "option";
|
|
16
|
+
readonly Url: "url";
|
|
17
|
+
readonly Company: "company";
|
|
18
|
+
};
|
|
19
|
+
export type EnrichmentType = (typeof EnrichmentType)[keyof typeof EnrichmentType];
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
/**
|
|
3
|
+
* Canonical enrichment types supported by the system.
|
|
4
|
+
*
|
|
5
|
+
* - `text`: Free-form text strings (names, descriptions, summaries)
|
|
6
|
+
* - `number`: Numeric values (amounts, counts, percentages)
|
|
7
|
+
* - `date`: ISO format dates (YYYY-MM-DD)
|
|
8
|
+
* - `option`: Enum-like fixed values (status, category)
|
|
9
|
+
* - `url`: Web URLs
|
|
10
|
+
* - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`. See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
|
|
11
|
+
*/
|
|
12
|
+
export const EnrichmentType = {
|
|
13
|
+
Text: "text",
|
|
14
|
+
Number: "number",
|
|
15
|
+
Date: "date",
|
|
16
|
+
Option: "option",
|
|
17
|
+
Url: "url",
|
|
18
|
+
Company: "company",
|
|
19
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface InitializeResponseDto {
|
|
3
|
+
/** Echo of the query from the request. */
|
|
4
|
+
query: string;
|
|
5
|
+
/** Echo of the context from the request. Null if not provided. */
|
|
6
|
+
context?: (string | null) | undefined;
|
|
7
|
+
/** Suggested validators for filtering relevant web pages. */
|
|
8
|
+
validators: CatchAllApi.ValidatorSchema[];
|
|
9
|
+
/** Suggested enrichment fields for data extraction. */
|
|
10
|
+
enrichments: CatchAllApi.EnrichmentSchema[];
|
|
11
|
+
start_date?: CatchAllApi.StartDate | undefined;
|
|
12
|
+
end_date?: CatchAllApi.EndDate | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* Messages explaining date adjustments due to plan limits.
|
|
15
|
+
*
|
|
16
|
+
* Empty array if no modifications were needed. Contains human-readable messages when requested dates exceed plan's allowed lookback period.
|
|
17
|
+
*/
|
|
18
|
+
date_modification_message?: string[] | undefined;
|
|
19
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type * as CatchAllApi from "../index.mjs";
|
|
2
2
|
export interface JobStep {
|
|
3
|
-
status: CatchAllApi.
|
|
3
|
+
status: CatchAllApi.PublicJobStatus;
|
|
4
4
|
/** Sequential position of this step in the pipeline (1-7). */
|
|
5
5
|
order: number;
|
|
6
6
|
/** Whether this step has finished processing. */
|
|
7
|
-
completed
|
|
7
|
+
completed: boolean;
|
|
8
8
|
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Maximum number of records to return. If not specified, defaults to your plan limit.
|
|
3
|
+
*
|
|
4
|
+
* Use [`POST /catchAll/continue`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/continue-job) to extend the limit after job completion without reprocessing.
|
|
5
|
+
*/
|
|
6
|
+
export type Limit = number;
|
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
import type * as CatchAllApi from "../index.mjs";
|
|
2
2
|
export interface ListMonitorsResponseDto {
|
|
3
3
|
/** Total number of monitors for this user. */
|
|
4
|
-
|
|
4
|
+
total: number;
|
|
5
|
+
/** Current page number. */
|
|
6
|
+
page: number;
|
|
7
|
+
/** Number of monitors per page. */
|
|
8
|
+
page_size: number;
|
|
9
|
+
/** Total number of pages available. */
|
|
10
|
+
total_pages: number;
|
|
5
11
|
/** Array of monitor summaries. */
|
|
6
12
|
monitors: CatchAllApi.MonitorListItemDto[];
|
|
7
13
|
}
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
1
2
|
export interface ListUserJobsResponseDto {
|
|
2
|
-
/**
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
|
|
3
|
+
/** Total number of jobs for this user. */
|
|
4
|
+
total: number;
|
|
5
|
+
/** Current page number. */
|
|
6
|
+
page: number;
|
|
7
|
+
/** Number of jobs per page. */
|
|
8
|
+
page_size: number;
|
|
9
|
+
/** Total number of pages available. */
|
|
10
|
+
total_pages: number;
|
|
11
|
+
/** Array of user jobs on this page. */
|
|
12
|
+
jobs: CatchAllApi.UserJob[];
|
|
10
13
|
}
|
|
@@ -1,16 +1,11 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
1
2
|
/**
|
|
2
3
|
* Citation with monitor-specific metadata. Used in monitor results and webhook payloads.
|
|
3
4
|
* Extends base citation with tracking information for job_id and timestamps.
|
|
4
5
|
*/
|
|
5
|
-
export interface MonitorCitation {
|
|
6
|
-
/**
|
|
6
|
+
export interface MonitorCitation extends CatchAllApi.Citation {
|
|
7
|
+
/** Unique identifier of the document in the search index. */
|
|
7
8
|
id: string;
|
|
8
|
-
/** Article title */
|
|
9
|
-
title: string;
|
|
10
|
-
/** URL to the source article */
|
|
11
|
-
link: string;
|
|
12
|
-
/** Article publication date in ISO 8601 format with UTC timezone. */
|
|
13
|
-
published_date: string;
|
|
14
9
|
/** Job ID that found this citation. */
|
|
15
10
|
job_id: string;
|
|
16
11
|
/** The date when the citation was added to the record in ISO 8601 format with UTC timezone. */
|
|
@@ -4,18 +4,18 @@ export interface MonitorListItemDto {
|
|
|
4
4
|
monitor_id: string;
|
|
5
5
|
/** Job identifier used as a reference for this monitor. */
|
|
6
6
|
reference_job_id: string;
|
|
7
|
-
/**
|
|
7
|
+
/** Plain text query from the reference job. */
|
|
8
8
|
reference_job_query: string;
|
|
9
9
|
/** Whether the monitor is currently active. */
|
|
10
10
|
enabled: boolean;
|
|
11
11
|
/** Cron expression for monitor schedule. */
|
|
12
|
-
schedule?: string;
|
|
13
|
-
/**
|
|
14
|
-
schedule_human_readable?: string;
|
|
12
|
+
schedule?: string | undefined;
|
|
13
|
+
/** The monitor schedule in a plain text format. */
|
|
14
|
+
schedule_human_readable?: string | undefined;
|
|
15
15
|
/** Timezone for schedule execution. */
|
|
16
|
-
timezone?: string;
|
|
16
|
+
timezone?: string | undefined;
|
|
17
17
|
/** The date when the monitor was created. */
|
|
18
|
-
created_at?: string;
|
|
18
|
+
created_at?: string | undefined;
|
|
19
19
|
/** Webhook configuration for this monitor (if set). */
|
|
20
|
-
webhook?: CatchAllApi.WebhookDto;
|
|
20
|
+
webhook?: CatchAllApi.WebhookDto | undefined;
|
|
21
21
|
}
|