@squidcloud/client/dist/internal-common/src/public-types/integration.public-types.d.ts

A typescript implementation of the Squid client

import { IntegrationId } from './communication.public-types';
/** List of all integration types supported by Squid. */
export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack"];
/**
 * @category Database
 */
export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "sap_hana", "snowflake", "elasticsearch"];
/**
 * @category Auth
 */
export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "descope", "firebase_auth"];
/** Supported integration types for GraphQL-based services. */
export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];
/** Supported integration types for HTTP-based services. */
export declare const HTTP_INTEGRATION_TYPES: readonly ["api", "confluence"];
/** Represents a supported integration type identifier, such as 'postgres', 'auth0', or 's3'. */
export type IntegrationType = (typeof INTEGRATION_TYPES)[number];
/** Supported schema types for integrations */
export declare const INTEGRATION_SCHEMA_TYPES: readonly ["data", "api", "graphql"];
/** Describes the type of schema the integration provides, such as data, API, or GraphQL schema. */
export type IntegrationSchemaType = (typeof INTEGRATION_SCHEMA_TYPES)[number];
/**
 * @category Database
 */
export declare const BUILT_IN_DB_INTEGRATION_ID: IntegrationId;
/**
 * @category Queue
 */
export declare const BUILT_IN_QUEUE_INTEGRATION_ID: IntegrationId;
/**
 * ID for the cloud specific storage integration: s3 (built_in_s3) or gcs (built_in_gcs).
 * @category
 */
export declare const BUILT_IN_STORAGE_INTEGRATION_ID: IntegrationId;
/** Metadata describing a configured integration, including its ID, type, timestamps, and optional configuration object. */
export interface IntegrationInfo<ConfigurationType = Record<string, any> | undefined> {
    /** The unique identifier of the integration instance. */
    id: IntegrationId;
    /** The type of the integration (e.g., postgres, auth0, s3). */
    type: IntegrationType;
    /** The date when the integration was created. */
    creationDate?: Date;
    /** The date when the integration was last updated. */
    updateDate?: Date;
    /** The configuration object for the integration, if any. */
    configuration: ConfigurationType;
}