newscatcher-catchall-sdk 1.1.2 → 1.4.0

package/dist/esm/api/resources/entities/client/Client.mjs

@@ -0,0 +1,431 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as CatchAllApi from "../../../index.mjs";
+/**
+ * Operations to create, update, and delete company entities.
+ *
+ * Entities are the building blocks of Company Search. Each entity represents
+ * a company (or person) you want to track. Add identifying information such as
+ * domain, alternative names, and key persons to improve matching quality.
+ */
+export class EntitiesClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * 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.
+     *
+     * @param {CatchAllApi.ListEntitiesRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.entities.listEntities({
+     *         search: "NewsCatcher"
+     *     })
+     */
+    listEntities(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listEntities(request, requestOptions));
+    }
+    __listEntities() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { page, page_size: pageSize, search, status, entity_type: entityType, sort_by: sortBy, sort_order: sortOrder, } = request;
+            const _queryParams = {
+                page,
+                page_size: pageSize,
+                search,
+                status: status != null ? status : undefined,
+                entity_type: entityType != null ? entityType : undefined,
+                sort_by: sortBy != null ? sortBy : undefined,
+                sort_order: sortOrder != null ? sortOrder : undefined,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/entities");
+        });
+    }
+    /**
+     * Creates a new company entity and begins background enrichment.
+     *
+     * The entity status starts as `pending` and transitions to `ready` once
+     * enrichment completes. Provide as much identifying information as
+     * possible — `domain` is the highest-signal field because it is
+     * unambiguous.
+     *
+     * @param {CatchAllApi.CreateEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.entities.createEntity({
+     *         name: "NewsCatcher",
+     *         entity_type: "company",
+     *         description: "AI-powered news data provider",
+     *         additional_attributes: {
+     *             company_attributes: {
+     *                 domain: "newscatcherapi.com",
+     *                 key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
+     *                 alternative_names: ["NC", "NewsCatcher API"]
+     *             }
+     *         }
+     *     })
+     */
+    createEntity(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createEntity(request, requestOptions));
+    }
+    __createEntity(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new CatchAllApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/entities");
+        });
+    }
+    /**
+     * Creates multiple entities in a single request. Each entity is
+     * processed independently — a failure in one does not affect others.
+     *
+     * Returns an array of `{id, status}` objects in the same order as
+     * the input array.
+     *
+     * @param {CatchAllApi.CreateEntitiesBatchRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.entities.createEntitiesBatch({
+     *         entities: [{
+     *                 name: "OpenAI",
+     *                 entity_type: "company",
+     *                 description: "Artificial intelligence research company",
+     *                 additional_attributes: {
+     *                     company_attributes: {
+     *                         domain: "openai.com",
+     *                         key_persons: ["Sam Altman"],
+     *                         alternative_names: ["Open AI"]
+     *                     }
+     *                 }
+     *             }, {
+     *                 name: "Stripe",
+     *                 entity_type: "company",
+     *                 description: "Online payment processing platform",
+     *                 additional_attributes: {
+     *                     company_attributes: {
+     *                         domain: "stripe.com",
+     *                         key_persons: ["Patrick Collison", "John Collison"]
+     *                     }
+     *                 }
+     *             }]
+     *     })
+     */
+    createEntitiesBatch(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createEntitiesBatch(request, requestOptions));
+    }
+    __createEntitiesBatch(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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/batch"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new CatchAllApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/entities/batch");
+        });
+    }
+    /**
+     * Returns a single entity by ID with all attributes and current status.
+     *
+     * @param {CatchAllApi.GetEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.entities.getEntity({
+     *         entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+     *     })
+     */
+    getEntity(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getEntity(request, requestOptions));
+    }
+    __getEntity(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { entity_id: entityId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/entities/{entity_id}");
+        });
+    }
+    /**
+     * Permanently deletes an entity. The entity is removed from all
+     * datasets and the search index. This operation cannot be undone.
+     *
+     * @param {CatchAllApi.DeleteEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.entities.deleteEntity({
+     *         entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+     *     })
+     */
+    deleteEntity(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteEntity(request, requestOptions));
+    }
+    __deleteEntity(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { entity_id: entityId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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)}`),
+                method: "DELETE",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/catchAll/entities/{entity_id}");
+        });
+    }
+    /**
+     * Updates one or more fields of an existing entity.
+     *
+     * @param {CatchAllApi.UpdateEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.entities.updateEntity({
+     *         entity_id: "854198fa-f702-49db-a381-0427fa87f173",
+     *         description: "Updated description",
+     *         additional_attributes: {
+     *             company_attributes: {
+     *                 alternative_names: ["NC", "NewsCatcher API", "NCA"]
+     *             }
+     *         }
+     *     })
+     */
+    updateEntity(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateEntity(request, requestOptions));
+    }
+    __updateEntity(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { entity_id: entityId } = request, _body = __rest(request, ["entity_id"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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)}`),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: _body,
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new CatchAllApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/catchAll/entities/{entity_id}");
+        });
+    }
+}

package/dist/esm/api/resources/entities/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/entities/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/entities/client/requests/CreateEntitiesBatchRequest.d.mts

@@ -0,0 +1,35 @@
+import type * as CatchAllApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         entities: [{
+ *                 name: "OpenAI",
+ *                 entity_type: "company",
+ *                 description: "Artificial intelligence research company",
+ *                 additional_attributes: {
+ *                     company_attributes: {
+ *                         domain: "openai.com",
+ *                         key_persons: ["Sam Altman"],
+ *                         alternative_names: ["Open AI"]
+ *                     }
+ *                 }
+ *             }, {
+ *                 name: "Stripe",
+ *                 entity_type: "company",
+ *                 description: "Online payment processing platform",
+ *                 additional_attributes: {
+ *                     company_attributes: {
+ *                         domain: "stripe.com",
+ *                         key_persons: ["Patrick Collison", "John Collison"]
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
+export interface CreateEntitiesBatchRequest {
+    /**
+     * Array of entities to create. Each item follows the same schema
+     * as single entity creation.
+     */
+    entities: CatchAllApi.CreateEntityRequest[];
+}

package/dist/esm/api/resources/entities/client/requests/CreateEntitiesBatchRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/entities/client/requests/DeleteEntityRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+ *     }
+ */
+export interface DeleteEntityRequest {
+    /** Unique entity identifier. */
+    entity_id: string;
+}

package/dist/esm/api/resources/entities/client/requests/DeleteEntityRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/entities/client/requests/GetEntityRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+ *     }
+ */
+export interface GetEntityRequest {
+    /** Unique entity identifier. */
+    entity_id: string;
+}

package/dist/esm/api/resources/entities/client/requests/GetEntityRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/entities/client/requests/ListEntitiesRequest.d.mts

@@ -0,0 +1,19 @@
+import type * as CatchAllApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         search: "NewsCatcher"
+ *     }
+ */
+export interface ListEntitiesRequest {
+    /** Page number to retrieve. */
+    page?: number;
+    /** Number of entities per page. */
+    page_size?: number;
+    /** Filter entities by name (case-insensitive substring match). */
+    search?: string;
+    status?: CatchAllApi.EntityStatus;
+    entity_type?: CatchAllApi.EntityType;
+    sort_by?: CatchAllApi.EntitySortBy;
+    sort_order?: CatchAllApi.SortOrder;
+}

package/dist/esm/api/resources/entities/client/requests/ListEntitiesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/entities/client/requests/UpdateEntityRequest.d.mts

@@ -0,0 +1,22 @@
+import type * as CatchAllApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         entity_id: "854198fa-f702-49db-a381-0427fa87f173",
+ *         description: "Updated description",
+ *         additional_attributes: {
+ *             company_attributes: {
+ *                 alternative_names: ["NC", "NewsCatcher API", "NCA"]
+ *             }
+ *         }
+ *     }
+ */
+export interface UpdateEntityRequest {
+    /** Unique entity identifier. */
+    entity_id: string;
+    /** Updated entity name. */
+    name?: string;
+    /** Updated description. */
+    description?: string;
+    additional_attributes?: CatchAllApi.AdditionalAttributes;
+}

package/dist/esm/api/resources/entities/client/requests/UpdateEntityRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/entities/client/requests/index.d.mts

@@ -0,0 +1,5 @@
+export type { CreateEntitiesBatchRequest } from "./CreateEntitiesBatchRequest.mjs";
+export type { DeleteEntityRequest } from "./DeleteEntityRequest.mjs";
+export type { GetEntityRequest } from "./GetEntityRequest.mjs";
+export type { ListEntitiesRequest } from "./ListEntitiesRequest.mjs";
+export type { UpdateEntityRequest } from "./UpdateEntityRequest.mjs";

package/dist/esm/api/resources/entities/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/entities/exports.d.mts

@@ -0,0 +1,2 @@
+export { EntitiesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/entities/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { EntitiesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/entities/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/entities/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/index.d.mts

@@ -1,3 +1,7 @@
+export * from "./datasets/client/requests/index.mjs";
+export * as datasets from "./datasets/index.mjs";
+export * from "./entities/client/requests/index.mjs";
+export * as entities from "./entities/index.mjs";
 export * from "./jobs/client/requests/index.mjs";
 export * as jobs from "./jobs/index.mjs";
 export * as meta from "./meta/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -1,3 +1,7 @@
+export * from "./datasets/client/requests/index.mjs";
+export * as datasets from "./datasets/index.mjs";
+export * from "./entities/client/requests/index.mjs";
+export * as entities from "./entities/index.mjs";
 export * from "./jobs/client/requests/index.mjs";
 export * as jobs from "./jobs/index.mjs";
 export * as meta from "./meta/index.mjs";