@squidcloud/client
    Preparing search index...

    Class IntegrationClient

    IntegrationClient manages integrations within an application, providing methods for listing, retrieving, updating, and deleting integrations.

    Index

    Methods

    • Deletes the integration with the given ID.

      Parameters

      • integrationId: string

        The ID of the integration to delete.

      Returns Promise<void>

      A promise that resolves when the integration has been deleted.

    • Deletes multiple integrations by their IDs.

      Parameters

      • integrationIds: string[]

        An array of integration IDs to delete.

      Returns Promise<void>

      A promise that resolves when all deletions are complete.

    • Retrieves the integration by its ID.

      Type Parameters

      • ConfigurationType = Record<string, any>

      Parameters

      • integrationId: string

        The ID of the integration to retrieve.

      Returns Promise<undefined | IntegrationInfo<ConfigurationType>>

      A promise that resolves with the integration info, or undefined if not found.

    • Lists all integrations for the current application.

      Type Parameters

      • ConfigurationType = Record<string, any>

      Parameters

      • Optionaltype:
            | "ai_agents"
            | "active_directory"
            | "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"
            | "elastic_enterprise_search"
            | "elastic_observability"
            | "elastic_search"
            | "firebase_auth"
            | "firestore"
            | "gcs"
            | "google_docs"
            | "google_drive"
            | "graphql"
            | "hubspot"
            | "jira"
            | "jwt_hmac"
            | "jwt_rsa"
            | "kafka"
            | "linear"
            | "mariadb"
            | "monday"
            | "mongo"
            | "mssql"
            | "mysql"
            | "newrelic"
            | "okta"
            | "onedrive"
            | "oracledb"
            | "pinecone"
            | "postgres"
            | "redis"
            | "s3"
            | "salesforce_crm"
            | "sap_hana"
            | "sentry"
            | "servicenow"
            | "snowflake"
            | "spanner"
            | "xata"
            | "zendesk"
            | "mail"
            | "slack"

        (Optional) Filter by integration type.

      Returns Promise<IntegrationInfo<ConfigurationType>[]>

      A promise that resolves with a list of integrations.