@squidcloud/freshdesk-client 1.0.510 → 1.0.512

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.
@@ -1,5 +1,6 @@
1
1
  import { AiAgentMemoryOptions, AiChatOptions, AiFileUrl, AiSessionContext } from './ai-agent.public-types';
2
2
  import { AiChatModelName } from './ai-common.public-types';
3
+ import { AiOntologyId } from './ai-ontology.public-types';
3
4
  import { ApiOptions } from './api-client.public-types';
4
5
  import { AiAgentId, IntegrationId } from './communication.public-types';
5
6
  import { JobId } from './job.public-types';
@@ -25,6 +26,12 @@ export interface AiQueryOptions {
25
26
  instructions?: string;
26
27
  /** Whether to enable raw results output. */
27
28
  enableRawResults?: boolean;
29
+ /**
30
+ * Replaces the relationships the query sees in this database with the accepted ones of this ontology, when the
31
+ * ontology attaches the database. Honored for any caller the query's security rules allow, since it only reshapes
32
+ * the joins of this one database. An agent's database tool uses the agent's own `ontologyId` in place of this value.
33
+ */
34
+ ontologyId?: AiOntologyId;
28
35
  /**
29
36
  * When the results are too large to analyze in the answer, skips the analysis and returns the raw results as
30
37
  * files instead, for a caller that processes them itself (e.g. an agent with `executePythonCode`). Default: false.
@@ -4,7 +4,7 @@
4
4
  * 'CONNECTOR_PACKAGES_TO_EXCLUDE_FROM_AUTO_SYNC' in ConnectorsService (console-backend).
5
5
  * @category Platform
6
6
  */
7
- export declare const CONNECTOR_IDS: readonly ["bitbucket", "cockroach", "confluence", "connect_companion", "cotomi", "databricks_genie", "elevenlabs", "openai_voice", "essentials", "freshdesk", "generic_site_ingester", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "outlook", "postgres", "salesforce", "servicenow_csm", "slack", "snowflake", "teams", "ticketmind_companion", "twilio", "zendesk"];
7
+ export declare const CONNECTOR_IDS: readonly ["azure_ai_search", "bigquery", "bitbucket", "cockroach", "confluence", "connect_companion", "cotomi", "databricks", "databricks_genie", "dynamodb", "elasticsearch", "elevenlabs", "openai_voice", "essentials", "freshdesk", "generic_site_ingester", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "legend", "linear", "mail", "mssql", "mysql", "onedrive", "oracledb", "outlook", "postgres", "salesforce", "salesforce_db", "servicenow_csm", "slack", "snowflake", "teams", "ticketmind_companion", "twilio", "zendesk"];
8
8
  /**
9
9
  * Unique connector package name.
10
10
  * @category Platform
@@ -10,6 +10,10 @@ export interface TriggerEvent<T = unknown> {
10
10
  type: string;
11
11
  /** Arbitrary, JSON-serializable event payload. */
12
12
  payload: T;
13
+ /** The integration the event came from. Agent automations bound to integrations match on it. */
14
+ integrationId?: string;
15
+ /** The prompt an agent automation listening to the event runs its agent with, in place of its default one. */
16
+ prompt?: string;
13
17
  }
14
18
  /** Request body for the `events/emit` core endpoint that publishes a `TriggerEvent`. */
15
19
  export interface EmitEventRequest<T = unknown> {
@@ -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", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "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", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "databricks_genie", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "salesforce_db", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "twilio", "elevenlabs", "openai_voice", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "bedrock_embedding", "sharepoint", "vertex"];
3
+ export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "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", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "databricks_genie", "azure_ai_search", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "salesforce_db", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "twilio", "elevenlabs", "openai_voice", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "bedrock_embedding", "sharepoint", "vertex"];
4
4
  /**
5
5
  * @category Database
6
6
  */
@@ -122,7 +122,7 @@ export interface Query<Doc extends DocumentData = any> {
122
122
  sortOrder: Array<FieldSort<Doc>>;
123
123
  /** The maximum number of records to return. */
124
124
  limit: number;
125
- /** Optional configuration to limit results by specific fields with custom sorting. */
125
+ /** Optional per-group limit; see `limitBy()` on the query builder for the integrations that support it. */
126
126
  limitBy?: LimitBy<Doc>;
127
127
  /** Optional list of fields to return. If null/undefined, all fields are returned. If empty array, only metadata/IDs are returned. */
128
128
  projectFields?: Array<FieldName<Doc>>;
@@ -1,8 +1,11 @@
1
1
  import { HttpStatusCode } from '../public-types/http-status.public-types';
2
2
  import { JobId } from '../public-types/job.public-types';
3
3
  import { ConnectorId } from './connector.types';
4
- /** A role a worker plays apart from running the application's code. */
5
- export type WorkerRole = 'database';
4
+ /**
5
+ * A role a worker plays apart from running the application's code: `database` holds a database connector,
6
+ * `kbSource` a knowledge-base source connector.
7
+ */
8
+ export type WorkerRole = 'database' | 'kbSource';
6
9
  export interface AppRunConfiguration {
7
10
  /** List of enabled connectors packages. */
8
11
  connectors: Array<ConnectorRunConfiguration>;
@@ -56,10 +56,21 @@ export interface JiraJsmIntegrationConfiguration {
56
56
  requestHistoryDays?: number;
57
57
  }
58
58
  export interface GenericSiteIngesterIntegrationConfiguration {
59
- /** The ingestion mode. Only `'sitemap'` is implemented today. */
60
- type: 'sitemap';
61
- /** URL of the site's sitemap.xml, following the sitemaps.org protocol. */
62
- sitemapUrl: string;
59
+ /** The ingestion mode: discover pages from a sitemap, or by walking a paginated listing. */
60
+ type: 'sitemap' | 'pagination';
61
+ /** URL of the site's sitemap.xml, following the sitemaps.org protocol. Required for `type: 'sitemap'`. */
62
+ sitemapUrl?: string;
63
+ /** Listing URL containing a `{page}` placeholder, e.g. `https://example.com/blog/page/{page}`. Required for `type: 'pagination'`. */
64
+ paginationUrlTemplate?: string;
65
+ /**
66
+ * CSS selector of the element(s) on each listing page whose links are ingested. Pagination stops at
67
+ * the first page with no such links. Required for `type: 'pagination'`.
68
+ */
69
+ paginationLinkSelector?: string;
70
+ /** Value substituted for `{page}` on the first listing page. Defaults to 1. */
71
+ paginationStartPage?: number;
72
+ /** Maximum number of listing requests, including the final one that ends pagination; exceeding it fails the sync. Defaults to 200. */
73
+ paginationMaxPages?: number;
63
74
  /**
64
75
  * When true, pages are rendered in a headless browser before extraction, so client-side JavaScript
65
76
  * (SPAs, content hydrated after page load) runs and appears in the ingested text. Slower and more
@@ -1,10 +1,13 @@
1
1
  import { KbVersionRules } from '../../ai/kb-version-rules';
2
2
  /** Controls delegated, request-time Microsoft 365 retrieval. */
3
- export interface MicrosoftGraphLiveConfiguration {
3
+ export interface MicrosoftGraphDelegatedConfiguration {
4
4
  /** Live mode requires a signed-in user and disables indexing and background sync. */
5
5
  mode?: 'indexed' | 'live';
6
6
  /** Audience of the incoming Entra access token; defaults to the application client ID. */
7
7
  delegatedAudience?: string;
8
+ }
9
+ /** Controls delegated, request-time retrieval of SharePoint and OneDrive content. */
10
+ export interface MicrosoftGraphLiveConfiguration extends MicrosoftGraphDelegatedConfiguration {
8
11
  /** SharePoint site, library, or folder URLs allowed for live search and reads. */
9
12
  liveSearchRootUrls?: string[];
10
13
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/freshdesk-client",
3
- "version": "1.0.510",
3
+ "version": "1.0.512",
4
4
  "description": "Squid Freshdesk Client - SDK for interacting with the Freshdesk connector",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/freshdesk-client/src/index.d.ts",
@@ -22,7 +22,7 @@
22
22
  "author": "",
23
23
  "license": "ISC",
24
24
  "dependencies": {
25
- "@squidcloud/client": "^1.0.510"
25
+ "@squidcloud/client": "^1.0.512"
26
26
  },
27
27
  "engines": {
28
28
  "node": ">=20.0.0"