@squidcloud/client 1.0.431 → 1.0.433

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -254,6 +254,16 @@ export interface AiConnectedIntegrationMetadata<AiConnectedIntegrationOptionsTyp
254
254
  description?: string;
255
255
  /** Optional instructions for the connected integration agent, overriding the default if provided. */
256
256
  instructions?: string;
257
+ /**
258
+ * A list of AI function IDs that the AI agent can use from this integration.
259
+ *
260
+ * - When `undefined` (not provided), the AI agent has access to all AI functions for this integration type.
261
+ * - When an empty array `[]`, the AI agent has access to no AI functions.
262
+ * - When an array with function IDs, the AI agent only has access to those specific functions.
263
+ *
264
+ * Example function IDs: 'jiraService__searchJiraIssues', 'confluenceService__searchInConfluence'
265
+ */
266
+ functionsToUse?: AiFunctionId[];
257
267
  /**
258
268
  * Additional options for the connected integration.
259
269
  * Squid Core or AI functions in connector packages may use these options to adjust behavior of the integration agent.
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * The extraction method to use for processing documents.
3
3
  */
4
- export type DocumentExtractionMethod = 'mistral_ocr' | 'legacy';
4
+ export type DocumentExtractionMethod = 'mistral_ocr' | 'legacy' | 'amazon_textract';
5
5
  /**
6
6
  * Options for customizing how data is extracted from a document.
7
7
  */
@@ -1,6 +1,6 @@
1
1
  import { IntegrationId } from './communication.public-types';
2
2
  /** List of all integration types supported by Squid. */
3
- 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", "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", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
3
+ 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", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "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", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
4
4
  /**
5
5
  * @category Database
6
6
  */
@@ -102,6 +102,15 @@ export declare class IntegrationClient {
102
102
  * @returns A promise that resolves with the discovered schema and collection readiness information.
103
103
  */
104
104
  discoverDataConnectionSchema<SchemaType = Record<string, any>>(integrationId: IntegrationId): Promise<DiscoverDataConnectionSchemaResponse<SchemaType>>;
105
+ /**
106
+ * Tests a data connection (database) to verify it is working.
107
+ * Attempts to connect to the database and perform a basic operation to validate connectivity.
108
+ * This can be used to test connection settings before saving the integration.
109
+ *
110
+ * @param config - The integration configuration to test.
111
+ * @returns A promise that resolves with the test result indicating success or failure with an optional error message.
112
+ */
113
+ testDataConnection<ConfigurationType = Record<string, any>>(config: IntegrationInfo<ConfigurationType>): Promise<TestDataConnectionResponse>;
105
114
  /**
106
115
  * Discovers the schema of a GraphQL connection.
107
116
  * Performs introspection on the GraphQL endpoint to discover types and operations.
@@ -240,6 +249,20 @@ export interface DiscoverDataConnectionSchemaResponse<SchemaType = Record<string
240
249
  */
241
250
  collectionReadiness: Record<string, CollectionReadiness>;
242
251
  }
252
+ /**
253
+ * Response from testing a data connection.
254
+ * @category Platform
255
+ */
256
+ export interface TestDataConnectionResponse {
257
+ /**
258
+ * Whether the connection test was successful.
259
+ */
260
+ success: boolean;
261
+ /**
262
+ * Error message if the connection test failed.
263
+ */
264
+ errorMessage?: string;
265
+ }
243
266
  /**
244
267
  * Information about a collection's readiness for operations.
245
268
  * @category Platform
@@ -251,6 +251,11 @@ export declare class Squid {
251
251
  * @typeParam T - The expected type of the result returned by the webhook.
252
252
  */
253
253
  executeWebhook<T = any>(webhookId: string, options?: ExecuteWebhookOptions): Promise<T>;
254
+ /**
255
+ * Returns the URL for the webhook with the given ID. If no ID is provided, returns the base URL for webhooks.
256
+ * @param webhookId - The ID of the webhook (optional).
257
+ */
258
+ getWebhookUrl(webhookId?: string): string;
254
259
  /**
255
260
  * Executes a native relational query with the given parameters and returns a promise with the result.
256
261
  * See https://docs.getsquid.ai/docs/sdk/client-sdk/database/native-queries.
@@ -2,4 +2,4 @@
2
2
  * The current version of the SquidCloud client package.
3
3
  * @category Platform
4
4
  */
5
- export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.431";
5
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.433";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.431",
3
+ "version": "1.0.433",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",