@airweave/sdk 0.1.24 → 0.1.25

package/dist/api/resources/entities/client/Client.d.ts

@@ -0,0 +1,141 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as AirweaveSDK from "../../../index";
+export declare namespace Entities {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        /** Override the x-api-key header */
+        apiKey?: core.Supplier<string | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the x-api-key header */
+        apiKey?: string | undefined;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Entities {
+    protected readonly _options: Entities.Options;
+    constructor(_options?: Entities.Options);
+    /**
+     * List all entity definitions for the current user's organization.
+     *
+     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.entities.listEntityDefinitions()
+     */
+    listEntityDefinitions(requestOptions?: Entities.RequestOptions): Promise<AirweaveSDK.EntityDefinition[]>;
+    /**
+     * Create a new entity definition.
+     *
+     * @param {AirweaveSDK.EntityDefinitionCreate} request
+     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.entities.createEntityDefinition({
+     *         name: "name",
+     *         type: "file",
+     *         entitySchema: ["entity_schema"],
+     *         moduleName: "module_name",
+     *         className: "class_name"
+     *     })
+     */
+    createEntityDefinition(request: AirweaveSDK.EntityDefinitionCreate, requestOptions?: Entities.RequestOptions): Promise<AirweaveSDK.EntityDefinition>;
+    /**
+     * Update an entity definition.
+     *
+     * @param {string} definitionId
+     * @param {AirweaveSDK.EntityDefinitionUpdate} request
+     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.entities.updateEntityDefinition("definition_id", {
+     *         name: "name",
+     *         type: "file",
+     *         entitySchema: ["entity_schema"],
+     *         moduleName: "module_name",
+     *         className: "class_name"
+     *     })
+     */
+    updateEntityDefinition(definitionId: string, request: AirweaveSDK.EntityDefinitionUpdate, requestOptions?: Entities.RequestOptions): Promise<AirweaveSDK.EntityDefinition>;
+    /**
+     * List all entity relations for the current user's organization.
+     *
+     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.entities.listEntityRelations()
+     */
+    listEntityRelations(requestOptions?: Entities.RequestOptions): Promise<AirweaveSDK.EntityRelation[]>;
+    /**
+     * Create a new entity relation.
+     *
+     * @param {AirweaveSDK.EntityRelationCreate} request
+     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.entities.createEntityRelation({
+     *         name: "name",
+     *         fromEntityId: "from_entity_id",
+     *         toEntityId: "to_entity_id"
+     *     })
+     */
+    createEntityRelation(request: AirweaveSDK.EntityRelationCreate, requestOptions?: Entities.RequestOptions): Promise<AirweaveSDK.EntityRelation>;
+    /**
+     * Update an entity relation.
+     *
+     * @param {string} relationId
+     * @param {AirweaveSDK.EntityRelationUpdate} request
+     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.entities.updateEntityRelation("relation_id", {
+     *         name: "name",
+     *         fromEntityId: "from_entity_id",
+     *         toEntityId: "to_entity_id"
+     *     })
+     */
+    updateEntityRelation(relationId: string, request: AirweaveSDK.EntityRelationUpdate, requestOptions?: Entities.RequestOptions): Promise<AirweaveSDK.EntityRelation>;
+    /**
+     * Get multiple entity definitions by their IDs.
+     *
+     * Args:
+     *     ids: List of entity definition IDs to fetch
+     *     db: Database session
+     *     current_user: Current authenticated user
+     *
+     * Returns:
+     *     List of entity definitions matching the provided IDs
+     *
+     * @param {string[]} request
+     * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.entities.getEntityDefinitionsByIds(["string"])
+     */
+    getEntityDefinitionsByIds(request: string[], requestOptions?: Entities.RequestOptions): Promise<AirweaveSDK.EntityDefinition[]>;
+}