newscatcher-catchall-sdk 1.5.0 → 2.0.0
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 +12 -2
- package/dist/cjs/BaseClient.d.ts +3 -0
- package/dist/cjs/BaseClient.js +17 -2
- package/dist/cjs/api/resources/datasets/client/Client.d.ts +30 -31
- package/dist/cjs/api/resources/datasets/client/Client.js +64 -75
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.ts +28 -0
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.d.ts +0 -1
- package/dist/cjs/api/resources/datasets/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/entities/client/Client.d.ts +3 -7
- package/dist/cjs/api/resources/entities/client/Client.js +8 -13
- package/dist/cjs/api/resources/jobs/client/Client.d.ts +2 -4
- package/dist/cjs/api/resources/jobs/client/Client.js +7 -11
- package/dist/cjs/api/resources/jobs/client/requests/GetUserJobsRequest.d.ts +0 -1
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +7 -1
- package/dist/cjs/api/resources/meta/client/Client.js +3 -3
- package/dist/cjs/api/resources/monitors/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/monitors/client/Client.js +16 -17
- package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +7 -4
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +0 -1
- package/dist/cjs/api/types/ConnectedEntity.d.ts +12 -9
- package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
- package/dist/cjs/core/auth/AuthProvider.js +7 -0
- package/dist/cjs/core/auth/index.d.ts +1 -1
- package/dist/cjs/core/auth/index.js +3 -1
- package/dist/cjs/core/fetcher/Fetcher.d.ts +5 -0
- package/dist/cjs/core/fetcher/Fetcher.js +2 -7
- package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +3 -0
- package/dist/esm/BaseClient.mjs +17 -2
- package/dist/esm/api/resources/datasets/client/Client.d.mts +30 -31
- package/dist/esm/api/resources/datasets/client/Client.mjs +64 -75
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.mts +28 -0
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.d.mts +0 -1
- package/dist/esm/api/resources/datasets/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/entities/client/Client.d.mts +3 -7
- package/dist/esm/api/resources/entities/client/Client.mjs +8 -13
- package/dist/esm/api/resources/jobs/client/Client.d.mts +2 -4
- package/dist/esm/api/resources/jobs/client/Client.mjs +7 -11
- package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts +0 -1
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +7 -1
- package/dist/esm/api/resources/meta/client/Client.mjs +3 -3
- package/dist/esm/api/resources/monitors/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/monitors/client/Client.mjs +16 -17
- package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +7 -4
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +0 -1
- package/dist/esm/api/types/ConnectedEntity.d.mts +12 -9
- package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
- package/dist/esm/core/auth/AuthProvider.mjs +6 -1
- package/dist/esm/core/auth/index.d.mts +1 -1
- package/dist/esm/core/auth/index.mjs +1 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +5 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +2 -7
- package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +2 -2
- package/reference.md +35 -42
- package/dist/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.ts +0 -21
- package/dist/esm/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.mts +0 -21
- /package/dist/cjs/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.js → ListDatasetEntitiesRequest.js} +0 -0
- /package/dist/esm/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.mjs → ListDatasetEntitiesRequest.mjs} +0 -0
|
@@ -18,9 +18,7 @@ export declare class DatasetsClient {
|
|
|
18
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<DatasetsClient.Options>;
|
|
19
19
|
constructor(options?: DatasetsClient.Options);
|
|
20
20
|
/**
|
|
21
|
-
* Returns a paginated list of datasets belonging to the authenticated
|
|
22
|
-
* organization. Supports filtering by status and sorting by name,
|
|
23
|
-
* status, or creation date.
|
|
21
|
+
* Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.
|
|
24
22
|
*
|
|
25
23
|
* @param {CatchAllApi.ListDatasetsRequest} request
|
|
26
24
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -61,9 +59,7 @@ export declare class DatasetsClient {
|
|
|
61
59
|
createDataset(request: CatchAllApi.CreateDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
|
|
62
60
|
private __createDataset;
|
|
63
61
|
/**
|
|
64
|
-
* Creates a new dataset by uploading a CSV file. Each row in the CSV
|
|
65
|
-
* becomes an entity. The `name` column is required; all other columns
|
|
66
|
-
* are optional.
|
|
62
|
+
* Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
|
|
67
63
|
*
|
|
68
64
|
* **CSV format:**
|
|
69
65
|
* ```csv
|
|
@@ -144,22 +140,6 @@ export declare class DatasetsClient {
|
|
|
144
140
|
*/
|
|
145
141
|
updateDataset(request: CatchAllApi.UpdateDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
|
|
146
142
|
private __updateDataset;
|
|
147
|
-
/**
|
|
148
|
-
* Returns a paginated list of entities in a dataset. Supports filtering by status and entity type.
|
|
149
|
-
*
|
|
150
|
-
* @param {CatchAllApi.ListEntitiesInDatasetRequest} request
|
|
151
|
-
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
152
|
-
*
|
|
153
|
-
* @throws {@link CatchAllApi.ForbiddenError}
|
|
154
|
-
* @throws {@link CatchAllApi.NotFoundError}
|
|
155
|
-
*
|
|
156
|
-
* @example
|
|
157
|
-
* await client.datasets.listEntitiesInDataset({
|
|
158
|
-
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
|
|
159
|
-
* })
|
|
160
|
-
*/
|
|
161
|
-
listEntitiesInDataset(request: CatchAllApi.ListEntitiesInDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetEntityListResponse>;
|
|
162
|
-
private __listEntitiesInDataset;
|
|
163
143
|
/**
|
|
164
144
|
* Adds one or more existing entities to a dataset. Returns the number of entities added.
|
|
165
145
|
*
|
|
@@ -181,9 +161,7 @@ export declare class DatasetsClient {
|
|
|
181
161
|
addEntitiesToDataset(request: CatchAllApi.AddEntitiesToDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ManageEntitiesResponse>;
|
|
182
162
|
private __addEntitiesToDataset;
|
|
183
163
|
/**
|
|
184
|
-
* Removes one or more entities from a dataset. The entities themselves
|
|
185
|
-
* are not deleted — they are only removed from this dataset. Returns
|
|
186
|
-
* the number of entities removed.
|
|
164
|
+
* Removes one or more entities from a dataset. The entities themselves are not deleted — they are only removed from this dataset. Returns the number of entities removed.
|
|
187
165
|
*
|
|
188
166
|
* @param {CatchAllApi.RemoveEntitiesFromDatasetRequest} request
|
|
189
167
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -203,8 +181,31 @@ export declare class DatasetsClient {
|
|
|
203
181
|
removeEntitiesFromDataset(request: CatchAllApi.RemoveEntitiesFromDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ManageEntitiesResponse>;
|
|
204
182
|
private __removeEntitiesFromDataset;
|
|
205
183
|
/**
|
|
206
|
-
* Returns
|
|
207
|
-
*
|
|
184
|
+
* Returns a paginated list of entities in a dataset. Supports filtering by status, entity type, and name search.
|
|
185
|
+
*
|
|
186
|
+
* @param {CatchAllApi.ListDatasetEntitiesRequest} request
|
|
187
|
+
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
190
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
191
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
192
|
+
*
|
|
193
|
+
* @example
|
|
194
|
+
* await client.datasets.listEntitiesInDataset({
|
|
195
|
+
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
196
|
+
* page: 1,
|
|
197
|
+
* page_size: 100,
|
|
198
|
+
* search: "OpenAI",
|
|
199
|
+
* status: "ready",
|
|
200
|
+
* entity_type: "company",
|
|
201
|
+
* sort_by: "created_at",
|
|
202
|
+
* sort_order: "desc"
|
|
203
|
+
* })
|
|
204
|
+
*/
|
|
205
|
+
listEntitiesInDataset(request: CatchAllApi.ListDatasetEntitiesRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetEntityListResponse>;
|
|
206
|
+
private __listEntitiesInDataset;
|
|
207
|
+
/**
|
|
208
|
+
* Returns the full status change history for a dataset, ordered chronologically from oldest to newest.
|
|
208
209
|
*
|
|
209
210
|
* @param {CatchAllApi.GetDatasetStatusHistoryRequest} request
|
|
210
211
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -220,11 +221,9 @@ export declare class DatasetsClient {
|
|
|
220
221
|
getDatasetStatusHistory(request: CatchAllApi.GetDatasetStatusHistoryRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetStatusHistoryResponse>;
|
|
221
222
|
private __getDatasetStatusHistory;
|
|
222
223
|
/**
|
|
223
|
-
* Appends new companies to an existing dataset by uploading a CSV file.
|
|
224
|
-
* Uses the same CSV format as the dataset creation endpoint.
|
|
224
|
+
* Appends new companies to an existing dataset by uploading a CSV file. Uses the same CSV format as the dataset creation endpoint.
|
|
225
225
|
*
|
|
226
|
-
* The response omits `dataset_name` compared to the create-from-CSV
|
|
227
|
-
* endpoint since the dataset already exists.
|
|
226
|
+
* The response omits `dataset_name` compared to the create-from-CSV endpoint since the dataset already exists.
|
|
228
227
|
*
|
|
229
228
|
* @param {CatchAllApi.UploadCsvToDatasetRequest} request
|
|
230
229
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -38,9 +38,7 @@ export class DatasetsClient {
|
|
|
38
38
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
39
39
|
}
|
|
40
40
|
/**
|
|
41
|
-
* Returns a paginated list of datasets belonging to the authenticated
|
|
42
|
-
* organization. Supports filtering by status and sorting by name,
|
|
43
|
-
* status, or creation date.
|
|
41
|
+
* Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.
|
|
44
42
|
*
|
|
45
43
|
* @param {CatchAllApi.ListDatasetsRequest} request
|
|
46
44
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -74,7 +72,6 @@ export class DatasetsClient {
|
|
|
74
72
|
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"),
|
|
75
73
|
method: "GET",
|
|
76
74
|
headers: _headers,
|
|
77
|
-
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
78
75
|
queryString: core.url
|
|
79
76
|
.queryBuilder()
|
|
80
77
|
.addMany(_queryParams)
|
|
@@ -141,7 +138,7 @@ export class DatasetsClient {
|
|
|
141
138
|
method: "POST",
|
|
142
139
|
headers: _headers,
|
|
143
140
|
contentType: "application/json",
|
|
144
|
-
|
|
141
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
145
142
|
requestType: "json",
|
|
146
143
|
body: request,
|
|
147
144
|
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,
|
|
@@ -173,9 +170,7 @@ export class DatasetsClient {
|
|
|
173
170
|
});
|
|
174
171
|
}
|
|
175
172
|
/**
|
|
176
|
-
* Creates a new dataset by uploading a CSV file. Each row in the CSV
|
|
177
|
-
* becomes an entity. The `name` column is required; all other columns
|
|
178
|
-
* are optional.
|
|
173
|
+
* Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
|
|
179
174
|
*
|
|
180
175
|
* **CSV format:**
|
|
181
176
|
* ```csv
|
|
@@ -220,7 +215,7 @@ export class DatasetsClient {
|
|
|
220
215
|
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"),
|
|
221
216
|
method: "POST",
|
|
222
217
|
headers: _headers,
|
|
223
|
-
|
|
218
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
224
219
|
requestType: "file",
|
|
225
220
|
duplex: _maybeEncodedRequest.duplex,
|
|
226
221
|
body: _maybeEncodedRequest.body,
|
|
@@ -277,7 +272,7 @@ export class DatasetsClient {
|
|
|
277
272
|
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)}`),
|
|
278
273
|
method: "GET",
|
|
279
274
|
headers: _headers,
|
|
280
|
-
|
|
275
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
281
276
|
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,
|
|
282
277
|
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,
|
|
283
278
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -333,7 +328,7 @@ export class DatasetsClient {
|
|
|
333
328
|
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)}`),
|
|
334
329
|
method: "DELETE",
|
|
335
330
|
headers: _headers,
|
|
336
|
-
|
|
331
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
337
332
|
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,
|
|
338
333
|
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,
|
|
339
334
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -391,7 +386,7 @@ export class DatasetsClient {
|
|
|
391
386
|
method: "PATCH",
|
|
392
387
|
headers: _headers,
|
|
393
388
|
contentType: "application/json",
|
|
394
|
-
|
|
389
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
395
390
|
requestType: "json",
|
|
396
391
|
body: _body,
|
|
397
392
|
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,
|
|
@@ -423,47 +418,40 @@ export class DatasetsClient {
|
|
|
423
418
|
});
|
|
424
419
|
}
|
|
425
420
|
/**
|
|
426
|
-
*
|
|
421
|
+
* Adds one or more existing entities to a dataset. Returns the number of entities added.
|
|
427
422
|
*
|
|
428
|
-
* @param {CatchAllApi.
|
|
423
|
+
* @param {CatchAllApi.AddEntitiesToDatasetRequest} request
|
|
429
424
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
430
425
|
*
|
|
431
426
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
432
427
|
* @throws {@link CatchAllApi.NotFoundError}
|
|
428
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
433
429
|
*
|
|
434
430
|
* @example
|
|
435
|
-
* await client.datasets.
|
|
436
|
-
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
|
|
431
|
+
* await client.datasets.addEntitiesToDataset({
|
|
432
|
+
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
433
|
+
* body: {
|
|
434
|
+
* entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
|
|
435
|
+
* }
|
|
437
436
|
* })
|
|
438
437
|
*/
|
|
439
|
-
|
|
440
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
438
|
+
addEntitiesToDataset(request, requestOptions) {
|
|
439
|
+
return core.HttpResponsePromise.fromPromise(this.__addEntitiesToDataset(request, requestOptions));
|
|
441
440
|
}
|
|
442
|
-
|
|
441
|
+
__addEntitiesToDataset(request, requestOptions) {
|
|
443
442
|
return __awaiter(this, void 0, void 0, function* () {
|
|
444
443
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
445
|
-
const { dataset_id: datasetId,
|
|
446
|
-
const _queryParams = {
|
|
447
|
-
page,
|
|
448
|
-
page_size: pageSize,
|
|
449
|
-
search,
|
|
450
|
-
status: status != null ? status : undefined,
|
|
451
|
-
entity_type: entityType != null ? entityType : undefined,
|
|
452
|
-
sort_by: sortBy != null ? sortBy : undefined,
|
|
453
|
-
sort_order: sortOrder != null ? sortOrder : undefined,
|
|
454
|
-
};
|
|
444
|
+
const { dataset_id: datasetId, body: _body } = request;
|
|
455
445
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
456
446
|
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);
|
|
457
447
|
const _response = yield core.fetcher({
|
|
458
448
|
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`),
|
|
459
|
-
method: "
|
|
449
|
+
method: "POST",
|
|
460
450
|
headers: _headers,
|
|
461
|
-
|
|
462
|
-
queryString: core.url
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
466
|
-
.build(),
|
|
451
|
+
contentType: "application/json",
|
|
452
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
453
|
+
requestType: "json",
|
|
454
|
+
body: _body,
|
|
467
455
|
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
456
|
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
457
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -471,10 +459,7 @@ export class DatasetsClient {
|
|
|
471
459
|
logging: this._options.logging,
|
|
472
460
|
});
|
|
473
461
|
if (_response.ok) {
|
|
474
|
-
return {
|
|
475
|
-
data: _response.body,
|
|
476
|
-
rawResponse: _response.rawResponse,
|
|
477
|
-
};
|
|
462
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
478
463
|
}
|
|
479
464
|
if (_response.error.reason === "status-code") {
|
|
480
465
|
switch (_response.error.statusCode) {
|
|
@@ -482,6 +467,8 @@ export class DatasetsClient {
|
|
|
482
467
|
throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
483
468
|
case 404:
|
|
484
469
|
throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
470
|
+
case 422:
|
|
471
|
+
throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
485
472
|
default:
|
|
486
473
|
throw new errors.CatchAllApiError({
|
|
487
474
|
statusCode: _response.error.statusCode,
|
|
@@ -490,13 +477,13 @@ export class DatasetsClient {
|
|
|
490
477
|
});
|
|
491
478
|
}
|
|
492
479
|
}
|
|
493
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
480
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/datasets/{dataset_id}/entities");
|
|
494
481
|
});
|
|
495
482
|
}
|
|
496
483
|
/**
|
|
497
|
-
*
|
|
484
|
+
* Removes one or more entities from a dataset. The entities themselves are not deleted — they are only removed from this dataset. Returns the number of entities removed.
|
|
498
485
|
*
|
|
499
|
-
* @param {CatchAllApi.
|
|
486
|
+
* @param {CatchAllApi.RemoveEntitiesFromDatasetRequest} request
|
|
500
487
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
501
488
|
*
|
|
502
489
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -504,17 +491,17 @@ export class DatasetsClient {
|
|
|
504
491
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
505
492
|
*
|
|
506
493
|
* @example
|
|
507
|
-
* await client.datasets.
|
|
494
|
+
* await client.datasets.removeEntitiesFromDataset({
|
|
508
495
|
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
509
496
|
* body: {
|
|
510
497
|
* entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
|
|
511
498
|
* }
|
|
512
499
|
* })
|
|
513
500
|
*/
|
|
514
|
-
|
|
515
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
501
|
+
removeEntitiesFromDataset(request, requestOptions) {
|
|
502
|
+
return core.HttpResponsePromise.fromPromise(this.__removeEntitiesFromDataset(request, requestOptions));
|
|
516
503
|
}
|
|
517
|
-
|
|
504
|
+
__removeEntitiesFromDataset(request, requestOptions) {
|
|
518
505
|
return __awaiter(this, void 0, void 0, function* () {
|
|
519
506
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
520
507
|
const { dataset_id: datasetId, body: _body } = request;
|
|
@@ -522,10 +509,10 @@ export class DatasetsClient {
|
|
|
522
509
|
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);
|
|
523
510
|
const _response = yield core.fetcher({
|
|
524
511
|
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`),
|
|
525
|
-
method: "
|
|
512
|
+
method: "DELETE",
|
|
526
513
|
headers: _headers,
|
|
527
514
|
contentType: "application/json",
|
|
528
|
-
|
|
515
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
529
516
|
requestType: "json",
|
|
530
517
|
body: _body,
|
|
531
518
|
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,
|
|
@@ -553,15 +540,13 @@ export class DatasetsClient {
|
|
|
553
540
|
});
|
|
554
541
|
}
|
|
555
542
|
}
|
|
556
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
543
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/catchAll/datasets/{dataset_id}/entities");
|
|
557
544
|
});
|
|
558
545
|
}
|
|
559
546
|
/**
|
|
560
|
-
*
|
|
561
|
-
* are not deleted — they are only removed from this dataset. Returns
|
|
562
|
-
* the number of entities removed.
|
|
547
|
+
* Returns a paginated list of entities in a dataset. Supports filtering by status, entity type, and name search.
|
|
563
548
|
*
|
|
564
|
-
* @param {CatchAllApi.
|
|
549
|
+
* @param {CatchAllApi.ListDatasetEntitiesRequest} request
|
|
565
550
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
566
551
|
*
|
|
567
552
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -569,28 +554,32 @@ export class DatasetsClient {
|
|
|
569
554
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
570
555
|
*
|
|
571
556
|
* @example
|
|
572
|
-
* await client.datasets.
|
|
557
|
+
* await client.datasets.listEntitiesInDataset({
|
|
573
558
|
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
574
|
-
*
|
|
575
|
-
*
|
|
576
|
-
*
|
|
559
|
+
* page: 1,
|
|
560
|
+
* page_size: 100,
|
|
561
|
+
* search: "OpenAI",
|
|
562
|
+
* status: "ready",
|
|
563
|
+
* entity_type: "company",
|
|
564
|
+
* sort_by: "created_at",
|
|
565
|
+
* sort_order: "desc"
|
|
577
566
|
* })
|
|
578
567
|
*/
|
|
579
|
-
|
|
580
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
568
|
+
listEntitiesInDataset(request, requestOptions) {
|
|
569
|
+
return core.HttpResponsePromise.fromPromise(this.__listEntitiesInDataset(request, requestOptions));
|
|
581
570
|
}
|
|
582
|
-
|
|
571
|
+
__listEntitiesInDataset(request, requestOptions) {
|
|
583
572
|
return __awaiter(this, void 0, void 0, function* () {
|
|
584
573
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
585
|
-
const { dataset_id: datasetId,
|
|
574
|
+
const { dataset_id: datasetId } = request, _body = __rest(request, ["dataset_id"]);
|
|
586
575
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
587
576
|
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);
|
|
588
577
|
const _response = yield core.fetcher({
|
|
589
|
-
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`),
|
|
590
|
-
method: "
|
|
578
|
+
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/list`),
|
|
579
|
+
method: "POST",
|
|
591
580
|
headers: _headers,
|
|
592
581
|
contentType: "application/json",
|
|
593
|
-
|
|
582
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
594
583
|
requestType: "json",
|
|
595
584
|
body: _body,
|
|
596
585
|
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,
|
|
@@ -600,7 +589,10 @@ export class DatasetsClient {
|
|
|
600
589
|
logging: this._options.logging,
|
|
601
590
|
});
|
|
602
591
|
if (_response.ok) {
|
|
603
|
-
return {
|
|
592
|
+
return {
|
|
593
|
+
data: _response.body,
|
|
594
|
+
rawResponse: _response.rawResponse,
|
|
595
|
+
};
|
|
604
596
|
}
|
|
605
597
|
if (_response.error.reason === "status-code") {
|
|
606
598
|
switch (_response.error.statusCode) {
|
|
@@ -618,12 +610,11 @@ export class DatasetsClient {
|
|
|
618
610
|
});
|
|
619
611
|
}
|
|
620
612
|
}
|
|
621
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
613
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/datasets/{dataset_id}/entities/list");
|
|
622
614
|
});
|
|
623
615
|
}
|
|
624
616
|
/**
|
|
625
|
-
* Returns the full status change history for a dataset, ordered
|
|
626
|
-
* chronologically from oldest to newest.
|
|
617
|
+
* Returns the full status change history for a dataset, ordered chronologically from oldest to newest.
|
|
627
618
|
*
|
|
628
619
|
* @param {CatchAllApi.GetDatasetStatusHistoryRequest} request
|
|
629
620
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -649,7 +640,7 @@ export class DatasetsClient {
|
|
|
649
640
|
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`),
|
|
650
641
|
method: "GET",
|
|
651
642
|
headers: _headers,
|
|
652
|
-
|
|
643
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
653
644
|
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,
|
|
654
645
|
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,
|
|
655
646
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -680,11 +671,9 @@ export class DatasetsClient {
|
|
|
680
671
|
});
|
|
681
672
|
}
|
|
682
673
|
/**
|
|
683
|
-
* Appends new companies to an existing dataset by uploading a CSV file.
|
|
684
|
-
* Uses the same CSV format as the dataset creation endpoint.
|
|
674
|
+
* Appends new companies to an existing dataset by uploading a CSV file. Uses the same CSV format as the dataset creation endpoint.
|
|
685
675
|
*
|
|
686
|
-
* The response omits `dataset_name` compared to the create-from-CSV
|
|
687
|
-
* endpoint since the dataset already exists.
|
|
676
|
+
* The response omits `dataset_name` compared to the create-from-CSV endpoint since the dataset already exists.
|
|
688
677
|
*
|
|
689
678
|
* @param {CatchAllApi.UploadCsvToDatasetRequest} request
|
|
690
679
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -715,7 +704,7 @@ export class DatasetsClient {
|
|
|
715
704
|
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`),
|
|
716
705
|
method: "POST",
|
|
717
706
|
headers: _headers,
|
|
718
|
-
|
|
707
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
719
708
|
requestType: "file",
|
|
720
709
|
duplex: _maybeEncodedRequest.duplex,
|
|
721
710
|
body: _maybeEncodedRequest.body,
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
6
|
+
* page: 1,
|
|
7
|
+
* page_size: 100,
|
|
8
|
+
* search: "OpenAI",
|
|
9
|
+
* status: "ready",
|
|
10
|
+
* entity_type: "company",
|
|
11
|
+
* sort_by: "created_at",
|
|
12
|
+
* sort_order: "desc"
|
|
13
|
+
* }
|
|
14
|
+
*/
|
|
15
|
+
export interface ListDatasetEntitiesRequest {
|
|
16
|
+
/** Unique dataset identifier. */
|
|
17
|
+
dataset_id: string;
|
|
18
|
+
/** The page number to retrieve. */
|
|
19
|
+
page?: number;
|
|
20
|
+
/** The number of entities per page. */
|
|
21
|
+
page_size?: number;
|
|
22
|
+
/** Filters entities by name using a case-insensitive substring match. */
|
|
23
|
+
search?: string;
|
|
24
|
+
status?: CatchAllApi.EntityStatus;
|
|
25
|
+
entity_type?: CatchAllApi.EntityType;
|
|
26
|
+
sort_by?: CatchAllApi.EntitySortBy;
|
|
27
|
+
sort_order?: CatchAllApi.SortOrder;
|
|
28
|
+
}
|
|
@@ -16,6 +16,5 @@ 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
19
|
ownership?: CatchAllApi.OwnershipFilter;
|
|
21
20
|
}
|
|
@@ -4,8 +4,8 @@ export type { CreateDatasetRequest } from "./CreateDatasetRequest.mjs";
|
|
|
4
4
|
export type { DeleteDatasetRequest } from "./DeleteDatasetRequest.mjs";
|
|
5
5
|
export type { GetDatasetRequest } from "./GetDatasetRequest.mjs";
|
|
6
6
|
export type { GetDatasetStatusHistoryRequest } from "./GetDatasetStatusHistoryRequest.mjs";
|
|
7
|
+
export type { ListDatasetEntitiesRequest } from "./ListDatasetEntitiesRequest.mjs";
|
|
7
8
|
export type { ListDatasetsRequest } from "./ListDatasetsRequest.mjs";
|
|
8
|
-
export type { ListEntitiesInDatasetRequest } from "./ListEntitiesInDatasetRequest.mjs";
|
|
9
9
|
export type { RemoveEntitiesFromDatasetRequest } from "./RemoveEntitiesFromDatasetRequest.mjs";
|
|
10
10
|
export type { UpdateDatasetRequest } from "./UpdateDatasetRequest.mjs";
|
|
11
11
|
export type { UploadCsvToDatasetRequest } from "./UploadCsvToDatasetRequest.mjs";
|
|
@@ -18,9 +18,7 @@ export declare class EntitiesClient {
|
|
|
18
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<EntitiesClient.Options>;
|
|
19
19
|
constructor(options?: EntitiesClient.Options);
|
|
20
20
|
/**
|
|
21
|
-
* Returns a paginated list of entities belonging to the authenticated
|
|
22
|
-
* organization. Supports filtering by status and entity type, and
|
|
23
|
-
* sorting by name, status, or creation date.
|
|
21
|
+
* Returns a paginated list of entities belonging to the authenticated organization. Supports filtering by status and entity type, and sorting by name, status, or creation date.
|
|
24
22
|
*
|
|
25
23
|
* @param {CatchAllApi.ListEntitiesRequest} request
|
|
26
24
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -65,11 +63,9 @@ export declare class EntitiesClient {
|
|
|
65
63
|
createEntity(request: CatchAllApi.CreateEntityRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateEntityResponse>;
|
|
66
64
|
private __createEntity;
|
|
67
65
|
/**
|
|
68
|
-
* Creates multiple entities in a single request. Each entity is
|
|
69
|
-
* processed independently — a failure in one does not affect others.
|
|
66
|
+
* Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
|
|
70
67
|
*
|
|
71
|
-
* Returns an array of `{id, status}` objects in the same order as
|
|
72
|
-
* the input array.
|
|
68
|
+
* Returns an array of `{id, status}` objects in the same order as the input array.
|
|
73
69
|
*
|
|
74
70
|
* @param {CatchAllApi.CreateEntitiesBatchRequest} request
|
|
75
71
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -38,9 +38,7 @@ export class EntitiesClient {
|
|
|
38
38
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
39
39
|
}
|
|
40
40
|
/**
|
|
41
|
-
* Returns a paginated list of entities belonging to the authenticated
|
|
42
|
-
* organization. Supports filtering by status and entity type, and
|
|
43
|
-
* sorting by name, status, or creation date.
|
|
41
|
+
* Returns a paginated list of entities belonging to the authenticated organization. Supports filtering by status and entity type, and sorting by name, status, or creation date.
|
|
44
42
|
*
|
|
45
43
|
* @param {CatchAllApi.ListEntitiesRequest} request
|
|
46
44
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -74,7 +72,6 @@ export class EntitiesClient {
|
|
|
74
72
|
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"),
|
|
75
73
|
method: "GET",
|
|
76
74
|
headers: _headers,
|
|
77
|
-
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
78
75
|
queryString: core.url
|
|
79
76
|
.queryBuilder()
|
|
80
77
|
.addMany(_queryParams)
|
|
@@ -145,7 +142,7 @@ export class EntitiesClient {
|
|
|
145
142
|
method: "POST",
|
|
146
143
|
headers: _headers,
|
|
147
144
|
contentType: "application/json",
|
|
148
|
-
|
|
145
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
149
146
|
requestType: "json",
|
|
150
147
|
body: request,
|
|
151
148
|
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,
|
|
@@ -175,11 +172,9 @@ export class EntitiesClient {
|
|
|
175
172
|
});
|
|
176
173
|
}
|
|
177
174
|
/**
|
|
178
|
-
* Creates multiple entities in a single request. Each entity is
|
|
179
|
-
* processed independently — a failure in one does not affect others.
|
|
175
|
+
* Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
|
|
180
176
|
*
|
|
181
|
-
* Returns an array of `{id, status}` objects in the same order as
|
|
182
|
-
* the input array.
|
|
177
|
+
* Returns an array of `{id, status}` objects in the same order as the input array.
|
|
183
178
|
*
|
|
184
179
|
* @param {CatchAllApi.CreateEntitiesBatchRequest} request
|
|
185
180
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -226,7 +221,7 @@ export class EntitiesClient {
|
|
|
226
221
|
method: "POST",
|
|
227
222
|
headers: _headers,
|
|
228
223
|
contentType: "application/json",
|
|
229
|
-
|
|
224
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
230
225
|
requestType: "json",
|
|
231
226
|
body: request,
|
|
232
227
|
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,
|
|
@@ -285,7 +280,7 @@ export class EntitiesClient {
|
|
|
285
280
|
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)}`),
|
|
286
281
|
method: "GET",
|
|
287
282
|
headers: _headers,
|
|
288
|
-
|
|
283
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
289
284
|
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,
|
|
290
285
|
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,
|
|
291
286
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -340,7 +335,7 @@ export class EntitiesClient {
|
|
|
340
335
|
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)}`),
|
|
341
336
|
method: "DELETE",
|
|
342
337
|
headers: _headers,
|
|
343
|
-
|
|
338
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
344
339
|
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,
|
|
345
340
|
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,
|
|
346
341
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -402,7 +397,7 @@ export class EntitiesClient {
|
|
|
402
397
|
method: "PATCH",
|
|
403
398
|
headers: _headers,
|
|
404
399
|
contentType: "application/json",
|
|
405
|
-
|
|
400
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
406
401
|
requestType: "json",
|
|
407
402
|
body: _body,
|
|
408
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,
|
|
@@ -116,11 +116,9 @@ export declare class JobsClient {
|
|
|
116
116
|
continueJob(request: CatchAllApi.ContinueRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ContinueResponseDto>;
|
|
117
117
|
private __continueJob;
|
|
118
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.
|
|
119
|
+
* Soft-deletes a job. The job is flagged as deleted and no longer appears in list results. The underlying data is retained.
|
|
121
120
|
*
|
|
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.
|
|
121
|
+
* Only the job owner can delete a job. Returns `404` if the job is not found or does not belong to the authenticated user.
|
|
124
122
|
*
|
|
125
123
|
* Deleting an already-deleted job returns `200`.
|
|
126
124
|
*
|