@airweave/sdk 0.2.52 → 0.3.41

package/dist/cjs/api/resources/whiteLabels/client/requests/WhiteLabelCreate.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         name: "Customer Portal Slack Integration",
+ *         source_short_name: "slack",
+ *         redirect_url: "https://yourapp.com/auth/slack/callback",
+ *         client_id: "1234567890.1234567890123",
+ *         client_secret: "abcdefghijklmnopqrstuvwxyz123456",
+ *         allowed_origins: "https://yourapp.com,https://app.yourapp.com"
+ *     }
+ */
+export interface WhiteLabelCreate {
+    /** Human-readable name for the white label integration. This helps you identify the integration in the UI and should clearly describe its purpose (e.g., 'Customer Portal Slack Integration', 'Enterprise Google Drive Access'). */
+    name: string;
+    /** Technical identifier of the source type that this integration supports (e.g., 'slack', 'google_drive', 'github'). This determines which service provider the OAuth integration connects to. */
+    source_short_name: string;
+    /** OAuth2 callback URL where users are redirected after completing authentication. This must be a valid HTTPS URL that your application can handle to receive the authorization code. */
+    redirect_url: string;
+    /** OAuth2 client identifier provided by the service provider. This identifies your application during the OAuth consent flow and must match the client ID configured in the service provider's developer console. */
+    client_id: string;
+    /** OAuth2 client secret from your registered application. This is used to securely authenticate your application when exchanging authorization codes for access tokens. Keep this value secure and never expose it in client-side code. */
+    client_secret: string;
+    /** Comma-separated list of allowed domains for OAuth flows and CORS. This prevents unauthorized websites from using your OAuth credentials and should include all domains where your application is hosted. */
+    allowed_origins: string;
+}

package/dist/cjs/api/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         name: "Updated Customer Portal Integration",
+ *         redirect_url: "https://v2.yourapp.com/auth/slack/callback",
+ *         allowed_origins: "https://v2.yourapp.com,https://api.yourapp.com"
+ *     }
+ */
+export interface WhiteLabelUpdate {
+    /** Updated name for the white label integration. */
+    name?: string;
+    /** Updated OAuth callback URL. Must be a valid HTTPS URL that matches your OAuth application configuration. */
+    redirect_url?: string;
+    /** Updated OAuth2 client ID. Must match the client ID in your service provider's developer console. */
+    client_id?: string;
+    /** Updated OAuth2 client secret. This will replace the existing secret and affect all future OAuth flows. */
+    client_secret?: string;
+    /** Updated comma-separated list of allowed domains for OAuth flows. */
+    allowed_origins?: string;
+}

package/dist/cjs/api/resources/whiteLabels/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export { type WhiteLabelCreate } from "./WhiteLabelCreate.js";
+export { type WhiteLabelUpdate } from "./WhiteLabelUpdate.js";
+export { type BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions } from "./BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.js";

package/dist/cjs/api/resources/whiteLabels/index.d.ts

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

package/dist/cjs/api/resources/whiteLabels/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/types/ApiKey.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for API keys returned to clients - includes decrypted key.
+ */
+export interface ApiKey {
+    id: string;
+    organization: string;
+    created_at: string;
+    modified_at: string;
+    last_used_date?: string;
+    expiration_date: string;
+    created_by_email?: string;
+    modified_by_email?: string;
+    decrypted_key: string;
+}

package/dist/cjs/api/types/ApiKeyCreate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for creating an APIKey object.
+ */
+export interface ApiKeyCreate {
+    /** Expiration date for the API key, defaults to 180 days from now */
+    expiration_date?: string;
+}

package/dist/cjs/api/types/BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost {
+    /** Custom name for the stored credential */
+    credential_name?: string;
+    /** Description to help identify this credential */
+    credential_description?: string;
+    /** OAuth client ID (required for bring-your-own-credentials) */
+    client_id?: string;
+    /** OAuth client secret (required for bring-your-own-credentials) */
+    client_secret?: string;
+}

package/dist/cjs/api/types/Collection.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Complete collection representation returned by the API.
+ *
+ * This schema includes all collection metadata plus computed status information
+ * based on the health and state of associated source connections.
+ */
+export interface Collection {
+    /** Human-readable display name for the collection. */
+    name: string;
+    /** URL-safe unique identifier used in API endpoints. This becomes non-optional once the collection is created. */
+    readable_id: string;
+    /** Unique system identifier for the collection. This UUID is generated automatically and used for internal references. */
+    id: string;
+    /** Timestamp when the collection was created (ISO 8601 format). */
+    created_at: string;
+    /** Timestamp when the collection was last modified (ISO 8601 format). */
+    modified_at: string;
+    /** Identifier of the organization that owns this collection. Collections are isolated per organization. */
+    organization_id: string;
+    /** Email address of the user who created this collection. */
+    created_by_email?: string;
+    /** Email address of the user who last modified this collection. */
+    modified_by_email?: string;
+    /** Current operational status of the collection:<br/>• **NEEDS_SOURCE**: Collection exists but has no source connections configured yet<br/>• **ACTIVE**: All source connections are healthy and data is being synced successfully<br/>• **PARTIAL_ERROR**: Some source connections are failing but others are working<br/>• **ERROR**: All source connections are failing or in error state */
+    status?: AirweaveSDK.CollectionStatus;
+}

package/dist/cjs/api/types/Connection.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for connection with config fields.
+ */
+export interface Connection {
+    name: string;
+    integration_type: AirweaveSDK.IntegrationType;
+    integration_credential_id?: string;
+    status: AirweaveSDK.ConnectionStatus;
+    short_name: string;
+    id: string;
+    organization_id?: string;
+    created_by_email?: string;
+    modified_by_email?: string;
+}

package/dist/cjs/api/types/DagEdge.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for a DAG edge.
+ */
+export interface DagEdge {
+    from_node_id: string;
+    to_node_id: string;
+    id: string;
+    dag_id: string;
+    organization_id: string;
+    created_by_email?: string;
+    modified_by_email?: string;
+}

package/dist/cjs/api/types/DagEdgeCreate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for creating a DAG edge.
+ */
+export interface DagEdgeCreate {
+    from_node_id: string;
+    to_node_id: string;
+}

package/dist/cjs/api/types/DagNode.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for a DAG node.
+ */
+export interface DagNode {
+    type: AirweaveSDK.NodeType;
+    name: string;
+    config?: Record<string, unknown>;
+    connection_id?: string;
+    entity_definition_id?: string;
+    transformer_id?: string;
+    id: string;
+    dag_id: string;
+    organization_id: string;
+    created_by_email?: string;
+    modified_by_email?: string;
+}

package/dist/cjs/api/types/DagNodeCreate.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for creating a DAG node.
+ */
+export interface DagNodeCreate {
+    type: AirweaveSDK.NodeType;
+    name: string;
+    config?: Record<string, unknown>;
+    connection_id?: string;
+    entity_definition_id?: string;
+    transformer_id?: string;
+    /** Optional pre-set ID for the node */
+    id?: string;
+}

package/dist/cjs/api/types/Destination.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for Destination.
+ */
+export interface Destination {
+    name: string;
+    description?: string;
+    short_name: string;
+    class_name: string;
+    auth_type?: AirweaveSDK.AuthType;
+    auth_config_class?: string;
+    input_entity_definition_ids?: string[];
+    organization_id?: string;
+    config_schema?: Record<string, unknown>;
+    labels?: string[];
+    id: string;
+    created_at: string;
+    modified_at: string;
+}

package/dist/cjs/api/types/DestinationWithAuthenticationFields.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for Destination with auth config.
+ */
+export interface DestinationWithAuthenticationFields {
+    name: string;
+    description?: string;
+    short_name: string;
+    class_name: string;
+    auth_type?: AirweaveSDK.AuthType;
+    auth_config_class?: string;
+    input_entity_definition_ids?: string[];
+    organization_id?: string;
+    config_schema?: Record<string, unknown>;
+    labels?: string[];
+    id: string;
+    created_at: string;
+    modified_at: string;
+    auth_fields?: AirweaveSDK.Fields;
+}

package/dist/cjs/api/types/EmbeddingModel.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for EmbeddingModel.
+ */
+export interface EmbeddingModel {
+    name: string;
+    short_name: string;
+    description?: string;
+    provider: string;
+    model_name?: string;
+    model_version?: string;
+    auth_type?: AirweaveSDK.AuthType;
+    auth_config_class?: string;
+    id: string;
+    created_at: string;
+    modified_at: string;
+}

package/dist/cjs/api/types/EmbeddingModelWithAuthenticationFields.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for EmbeddingModel with auth config.
+ */
+export interface EmbeddingModelWithAuthenticationFields {
+    name: string;
+    short_name: string;
+    description?: string;
+    provider: string;
+    model_name?: string;
+    model_version?: string;
+    auth_type?: AirweaveSDK.AuthType;
+    auth_config_class?: string;
+    id: string;
+    created_at: string;
+    modified_at: string;
+    auth_fields?: AirweaveSDK.Fields;
+}

package/dist/cjs/api/types/EntityDefinition.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for an entity definition.
+ */
+export interface EntityDefinition {
+    name: string;
+    description?: string;
+    type: AirweaveSDK.EntityType;
+    entity_schema: EntityDefinition.EntitySchema;
+    parent_id?: string;
+    module_name: string;
+    class_name: string;
+    id: string;
+    organization_id?: string;
+}
+export declare namespace EntityDefinition {
+    type EntitySchema = string[] | Record<string, unknown>;
+}

package/dist/cjs/api/types/EntityDefinitionCreate.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for creating an entity definition.
+ */
+export interface EntityDefinitionCreate {
+    name: string;
+    description?: string;
+    type: AirweaveSDK.EntityType;
+    entity_schema: EntityDefinitionCreate.EntitySchema;
+    parent_id?: string;
+    module_name: string;
+    class_name: string;
+}
+export declare namespace EntityDefinitionCreate {
+    type EntitySchema = string[] | Record<string, unknown>;
+}

package/dist/cjs/api/types/EntityDefinitionUpdate.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for updating an entity.
+ */
+export interface EntityDefinitionUpdate {
+    name: string;
+    description?: string;
+    type: AirweaveSDK.EntityType;
+    entity_schema: EntityDefinitionUpdate.EntitySchema;
+    parent_id?: string;
+    module_name: string;
+    class_name: string;
+}
+export declare namespace EntityDefinitionUpdate {
+    type EntitySchema = string[] | Record<string, unknown>;
+}

package/dist/cjs/api/types/Fields.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Fields model.
+ */
+export interface Fields {
+    fields: AirweaveSDK.ConfigField[];
+}

package/dist/cjs/api/types/HttpValidationError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+export interface HttpValidationError {
+    detail?: AirweaveSDK.ValidationError[];
+}

package/dist/cjs/api/types/IntegrationCredentialInDb.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Integration credential in DB without decrypted data.
+ */
+export interface IntegrationCredentialInDb {
+    name: string;
+    integration_short_name: string;
+    description?: string;
+    integration_type: AirweaveSDK.IntegrationType;
+    auth_type: AirweaveSDK.AuthType;
+    auth_config_class?: string;
+    id: string;
+    organization_id: string;
+    encrypted_credentials: string;
+}

package/dist/cjs/api/types/IntegrationCredentialRawCreate.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Create class for integration credentials with raw auth fields.
+ *
+ * This schema is used when auth fields need to be validated and encrypted
+ * before creating the credential.
+ */
+export interface IntegrationCredentialRawCreate {
+    name: string;
+    integration_short_name: string;
+    description?: string;
+    integration_type: AirweaveSDK.IntegrationType;
+    auth_type: AirweaveSDK.AuthType;
+    auth_config_class?: string;
+    auth_fields: Record<string, unknown>;
+}

package/dist/cjs/api/types/InvitationCreate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for creating an invitation.
+ */
+export interface InvitationCreate {
+    email: string;
+    role?: string;
+}

package/dist/cjs/api/types/InvitationResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for invitation responses.
+ */
+export interface InvitationResponse {
+    id: string;
+    email: string;
+    role: string;
+    status: string;
+    invited_at?: string;
+}

package/dist/cjs/api/types/MemberResponse.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for organization member responses.
+ */
+export interface MemberResponse {
+    id: string;
+    email: string;
+    name: string;
+    role: string;
+    status?: string;
+    is_primary?: boolean;
+    auth0_id?: string;
+}

package/dist/cjs/api/types/Organization.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Organization schema.
+ */
+export interface Organization {
+    name: string;
+    description?: string;
+    auth0_org_id?: string;
+    id: string;
+    created_at: string;
+    modified_at: string;
+}

package/dist/cjs/api/types/OrganizationCreate.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Organization creation schema.
+ */
+export interface OrganizationCreate {
+    /** Organization name */
+    name: string;
+    /** Organization description */
+    description?: string;
+    /** Auth0 organization ID */
+    auth0_org_id?: string;
+}

package/dist/cjs/api/types/OrganizationWithRole.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Organization schema with user's role information.
+ */
+export interface OrganizationWithRole {
+    id: string;
+    name: string;
+    description?: string;
+    created_at: string;
+    modified_at: string;
+    role: string;
+    is_primary: boolean;
+    auth0_org_id?: string;
+}

package/dist/cjs/api/types/ResponseType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response format options for search results.
+ */
+export type ResponseType = "raw" | "completion";
+export declare const ResponseType: {
+    readonly Raw: "raw";
+    readonly Completion: "completion";
+};

package/dist/cjs/api/types/SearchResponse.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Comprehensive search response containing results and metadata.
+ */
+export interface SearchResponse {
+    /** Array of search result objects containing the found documents, records, or data entities. */
+    results: Record<string, unknown>[];
+    /** Indicates whether results are raw search matches or AI-generated completions based on the found content. */
+    response_type: AirweaveSDK.ResponseType;
+    /** AI-generated natural language answer when response_type is 'completion'. This provides natural language answers to your query based on the content found across your connected data sources. */
+    completion?: string;
+    /** Status of the search operation indicating the quality and availability of results:<br/>• **success**: Search found relevant results matching your query<br/>• **no_relevant_results**: Search completed but found no sufficiently relevant matches<br/>• **no_results**: Search found no results at all, possibly indicating empty collections or very specific queries */
+    status: AirweaveSDK.SearchStatus;
+}

package/dist/cjs/api/types/SearchStatus.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Status indicators for search operation outcomes.
+ */
+export type SearchStatus = "success" | "no_relevant_results" | "no_results";
+export declare const SearchStatus: {
+    readonly Success: "success";
+    readonly NoRelevantResults: "no_relevant_results";
+    readonly NoResults: "no_results";
+};

package/dist/cjs/api/types/Source.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Complete source representation with authentication and configuration schemas.
+ */
+export interface Source {
+    /** Human-readable name of the data source connector (e.g., 'GitHub', 'Stripe', 'PostgreSQL'). */
+    name: string;
+    /** Detailed description explaining what data this source can extract and its typical use cases. */
+    description?: string;
+    /** Type of authentication mechanism required by this source (e.g., 'oauth2'). */
+    auth_type?: AirweaveSDK.AuthType;
+    /** Python class name that defines the authentication configuration fields required for this source. */
+    auth_config_class: string;
+    /** Python class name that defines the source-specific configuration options and parameters. */
+    config_class: string;
+    /** Technical identifier used internally to reference this source type. Must be unique across all sources. */
+    short_name: string;
+    /** Python class name of the source implementation that handles data extraction logic. */
+    class_name: string;
+    /** List of entity definition IDs that this source can produce. Defines the data schema and structure that this connector outputs. */
+    output_entity_definition_ids?: string[];
+    /** Organization identifier for custom source connectors. System sources have this set to null. */
+    organization_id?: string;
+    /** Categorization tags to help users discover and filter sources by domain or use case. */
+    labels?: string[];
+    /** Unique system identifier for this source type. Generated automatically when the source is registered. */
+    id: string;
+    /** Timestamp when this source type was registered in the system (ISO 8601 format). */
+    created_at: string;
+    /** Timestamp when this source type was last updated (ISO 8601 format). */
+    modified_at: string;
+    /** Schema definition for authentication fields required to connect to this source. Describes field types, validation rules, and user interface hints. */
+    auth_fields: AirweaveSDK.Fields;
+    /** Schema definition for configuration fields required to customize this source. Describes field types, validation rules, and user interface hints. */
+    config_fields: AirweaveSDK.Fields;
+}