newscatcher-catchall-sdk 1.4.0 → 1.5.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.
- package/README.md +2 -0
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/errors/UnauthorizedError.d.ts +6 -0
- package/dist/cjs/api/errors/UnauthorizedError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/datasets/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/datasets/client/Client.js +22 -13
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/entities/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/entities/client/Client.js +11 -7
- package/dist/cjs/api/resources/jobs/client/Client.d.ts +22 -0
- package/dist/cjs/api/resources/jobs/client/Client.js +77 -7
- package/dist/cjs/api/resources/jobs/client/requests/DeleteJobRequest.d.ts +10 -0
- package/dist/cjs/api/resources/jobs/client/requests/DeleteJobRequest.js +3 -0
- package/dist/cjs/api/resources/jobs/client/requests/GetUserJobsRequest.d.ts +5 -0
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +1 -1
- package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/meta/client/Client.js +3 -3
- package/dist/cjs/api/resources/monitors/client/Client.d.ts +39 -0
- package/dist/cjs/api/resources/monitors/client/Client.js +136 -8
- package/dist/cjs/api/resources/monitors/client/requests/DeleteMonitorRequest.d.ts +10 -0
- package/dist/cjs/api/resources/monitors/client/requests/DeleteMonitorRequest.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/GetMonitorStatusHistoryRequest.d.ts +10 -0
- package/dist/cjs/api/resources/monitors/client/requests/GetMonitorStatusHistoryRequest.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +5 -0
- package/dist/cjs/api/resources/monitors/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/types/ConnectedEntity.d.ts +1 -1
- package/dist/cjs/api/types/DeleteJobResponseDto.d.ts +8 -0
- package/dist/cjs/api/types/DeleteJobResponseDto.js +3 -0
- package/dist/cjs/api/types/DeleteMonitorResponseDto.d.ts +8 -0
- package/dist/cjs/api/types/DeleteMonitorResponseDto.js +3 -0
- package/dist/cjs/api/types/MonitorListItemDto.d.ts +2 -0
- package/dist/cjs/api/types/MonitorStatusEntry.d.ts +68 -0
- package/dist/cjs/api/types/MonitorStatusEntry.js +27 -0
- package/dist/cjs/api/types/MonitorStatusHistoryResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/MonitorStatusHistoryResponseDto.js +3 -0
- package/dist/cjs/api/types/OwnershipFilter.d.ts +14 -0
- package/dist/cjs/api/types/OwnershipFilter.js +17 -0
- package/dist/cjs/api/types/PullJobResponseDto.d.ts +2 -0
- package/dist/cjs/api/types/SharingInfo.d.ts +24 -0
- package/dist/cjs/api/types/SharingInfo.js +13 -0
- package/dist/cjs/api/types/UserJob.d.ts +3 -0
- package/dist/cjs/api/types/index.d.ts +6 -0
- package/dist/cjs/api/types/index.js +6 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
- package/dist/cjs/core/fetcher/Fetcher.js +9 -8
- package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
- package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
- package/dist/cjs/core/url/index.d.ts +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/qs.d.ts +2 -1
- package/dist/cjs/core/url/qs.js +24 -12
- 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/errors/UnauthorizedError.d.mts +6 -0
- package/dist/esm/api/errors/UnauthorizedError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/datasets/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/datasets/client/Client.mjs +22 -13
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.d.mts +2 -0
- package/dist/esm/api/resources/entities/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/entities/client/Client.mjs +11 -7
- package/dist/esm/api/resources/jobs/client/Client.d.mts +22 -0
- package/dist/esm/api/resources/jobs/client/Client.mjs +77 -7
- package/dist/esm/api/resources/jobs/client/requests/DeleteJobRequest.d.mts +10 -0
- package/dist/esm/api/resources/jobs/client/requests/DeleteJobRequest.mjs +2 -0
- package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts +5 -0
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +1 -1
- package/dist/esm/api/resources/jobs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/meta/client/Client.mjs +3 -3
- package/dist/esm/api/resources/monitors/client/Client.d.mts +39 -0
- package/dist/esm/api/resources/monitors/client/Client.mjs +136 -8
- package/dist/esm/api/resources/monitors/client/requests/DeleteMonitorRequest.d.mts +10 -0
- package/dist/esm/api/resources/monitors/client/requests/DeleteMonitorRequest.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/GetMonitorStatusHistoryRequest.d.mts +10 -0
- package/dist/esm/api/resources/monitors/client/requests/GetMonitorStatusHistoryRequest.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +5 -0
- package/dist/esm/api/resources/monitors/client/requests/index.d.mts +2 -0
- package/dist/esm/api/types/ConnectedEntity.d.mts +1 -1
- package/dist/esm/api/types/DeleteJobResponseDto.d.mts +8 -0
- package/dist/esm/api/types/DeleteJobResponseDto.mjs +2 -0
- package/dist/esm/api/types/DeleteMonitorResponseDto.d.mts +8 -0
- package/dist/esm/api/types/DeleteMonitorResponseDto.mjs +2 -0
- package/dist/esm/api/types/MonitorListItemDto.d.mts +2 -0
- package/dist/esm/api/types/MonitorStatusEntry.d.mts +68 -0
- package/dist/esm/api/types/MonitorStatusEntry.mjs +24 -0
- package/dist/esm/api/types/MonitorStatusHistoryResponseDto.d.mts +13 -0
- package/dist/esm/api/types/MonitorStatusHistoryResponseDto.mjs +2 -0
- package/dist/esm/api/types/OwnershipFilter.d.mts +14 -0
- package/dist/esm/api/types/OwnershipFilter.mjs +14 -0
- package/dist/esm/api/types/PullJobResponseDto.d.mts +2 -0
- package/dist/esm/api/types/SharingInfo.d.mts +24 -0
- package/dist/esm/api/types/SharingInfo.mjs +10 -0
- package/dist/esm/api/types/UserJob.d.mts +3 -0
- package/dist/esm/api/types/index.d.mts +6 -0
- package/dist/esm/api/types/index.mjs +6 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
- package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
- package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
- package/dist/esm/core/url/index.d.mts +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/qs.d.mts +2 -1
- package/dist/esm/core/url/qs.mjs +24 -12
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +208 -0
package/README.md
CHANGED
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -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.
|
|
47
|
-
"User-Agent": "newscatcher-catchall-sdk/1.
|
|
46
|
+
"X-Fern-SDK-Version": "1.5.1",
|
|
47
|
+
"User-Agent": "newscatcher-catchall-sdk/1.5.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);
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type * as core from "../../core/index.js";
|
|
2
|
+
import * as errors from "../../errors/index.js";
|
|
3
|
+
import type * as CatchAllApi from "../index.js";
|
|
4
|
+
export declare class UnauthorizedError extends errors.CatchAllApiError {
|
|
5
|
+
constructor(body: CatchAllApi.Error_, rawResponse?: core.RawResponse);
|
|
6
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
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 __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
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.UnauthorizedError = void 0;
|
|
38
|
+
const errors = __importStar(require("../../errors/index.js"));
|
|
39
|
+
class UnauthorizedError extends errors.CatchAllApiError {
|
|
40
|
+
constructor(body, rawResponse) {
|
|
41
|
+
super({
|
|
42
|
+
message: "UnauthorizedError",
|
|
43
|
+
statusCode: 401,
|
|
44
|
+
body: body,
|
|
45
|
+
rawResponse: rawResponse,
|
|
46
|
+
});
|
|
47
|
+
Object.setPrototypeOf(this, new.target.prototype);
|
|
48
|
+
if (Error.captureStackTrace) {
|
|
49
|
+
Error.captureStackTrace(this, this.constructor);
|
|
50
|
+
}
|
|
51
|
+
this.name = this.constructor.name;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
exports.UnauthorizedError = UnauthorizedError;
|
|
@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./BadRequestError.js"), exports);
|
|
18
18
|
__exportStar(require("./ForbiddenError.js"), exports);
|
|
19
19
|
__exportStar(require("./NotFoundError.js"), exports);
|
|
20
|
+
__exportStar(require("./UnauthorizedError.js"), exports);
|
|
20
21
|
__exportStar(require("./UnprocessableEntityError.js"), exports);
|
|
@@ -12,7 +12,7 @@ export declare namespace DatasetsClient {
|
|
|
12
12
|
*
|
|
13
13
|
* A dataset is a named collection of entities — think of it as a watchlist or
|
|
14
14
|
* portfolio. Connect a dataset to a job via `connected_dataset_ids` to activate
|
|
15
|
-
* Company
|
|
15
|
+
* Company Watchlist. Datasets can be reused across multiple jobs and monitors.
|
|
16
16
|
*/
|
|
17
17
|
export declare class DatasetsClient {
|
|
18
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<DatasetsClient.Options>;
|
|
@@ -67,7 +67,7 @@ const CatchAllApi = __importStar(require("../../../index.js"));
|
|
|
67
67
|
*
|
|
68
68
|
* A dataset is a named collection of entities — think of it as a watchlist or
|
|
69
69
|
* portfolio. Connect a dataset to a job via `connected_dataset_ids` to activate
|
|
70
|
-
* Company
|
|
70
|
+
* Company Watchlist. Datasets can be reused across multiple jobs and monitors.
|
|
71
71
|
*/
|
|
72
72
|
class DatasetsClient {
|
|
73
73
|
constructor(options = {}) {
|
|
@@ -94,7 +94,7 @@ class DatasetsClient {
|
|
|
94
94
|
__listDatasets() {
|
|
95
95
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
96
96
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
97
|
-
const { page, page_size: pageSize, search, latest_status: latestStatus, sort_by: sortBy, sort_order: sortOrder, } = request;
|
|
97
|
+
const { page, page_size: pageSize, search, latest_status: latestStatus, sort_by: sortBy, sort_order: sortOrder, ownership, } = request;
|
|
98
98
|
const _queryParams = {
|
|
99
99
|
page,
|
|
100
100
|
page_size: pageSize,
|
|
@@ -102,6 +102,7 @@ class DatasetsClient {
|
|
|
102
102
|
latest_status: latestStatus != null ? latestStatus : undefined,
|
|
103
103
|
sort_by: sortBy != null ? sortBy : undefined,
|
|
104
104
|
sort_order: sortOrder != null ? sortOrder : undefined,
|
|
105
|
+
ownership: ownership != null ? ownership : undefined,
|
|
105
106
|
};
|
|
106
107
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
107
108
|
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);
|
|
@@ -109,7 +110,11 @@ class DatasetsClient {
|
|
|
109
110
|
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/datasets"),
|
|
110
111
|
method: "GET",
|
|
111
112
|
headers: _headers,
|
|
112
|
-
|
|
113
|
+
queryString: core.url
|
|
114
|
+
.queryBuilder()
|
|
115
|
+
.addMany(_queryParams)
|
|
116
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
117
|
+
.build(),
|
|
113
118
|
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,
|
|
114
119
|
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,
|
|
115
120
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -171,7 +176,7 @@ class DatasetsClient {
|
|
|
171
176
|
method: "POST",
|
|
172
177
|
headers: _headers,
|
|
173
178
|
contentType: "application/json",
|
|
174
|
-
|
|
179
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
175
180
|
requestType: "json",
|
|
176
181
|
body: request,
|
|
177
182
|
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,
|
|
@@ -250,7 +255,7 @@ class DatasetsClient {
|
|
|
250
255
|
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/datasets/upload"),
|
|
251
256
|
method: "POST",
|
|
252
257
|
headers: _headers,
|
|
253
|
-
|
|
258
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
254
259
|
requestType: "file",
|
|
255
260
|
duplex: _maybeEncodedRequest.duplex,
|
|
256
261
|
body: _maybeEncodedRequest.body,
|
|
@@ -307,7 +312,7 @@ class DatasetsClient {
|
|
|
307
312
|
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/datasets/${core.url.encodePathParam(datasetId)}`),
|
|
308
313
|
method: "GET",
|
|
309
314
|
headers: _headers,
|
|
310
|
-
|
|
315
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
311
316
|
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,
|
|
312
317
|
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,
|
|
313
318
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -363,7 +368,7 @@ class DatasetsClient {
|
|
|
363
368
|
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/datasets/${core.url.encodePathParam(datasetId)}`),
|
|
364
369
|
method: "DELETE",
|
|
365
370
|
headers: _headers,
|
|
366
|
-
|
|
371
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
367
372
|
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,
|
|
368
373
|
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,
|
|
369
374
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -421,7 +426,7 @@ class DatasetsClient {
|
|
|
421
426
|
method: "PATCH",
|
|
422
427
|
headers: _headers,
|
|
423
428
|
contentType: "application/json",
|
|
424
|
-
|
|
429
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
425
430
|
requestType: "json",
|
|
426
431
|
body: _body,
|
|
427
432
|
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,
|
|
@@ -488,7 +493,11 @@ class DatasetsClient {
|
|
|
488
493
|
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/datasets/${core.url.encodePathParam(datasetId)}/entities`),
|
|
489
494
|
method: "GET",
|
|
490
495
|
headers: _headers,
|
|
491
|
-
|
|
496
|
+
queryString: core.url
|
|
497
|
+
.queryBuilder()
|
|
498
|
+
.addMany(_queryParams)
|
|
499
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
500
|
+
.build(),
|
|
492
501
|
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,
|
|
493
502
|
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,
|
|
494
503
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -550,7 +559,7 @@ class DatasetsClient {
|
|
|
550
559
|
method: "POST",
|
|
551
560
|
headers: _headers,
|
|
552
561
|
contentType: "application/json",
|
|
553
|
-
|
|
562
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
554
563
|
requestType: "json",
|
|
555
564
|
body: _body,
|
|
556
565
|
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,
|
|
@@ -615,7 +624,7 @@ class DatasetsClient {
|
|
|
615
624
|
method: "DELETE",
|
|
616
625
|
headers: _headers,
|
|
617
626
|
contentType: "application/json",
|
|
618
|
-
|
|
627
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
619
628
|
requestType: "json",
|
|
620
629
|
body: _body,
|
|
621
630
|
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,
|
|
@@ -674,7 +683,7 @@ class DatasetsClient {
|
|
|
674
683
|
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/datasets/${core.url.encodePathParam(datasetId)}/status`),
|
|
675
684
|
method: "GET",
|
|
676
685
|
headers: _headers,
|
|
677
|
-
|
|
686
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
678
687
|
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,
|
|
679
688
|
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,
|
|
680
689
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -740,7 +749,7 @@ class DatasetsClient {
|
|
|
740
749
|
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/datasets/${core.url.encodePathParam(request.dataset_id)}/upload`),
|
|
741
750
|
method: "POST",
|
|
742
751
|
headers: _headers,
|
|
743
|
-
|
|
752
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
744
753
|
requestType: "file",
|
|
745
754
|
duplex: _maybeEncodedRequest.duplex,
|
|
746
755
|
body: _maybeEncodedRequest.body,
|
|
@@ -16,4 +16,6 @@ export interface ListDatasetsRequest {
|
|
|
16
16
|
latest_status?: CatchAllApi.DatasetStatus;
|
|
17
17
|
sort_by?: CatchAllApi.DatasetSortBy;
|
|
18
18
|
sort_order?: CatchAllApi.SortOrder;
|
|
19
|
+
/** Filter results by ownership. Defaults to `all`. */
|
|
20
|
+
ownership?: CatchAllApi.OwnershipFilter;
|
|
19
21
|
}
|
|
@@ -10,7 +10,7 @@ export declare namespace EntitiesClient {
|
|
|
10
10
|
/**
|
|
11
11
|
* Operations to create, update, and delete company entities.
|
|
12
12
|
*
|
|
13
|
-
* Entities are the building blocks of Company
|
|
13
|
+
* Entities are the building blocks of Company Watchlist. Each entity represents
|
|
14
14
|
* a company (or person) you want to track. Add identifying information such as
|
|
15
15
|
* domain, alternative names, and key persons to improve matching quality.
|
|
16
16
|
*/
|
|
@@ -65,7 +65,7 @@ const CatchAllApi = __importStar(require("../../../index.js"));
|
|
|
65
65
|
/**
|
|
66
66
|
* Operations to create, update, and delete company entities.
|
|
67
67
|
*
|
|
68
|
-
* Entities are the building blocks of Company
|
|
68
|
+
* Entities are the building blocks of Company Watchlist. Each entity represents
|
|
69
69
|
* a company (or person) you want to track. Add identifying information such as
|
|
70
70
|
* domain, alternative names, and key persons to improve matching quality.
|
|
71
71
|
*/
|
|
@@ -110,7 +110,11 @@ class EntitiesClient {
|
|
|
110
110
|
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/entities"),
|
|
111
111
|
method: "GET",
|
|
112
112
|
headers: _headers,
|
|
113
|
-
|
|
113
|
+
queryString: core.url
|
|
114
|
+
.queryBuilder()
|
|
115
|
+
.addMany(_queryParams)
|
|
116
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
117
|
+
.build(),
|
|
114
118
|
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,
|
|
115
119
|
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,
|
|
116
120
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -176,7 +180,7 @@ class EntitiesClient {
|
|
|
176
180
|
method: "POST",
|
|
177
181
|
headers: _headers,
|
|
178
182
|
contentType: "application/json",
|
|
179
|
-
|
|
183
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
180
184
|
requestType: "json",
|
|
181
185
|
body: request,
|
|
182
186
|
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,
|
|
@@ -257,7 +261,7 @@ class EntitiesClient {
|
|
|
257
261
|
method: "POST",
|
|
258
262
|
headers: _headers,
|
|
259
263
|
contentType: "application/json",
|
|
260
|
-
|
|
264
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
261
265
|
requestType: "json",
|
|
262
266
|
body: request,
|
|
263
267
|
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,
|
|
@@ -316,7 +320,7 @@ class EntitiesClient {
|
|
|
316
320
|
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/entities/${core.url.encodePathParam(entityId)}`),
|
|
317
321
|
method: "GET",
|
|
318
322
|
headers: _headers,
|
|
319
|
-
|
|
323
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
320
324
|
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,
|
|
321
325
|
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,
|
|
322
326
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -371,7 +375,7 @@ class EntitiesClient {
|
|
|
371
375
|
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/entities/${core.url.encodePathParam(entityId)}`),
|
|
372
376
|
method: "DELETE",
|
|
373
377
|
headers: _headers,
|
|
374
|
-
|
|
378
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
375
379
|
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
380
|
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
381
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -433,7 +437,7 @@ class EntitiesClient {
|
|
|
433
437
|
method: "PATCH",
|
|
434
438
|
headers: _headers,
|
|
435
439
|
contentType: "application/json",
|
|
436
|
-
|
|
440
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
437
441
|
requestType: "json",
|
|
438
442
|
body: _body,
|
|
439
443
|
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,
|
|
@@ -115,4 +115,26 @@ export declare class JobsClient {
|
|
|
115
115
|
*/
|
|
116
116
|
continueJob(request: CatchAllApi.ContinueRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ContinueResponseDto>;
|
|
117
117
|
private __continueJob;
|
|
118
|
+
/**
|
|
119
|
+
* Soft-deletes a job. The job is flagged as deleted and no longer
|
|
120
|
+
* appears in list results. The underlying data is retained.
|
|
121
|
+
*
|
|
122
|
+
* Only the job owner can delete a job. Returns `404` if the job is not
|
|
123
|
+
* found or does not belong to the authenticated user.
|
|
124
|
+
*
|
|
125
|
+
* Deleting an already-deleted job returns `200`.
|
|
126
|
+
*
|
|
127
|
+
* @param {CatchAllApi.DeleteJobRequest} request
|
|
128
|
+
* @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link CatchAllApi.UnauthorizedError}
|
|
131
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* await client.jobs.deleteJob({
|
|
135
|
+
* job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
|
|
136
|
+
* })
|
|
137
|
+
*/
|
|
138
|
+
deleteJob(request: CatchAllApi.DeleteJobRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DeleteJobResponseDto>;
|
|
139
|
+
private __deleteJob;
|
|
118
140
|
}
|
|
@@ -75,10 +75,12 @@ class JobsClient {
|
|
|
75
75
|
__getUserJobs() {
|
|
76
76
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
77
77
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
78
|
-
const { page, page_size: pageSize } = request;
|
|
78
|
+
const { page, page_size: pageSize, search, ownership } = request;
|
|
79
79
|
const _queryParams = {
|
|
80
80
|
page,
|
|
81
81
|
page_size: pageSize,
|
|
82
|
+
search,
|
|
83
|
+
ownership: ownership != null ? ownership : undefined,
|
|
82
84
|
};
|
|
83
85
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
84
86
|
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);
|
|
@@ -86,7 +88,11 @@ class JobsClient {
|
|
|
86
88
|
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/jobs/user"),
|
|
87
89
|
method: "GET",
|
|
88
90
|
headers: _headers,
|
|
89
|
-
|
|
91
|
+
queryString: core.url
|
|
92
|
+
.queryBuilder()
|
|
93
|
+
.addMany(_queryParams)
|
|
94
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
95
|
+
.build(),
|
|
90
96
|
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,
|
|
91
97
|
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,
|
|
92
98
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -139,7 +145,7 @@ class JobsClient {
|
|
|
139
145
|
method: "POST",
|
|
140
146
|
headers: _headers,
|
|
141
147
|
contentType: "application/json",
|
|
142
|
-
|
|
148
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
143
149
|
requestType: "json",
|
|
144
150
|
body: request,
|
|
145
151
|
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,
|
|
@@ -201,7 +207,7 @@ class JobsClient {
|
|
|
201
207
|
method: "POST",
|
|
202
208
|
headers: _headers,
|
|
203
209
|
contentType: "application/json",
|
|
204
|
-
|
|
210
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
205
211
|
requestType: "json",
|
|
206
212
|
body: request,
|
|
207
213
|
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,
|
|
@@ -259,7 +265,7 @@ class JobsClient {
|
|
|
259
265
|
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/status/${core.url.encodePathParam(jobId)}`),
|
|
260
266
|
method: "GET",
|
|
261
267
|
headers: _headers,
|
|
262
|
-
|
|
268
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
263
269
|
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,
|
|
264
270
|
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,
|
|
265
271
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -317,7 +323,11 @@ class JobsClient {
|
|
|
317
323
|
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/pull/${core.url.encodePathParam(jobId)}`),
|
|
318
324
|
method: "GET",
|
|
319
325
|
headers: _headers,
|
|
320
|
-
|
|
326
|
+
queryString: core.url
|
|
327
|
+
.queryBuilder()
|
|
328
|
+
.addMany(_queryParams)
|
|
329
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
330
|
+
.build(),
|
|
321
331
|
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,
|
|
322
332
|
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,
|
|
323
333
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -373,7 +383,7 @@ class JobsClient {
|
|
|
373
383
|
method: "POST",
|
|
374
384
|
headers: _headers,
|
|
375
385
|
contentType: "application/json",
|
|
376
|
-
|
|
386
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
377
387
|
requestType: "json",
|
|
378
388
|
body: request,
|
|
379
389
|
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,
|
|
@@ -404,5 +414,65 @@ class JobsClient {
|
|
|
404
414
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/catchAll/continue");
|
|
405
415
|
});
|
|
406
416
|
}
|
|
417
|
+
/**
|
|
418
|
+
* Soft-deletes a job. The job is flagged as deleted and no longer
|
|
419
|
+
* appears in list results. The underlying data is retained.
|
|
420
|
+
*
|
|
421
|
+
* Only the job owner can delete a job. Returns `404` if the job is not
|
|
422
|
+
* found or does not belong to the authenticated user.
|
|
423
|
+
*
|
|
424
|
+
* Deleting an already-deleted job returns `200`.
|
|
425
|
+
*
|
|
426
|
+
* @param {CatchAllApi.DeleteJobRequest} request
|
|
427
|
+
* @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
428
|
+
*
|
|
429
|
+
* @throws {@link CatchAllApi.UnauthorizedError}
|
|
430
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
431
|
+
*
|
|
432
|
+
* @example
|
|
433
|
+
* await client.jobs.deleteJob({
|
|
434
|
+
* job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
|
|
435
|
+
* })
|
|
436
|
+
*/
|
|
437
|
+
deleteJob(request, requestOptions) {
|
|
438
|
+
return core.HttpResponsePromise.fromPromise(this.__deleteJob(request, requestOptions));
|
|
439
|
+
}
|
|
440
|
+
__deleteJob(request, requestOptions) {
|
|
441
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
442
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
443
|
+
const { job_id: jobId } = request;
|
|
444
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
445
|
+
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);
|
|
446
|
+
const _response = yield core.fetcher({
|
|
447
|
+
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/jobs/${core.url.encodePathParam(jobId)}`),
|
|
448
|
+
method: "DELETE",
|
|
449
|
+
headers: _headers,
|
|
450
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
451
|
+
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,
|
|
452
|
+
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,
|
|
453
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
454
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
455
|
+
logging: this._options.logging,
|
|
456
|
+
});
|
|
457
|
+
if (_response.ok) {
|
|
458
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
459
|
+
}
|
|
460
|
+
if (_response.error.reason === "status-code") {
|
|
461
|
+
switch (_response.error.statusCode) {
|
|
462
|
+
case 401:
|
|
463
|
+
throw new CatchAllApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
464
|
+
case 404:
|
|
465
|
+
throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
466
|
+
default:
|
|
467
|
+
throw new errors.CatchAllApiError({
|
|
468
|
+
statusCode: _response.error.statusCode,
|
|
469
|
+
body: _response.error.body,
|
|
470
|
+
rawResponse: _response.rawResponse,
|
|
471
|
+
});
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/catchAll/jobs/{job_id}");
|
|
475
|
+
});
|
|
476
|
+
}
|
|
407
477
|
}
|
|
408
478
|
exports.JobsClient = JobsClient;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface DeleteJobRequest {
|
|
8
|
+
/** Unique job identifier returned from [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/create-job). */
|
|
9
|
+
job_id: string;
|
|
10
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.js";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {}
|
|
@@ -7,4 +8,8 @@ export interface GetUserJobsRequest {
|
|
|
7
8
|
page?: number;
|
|
8
9
|
/** Number of records per page. */
|
|
9
10
|
page_size?: number;
|
|
11
|
+
/** Filter results by text (case-insensitive substring match). */
|
|
12
|
+
search?: string;
|
|
13
|
+
/** Filter results by ownership. Defaults to `all`. */
|
|
14
|
+
ownership?: CatchAllApi.OwnershipFilter;
|
|
10
15
|
}
|
|
@@ -36,7 +36,7 @@ export interface SubmitRequestDto {
|
|
|
36
36
|
*/
|
|
37
37
|
mode?: SubmitRequestDto.Mode;
|
|
38
38
|
/**
|
|
39
|
-
* Dataset IDs to connect to this job. When provided, activates Company
|
|
39
|
+
* Dataset IDs to connect to this job. When provided, activates Company Watchlist mode — the job returns only events relevant to companies in the connected datasets with each record including a `connected_entities` array scored per company.
|
|
40
40
|
*
|
|
41
41
|
* The dataset must have `latest_status: ready` before the job is submitted. Submitting with a non-existent or inaccessible dataset ID returns `400`.
|
|
42
42
|
*/
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { ContinueRequestDto } from "./ContinueRequestDto.js";
|
|
2
|
+
export type { DeleteJobRequest } from "./DeleteJobRequest.js";
|
|
2
3
|
export type { GetJobResultsRequest } from "./GetJobResultsRequest.js";
|
|
3
4
|
export type { GetJobStatusRequest } from "./GetJobStatusRequest.js";
|
|
4
5
|
export type { GetUserJobsRequest } from "./GetUserJobsRequest.js";
|
|
@@ -77,7 +77,7 @@ class MetaClient {
|
|
|
77
77
|
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, "health"),
|
|
78
78
|
method: "GET",
|
|
79
79
|
headers: _headers,
|
|
80
|
-
|
|
80
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
81
81
|
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,
|
|
82
82
|
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,
|
|
83
83
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -116,7 +116,7 @@ class MetaClient {
|
|
|
116
116
|
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, "version"),
|
|
117
117
|
method: "GET",
|
|
118
118
|
headers: _headers,
|
|
119
|
-
|
|
119
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
120
120
|
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,
|
|
121
121
|
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,
|
|
122
122
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -158,7 +158,7 @@ class MetaClient {
|
|
|
158
158
|
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/user/limits"),
|
|
159
159
|
method: "POST",
|
|
160
160
|
headers: _headers,
|
|
161
|
-
|
|
161
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
162
162
|
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,
|
|
163
163
|
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,
|
|
164
164
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|