Class IntegrationClient

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

Index

Methods

delete deleteMany discoverDataConnectionSchema discoverGraphQLConnectionSchema discoverOpenApiSchema discoverOpenApiSchemaFromFile generateAiDescriptionsForAssociations generateAiDescriptionsForDataSchema generateAiDescriptionsForEndpoints generateAiDescriptionsForStoredProcedures get getIntegrationSchema list setIntegrationSchema upsertIntegration

Methods

delete

delete(integrationId: string): Promise<void>
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.

deleteMany

deleteMany(integrationIds: string[]): Promise<void>
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.

discoverDataConnectionSchema

discoverDataConnectionSchema<SchemaType = Record<string, any>>(
integrationId: string,
): Promise<DiscoverDataConnectionSchemaResponse<SchemaType>>
Discovers the schema of a data connection (database). Connects to the database and introspects its structure including tables, columns, and relationships.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the database integration.
Returns Promise<DiscoverDataConnectionSchemaResponse<SchemaType>>
A promise that resolves with the discovered schema and collection readiness information.

discoverGraphQLConnectionSchema

discoverGraphQLConnectionSchema<SchemaType = Record<string, any>>(
integrationId: string,
request: DiscoverGraphQLConnectionSchemaRequest,
): Promise<DiscoverGraphQLConnectionSchemaResponse<SchemaType>>
Discovers the schema of a GraphQL connection. Performs introspection on the GraphQL endpoint to discover types and operations.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the GraphQL integration.
- request: DiscoverGraphQLConnectionSchemaRequest
  The request containing GraphQL connection options.
Returns Promise<DiscoverGraphQLConnectionSchemaResponse<SchemaType>>
A promise that resolves with the discovered GraphQL schema.

discoverOpenApiSchema

discoverOpenApiSchema<SchemaType = Record<string, any>>(
integrationId: string,
request: DiscoverOpenApiSchemaRequest,
): Promise<DiscoverOpenApiSchemaResponse<SchemaType>>
Discovers the schema from an OpenAPI specification URL. Fetches and parses the OpenAPI spec to discover endpoints and their schemas.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the API integration.
- request: DiscoverOpenApiSchemaRequest
  The request containing OpenAPI discovery options.
Returns Promise<DiscoverOpenApiSchemaResponse<SchemaType>>
A promise that resolves with the discovered API schema.

discoverOpenApiSchemaFromFile

discoverOpenApiSchemaFromFile<SchemaType = Record<string, any>>(
integrationId: string,
): Promise<DiscoverOpenApiSchemaResponse<SchemaType>>
Discovers the schema from an uploaded OpenAPI specification file. Parses the OpenAPI spec file that was previously uploaded to the integration.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the API integration with the uploaded spec file.
Returns Promise<DiscoverOpenApiSchemaResponse<SchemaType>>
A promise that resolves with the discovered API schema.

generateAiDescriptionsForAssociations

generateAiDescriptionsForAssociations<SchemaType = Record<string, any>>(
integrationId: string,
request: GenerateAiDescriptionsForAssociationsRequest<SchemaType>,
): Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>
Generates AI descriptions for associations (relationships) in a data schema. Uses AI to analyze entity relationships and generate meaningful descriptions.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the integration.
- request: GenerateAiDescriptionsForAssociationsRequest<SchemaType>
  The request containing schema with associations and optional parameters.
Returns Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>
A promise that resolves with the schema containing AI-generated association descriptions.

generateAiDescriptionsForDataSchema

generateAiDescriptionsForDataSchema<SchemaType = Record<string, any>>(
integrationId: string,
request: GenerateAiDescriptionsForDataSchemaRequest<SchemaType>,
): Promise<GenerateAiDescriptionsForDataSchemaResponse<SchemaType>>
Generates AI descriptions for the data schema of an integration. Uses AI to analyze the schema structure and generate meaningful descriptions for collections and their fields.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the integration.
- request: GenerateAiDescriptionsForDataSchemaRequest<SchemaType>
  The request containing schema and optional parameters.
Returns Promise<GenerateAiDescriptionsForDataSchemaResponse<SchemaType>>
A promise that resolves with the schema containing AI-generated descriptions.

generateAiDescriptionsForEndpoints

generateAiDescriptionsForEndpoints<SchemaType = Record<string, any>>(
integrationId: string,
request: GenerateAiDescriptionsForEndpointsRequest<SchemaType>,
): Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>
Generates AI descriptions for API endpoints in an API schema. Uses AI to analyze endpoints and generate meaningful descriptions.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the integration.
- request: GenerateAiDescriptionsForEndpointsRequest<SchemaType>
  The request containing API schema with endpoints and optional parameters.
Returns Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>
A promise that resolves with the schema containing AI-generated endpoint descriptions.

generateAiDescriptionsForStoredProcedures

generateAiDescriptionsForStoredProcedures<SchemaType = Record<string, any>>(
integrationId: string,
request: GenerateAiDescriptionsForStoredProceduresRequest<SchemaType>,
): Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>
Generates AI descriptions for stored procedures in a data schema. Uses AI to analyze stored procedures and generate meaningful descriptions.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the integration.
- request: GenerateAiDescriptionsForStoredProceduresRequest<SchemaType>
  The request containing schema with stored procedures and optional parameters.
Returns Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>
A promise that resolves with the schema containing AI-generated stored procedure descriptions.

get

get<ConfigurationType = Record<string, any>>(
integrationId: string,
): Promise<IntegrationInfo<ConfigurationType> | undefined>
Retrieves the integration by its ID.
Type Parameters
- ConfigurationType = Record<string, any>
Parameters
- integrationId: string
  The ID of the integration to retrieve.
Returns Promise<IntegrationInfo<ConfigurationType> | undefined>
A promise that resolves with the integration info, or undefined if not found.

getIntegrationSchema

getIntegrationSchema<SchemaType = Record<string, any>>(
integrationId: string,
): Promise<SchemaType | undefined>
Retrieves the integration's schema by its ID.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the integration to retrieve.
Returns Promise<SchemaType | undefined>
A promise that resolves with the integration schema, or undefined if not found.

list

list<ConfigurationType = Record<string, any>>(
    type?:
        | "api"
        | "ai_agents"
        | "active_directory"
        | "ai_chatbot"
        | "algolia"
        | "alloydb"
        | "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"
        | "connected_knowledgebases"
        | "confluence"
        | "confluent"
        | "datadog"
        | "db2"
        | "descope"
        | "documentdb"
        | "dynamodb"
        | "elasticsearch"
        | "firebase_auth"
        | "firestore"
        | "gcs"
        | "github"
        | "google_calendar"
        | "google_docs"
        | "google_drive"
        | "graphql"
        | "hubspot"
        | "jira"
        | "jwt_hmac"
        | "jwt_rsa"
        | "kafka"
        | "keycloak"
        | "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"
        | "mcp"
        | "a2a"
        | "legend"
        | "teams"
        | "openai_compatible",
): Promise<IntegrationInfo<ConfigurationType>[]>
Lists all integrations for the current application.
Type Parameters
- ConfigurationType = Record<string, any>
Parameters
- Optionaltype:
      | "api"
      | "ai_agents"
      | "active_directory"
      | "ai_chatbot"
      | "algolia"
      | "alloydb"
      | "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"
      | "connected_knowledgebases"
      | "confluence"
      | "confluent"
      | "datadog"
      | "db2"
      | "descope"
      | "documentdb"
      | "dynamodb"
      | "elasticsearch"
      | "firebase_auth"
      | "firestore"
      | "gcs"
      | "github"
      | "google_calendar"
      | "google_docs"
      | "google_drive"
      | "graphql"
      | "hubspot"
      | "jira"
      | "jwt_hmac"
      | "jwt_rsa"
      | "kafka"
      | "keycloak"
      | "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"
      | "mcp"
      | "a2a"
      | "legend"
      | "teams"
      | "openai_compatible"
  (Optional) Filter by integration type.
Returns Promise<IntegrationInfo<ConfigurationType>[]>
A promise that resolves with a list of integrations.

setIntegrationSchema

setIntegrationSchema<SchemaType = Record<string, any>>(
integrationId: string,
schema: SchemaType,
): Promise<void>
Sets the integration's schema by its ID.
Type Parameters
- SchemaType = Record<string, any>
Parameters
- integrationId: string
  The ID of the integration to update.
- schema: SchemaType
  The schema to set for the integration.
Returns Promise<void>
A promise that resolves when the schema has been updated.

upsertIntegration

upsertIntegration<ConfigurationType = Record<string, any>>(
integration: IntegrationInfo<ConfigurationType>,
): Promise<void>
Creates or updates an integration.
Type Parameters
- ConfigurationType = Record<string, any>
Parameters
- integration: IntegrationInfo<ConfigurationType>
  The integration information to upsert.
Returns Promise<void>
A promise that resolves when the operation is complete.

Class IntegrationClient

Index

Methods

Methods

delete

Parameters

Returns Promise<void>

deleteMany

Parameters

Returns Promise<void>

discoverDataConnectionSchema

Type Parameters

Parameters

Returns Promise<DiscoverDataConnectionSchemaResponse<SchemaType>>

discoverGraphQLConnectionSchema

Type Parameters

Parameters

Returns Promise<DiscoverGraphQLConnectionSchemaResponse<SchemaType>>

discoverOpenApiSchema

Type Parameters

Parameters

Returns Promise<DiscoverOpenApiSchemaResponse<SchemaType>>

discoverOpenApiSchemaFromFile

Type Parameters

Parameters

Returns Promise<DiscoverOpenApiSchemaResponse<SchemaType>>

generateAiDescriptionsForAssociations

Type Parameters

Parameters

Returns Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>

generateAiDescriptionsForDataSchema

Type Parameters

Parameters

Returns Promise<GenerateAiDescriptionsForDataSchemaResponse<SchemaType>>

generateAiDescriptionsForEndpoints

Type Parameters

Parameters

Returns Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>

generateAiDescriptionsForStoredProcedures

Type Parameters

Parameters

Returns Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>

get

Type Parameters

Parameters

Returns Promise<IntegrationInfo<ConfigurationType> | undefined>

getIntegrationSchema

Type Parameters

Parameters

Returns Promise<SchemaType | undefined>

list

Type Parameters

Parameters

Returns Promise<IntegrationInfo<ConfigurationType>[]>

setIntegrationSchema

Type Parameters

Parameters

Returns Promise<void>

upsertIntegration

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page