@squidcloud/freshdesk-client 1.0.505 → 1.0.506

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.
@@ -422,21 +422,27 @@ export interface IntegrationModelSpec {
422
422
  */
423
423
  export type AiChatModelSelection = AiChatModelName | IntegrationModelSpec;
424
424
  /**
425
- * Lets a routing model pick which of several vendor models answers an `ask` or `chat` request. The routing model
426
- * sees the question, the agent's instructions and a card per candidate (price, tier, reasoning,
427
- * context window) and names the one that should answer; that model then serves the request.
425
+ * How demanding a routing model rated a question: `simple` goes to the first step of the routing ladder, `complex`
426
+ * to the last, `moderate` to the middle one.
427
+ * @category AI
428
+ */
429
+ export type AiModelRoutingLevel = 'simple' | 'moderate' | 'complex';
430
+ /**
431
+ * Lets a routing model pick which model of a ladder answers an `ask` or `chat` request. The routing model rates
432
+ * how demanding the question is, given the agent's instructions, and the ladder step for that rating serves it.
428
433
  * @category AI
429
434
  */
430
435
  export interface AiModelRoutingOptions {
431
- /** The vendor models the routing model chooses from; at least two, no duplicates. */
432
- models: VendorAiChatModelName[];
433
- /** The vendor model that makes the choice. */
436
+ /**
437
+ * The ladder of vendor models, cheapest first: two or three, no duplicates, each run at its default effort.
438
+ * Omitted, the platform's fast, medium and capable chat models form the ladder, at low, default and high effort.
439
+ */
440
+ models?: VendorAiChatModelName[];
441
+ /** The vendor model that rates the question. */
434
442
  routingModel: VendorAiChatModelName;
435
443
  /**
436
- * How to choose, in plain language: the routing model follows it over its default rule, which
437
- * takes the cheapest candidate that can answer well. Up to 2000 characters. The routing model
438
- * sees each candidate's price, context window and benchmark measurements, so an instruction can
439
- * refer to them ("never pay more than $0.01 per answer", "prefer the model measured on coding").
444
+ * How to rate questions, in plain language: replaces the default rule, which takes the lower of two
445
+ * levels a question sits between. Up to 2000 characters.
440
446
  */
441
447
  instructions?: string;
442
448
  }
@@ -465,16 +471,18 @@ export type AiChatRequestOptions = Omit<AllAiAgentChatOptions, 'model'> & {
465
471
  * @category AI
466
472
  */
467
473
  export interface AiModelRoutingResult {
468
- /** The model the routing model chose and the request was sent to. A `backupModel` may still have served it. */
469
- model: VendorAiChatModelName;
474
+ /** The ladder model the request was sent to. A `backupModel` may still have served it. */
475
+ model: AiChatModelName;
470
476
  /**
471
- * The reasoning effort the chosen model ran at: the routing model's own pick, or the request's or
472
- * agent's effort resolved to a level the model accepts when one was set. Undefined is the model's default.
477
+ * The reasoning effort the chosen model ran at: its ladder step's effort, or the request's or agent's
478
+ * effort resolved to a level the model accepts when one was set. Undefined is the model's default.
473
479
  */
474
480
  reasoningEffort?: AiReasoningEffort;
475
- /** The model that made the choice. */
481
+ /** The model that rated the question. */
476
482
  routingModel: VendorAiChatModelName;
477
- /** The routing model's one-line justification of the choice. */
483
+ /** How demanding the routing model rated the question. */
484
+ level: AiModelRoutingLevel;
485
+ /** The routing model's one-line justification of the rating. */
478
486
  reason: string;
479
487
  /** Input tokens the routing call consumed. */
480
488
  inputTokens: number;
@@ -1488,6 +1496,11 @@ export type AiSessionContext = {
1488
1496
  * takes precedence over it.
1489
1497
  */
1490
1498
  timeoutMs?: number;
1499
+ /**
1500
+ * The root request's `metricAnnotations`. Nested AI operations (e.g. AI-query stages spawned by a tool
1501
+ * call) report their model usage under them, so it adds up with the agent's own.
1502
+ */
1503
+ metricAnnotations?: Record<string, string>;
1491
1504
  };
1492
1505
  /**
1493
1506
  * API request to delete an AI agent
@@ -46,7 +46,7 @@ export declare const AI_CODE_INTERPRETER_PROVIDER_TYPES: readonly ["openai", "an
46
46
  * Public OpenAI chat model names (active models only).
47
47
  * @category AI
48
48
  */
49
- export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol"];
49
+ export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra"];
50
50
  /**
51
51
  * Public Gemini chat model names (active models only).
52
52
  * @category AI
@@ -66,7 +66,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5", "cl
66
66
  * The supported AI model names.
67
67
  * @category AI
68
68
  */
69
- export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "claude-fable-5", "claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-argon", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
69
+ export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra", "claude-fable-5", "claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-argon", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
70
70
  /** Checks if the given model name is a global AI chat model name. */
71
71
  export declare function isVendorAiChatModelName(modelName: unknown): modelName is VendorAiChatModelName;
72
72
  /**
@@ -357,7 +357,7 @@ export interface AiKnowledgeBaseChatOptions {
357
357
  includeReference?: boolean;
358
358
  /** Include metadata in the context */
359
359
  includeMetadata?: boolean;
360
- /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
360
+ /** Which provider's reranker to use for reranking the context. Defaults to the deployment's default reranker. */
361
361
  rerankProvider?: AiRerankProvider;
362
362
  /**
363
363
  * Minimum reranker relevance score a chunk must reach to stay once at least 10 chunks are already kept.
@@ -745,7 +745,7 @@ export interface AiKnowledgeBaseSearchOptions {
745
745
  prompt: string;
746
746
  /** The maximum number of results to return */
747
747
  limit?: number;
748
- /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
748
+ /** Which provider's reranker to use for reranking the context. Defaults to the deployment's default reranker. */
749
749
  rerankProvider?: AiRerankProvider;
750
750
  /**
751
751
  * Minimum reranker relevance score a chunk must reach to stay once at least 10 chunks are already kept.
@@ -2,6 +2,7 @@ import { AiAgentMemoryOptions, AiChatOptions, AiFileUrl, AiSessionContext } from
2
2
  import { AiChatModelName } from './ai-common.public-types';
3
3
  import { ApiOptions } from './api-client.public-types';
4
4
  import { AiAgentId, IntegrationId } from './communication.public-types';
5
+ import { JobId } from './job.public-types';
5
6
  import { PartialBy } from './typescript.public-types';
6
7
  /** A single output column descriptor in a raw query result file. */
7
8
  export interface AiQueryResultFieldSchema {
@@ -43,6 +44,23 @@ export interface AiQueryOptions {
43
44
  generateQueriesOnly?: boolean;
44
45
  /** Optional AI validation of generated queries. Can be used independently or with generateQueriesOnly. */
45
46
  validateWithAiOptions?: AiQueryValidateWithAiOptions;
47
+ /**
48
+ * The agent ask this query runs for. When set, the query's model usage is reported on the AI chat usage
49
+ * metrics under that ask's tags, so it adds up with the agent's own usage.
50
+ */
51
+ usageAttribution?: AiUsageAttribution;
52
+ }
53
+ /**
54
+ * Identifies the agent ask that AI usage is reported under.
55
+ * @category AI
56
+ */
57
+ export interface AiUsageAttribution {
58
+ /** Job ID of the ask, reported as the `aiJobId` metric tag. */
59
+ jobId: JobId;
60
+ /** ID of the agent that ran the ask, reported as the `aiProfile` metric tag. */
61
+ agentId: AiAgentId;
62
+ /** Metric annotations of the ask, reported as `annotation.<key>` metric tags. */
63
+ metricAnnotations?: Record<string, string>;
46
64
  }
47
65
  /**
48
66
  * Options of a single AI query call: the query options plus a credential the client sends as a request header.
@@ -1,10 +1,10 @@
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", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "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", "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
  */
7
- export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "dynamodb", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "snowflake", "elasticsearch", "legend"];
7
+ export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "dynamodb", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "snowflake", "elasticsearch", "legend", "salesforce_db"];
8
8
  /**
9
9
  * @category Auth
10
10
  */
@@ -43,6 +43,11 @@ export interface ResolveJobRequest {
43
43
  /** The error message, present when status is 'failed'. */
44
44
  error?: string;
45
45
  }
46
+ /** Represents a request to cancel a running server-executed job. */
47
+ export interface CancelJobRequest {
48
+ /** The unique identifier of the job to cancel. */
49
+ jobId: JobId;
50
+ }
46
51
  /**
47
52
  * Represents a keep-alive request signalling that the client still owns the listed active jobs.
48
53
  */
@@ -72,8 +77,9 @@ export interface AsyncJob<T = any> {
72
77
  * - 'in_progress': The job is currently being processed.
73
78
  * - 'completed': The job has finished successfully.
74
79
  * - 'failed': The job has failed.
80
+ * - 'cancelled': The job was stopped by a cancel request.
75
81
  */
76
- status: 'in_progress' | 'completed' | 'failed';
82
+ status: 'in_progress' | 'completed' | 'failed' | 'cancelled';
77
83
  /**
78
84
  * The result of the job, if available.
79
85
  * This is of type `T` and is optional.
@@ -89,7 +95,14 @@ export interface AsyncJob<T = any> {
89
95
  * failure kind (e.g. `'AI_PROVIDER_ERROR'`) without parsing {@link error}.
90
96
  */
91
97
  errorType?: string;
98
+ /**
99
+ * Whether the job can be stopped with a cancel request. Providers that do not honor the abort
100
+ * signal keep running until their current call ends, so cancellation is not always immediate.
101
+ */
102
+ cancellable?: boolean;
92
103
  }
104
+ /** The {@link JobError.errorType} of an error thrown for a job stopped by a cancel request. */
105
+ export declare const JOB_CANCELLED_ERROR_TYPE = "JOB_CANCELLED";
93
106
  /**
94
107
  * An `Error` carrying a machine-readable {@link errorType}, thrown by `JobClient.awaitJob` when a
95
108
  * failed job's {@link AsyncJob.errorType} is set. Lets a caller branch on the failure kind (e.g.
@@ -1,9 +1,9 @@
1
1
  import { IntegrationId } from '../public-types/communication.public-types';
2
2
  /**
3
- * Represents the type of native query request, either relational, elastic or MongoDB.
3
+ * Represents the type of native query request: relational, MongoDB, Elasticsearch, Pure or Salesforce SOQL.
4
4
  * @category Database
5
5
  */
6
- export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure';
6
+ export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure' | 'soql';
7
7
  /**
8
8
  * Base fields shared by all native query contexts.
9
9
  * @category Database
@@ -69,7 +69,19 @@ export interface PureNativeQueryContext extends BaseNativeQueryContext {
69
69
  params: Record<string, any>;
70
70
  }
71
71
  /**
72
- * Union type representing either a relational or MongoDB native query context.
72
+ * Context for executing a Salesforce SOQL query.
73
73
  * @category Database
74
74
  */
75
- export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext;
75
+ export interface SoqlNativeQueryContext extends BaseNativeQueryContext {
76
+ /** Specifies that the query is a Salesforce SOQL query. */
77
+ type: 'soql';
78
+ /** SOQL query string to be executed, with `${name}` placeholders for the parameters. */
79
+ query: string;
80
+ /** Parameters to be bound into the query. */
81
+ params: Record<string, any>;
82
+ }
83
+ /**
84
+ * Union type representing any of the supported native query contexts.
85
+ * @category Database
86
+ */
87
+ export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext | SoqlNativeQueryContext;
@@ -13,6 +13,11 @@ export interface ConnectorPackageMetadata {
13
13
  }
14
14
  /** A file inside a connector package that contains package metadata. */
15
15
  export declare const CONNECTOR_METADATA_JSON_FILE = "connector-metadata.json";
16
+ /**
17
+ * Connectors published with an empty `integrationTypes` list: they are selected by matching
18
+ * their connector ID to an integration type, so the CLI emits no types and core accepts none.
19
+ */
20
+ export declare const CONNECTORS_MATCHED_BY_ID: ReadonlyArray<ConnectorId>;
16
21
  /** Per application app connectors. */
17
22
  export interface ApplicationAppConnectors {
18
23
  appConnectors: Array<ConnectorId>;
@@ -1,20 +1,17 @@
1
1
  import { Condition, DocIdCondition, SimpleCondition } from '../public-types/query.public-types';
2
+ /** Longest LIKE pattern a query may carry, in characters: Core refuses a longer one at intake. */
3
+ export declare const MAX_LIKE_PATTERN_LENGTH = 4096;
4
+ /**
5
+ * Splits a LIKE pattern into tokens with the executor's escape rules: \% , \_ and \\ stand for the literal character
6
+ * and keep their backslash, so they never compare equal to the wildcard tokens. A run of % is one token.
7
+ */
8
+ export declare function tokenizeLikePattern(pattern: string): string[];
2
9
  /**
3
10
  * Whether a LIKE pattern has a backslash before anything but `%`, `_` or another backslash, which is not
4
- * a valid escape. Executors disagree on what it matches: PostgreSQL reads `\d` as `d`, while Mongo and
5
- * the local matcher pass it to a regex as a digit.
11
+ * a valid escape. Executors disagree on what it matches: PostgreSQL reads `\d` as `d`, Mongo passes it to
12
+ * a regex as a digit and the local matcher reads a backslash followed by `d`.
6
13
  */
7
14
  export declare function hasInvalidLikeEscape(pattern: string): boolean;
8
- /**
9
- * Generates the regex pattern, handling special characters as follows:
10
- * - `_` is replaced with a `.`
11
- * - `%` is replaced with `[\s\S]*`.
12
- * - The above characters can be escaped with \, eg. `\_` is replaced with `_` and `\%` with `%`.
13
- * - All special characters in regex (-, /, \, ^, $, *, +, ?, ., (, ), |, [, ], {, }) get escaped with \
14
- *
15
- * Exported for testing purposes.
16
- * */
17
- export declare function replaceSpecialCharacters(input: string): string;
18
15
  /** Returns true if the condition is a 'SimpleCondition' or false otherwise. */
19
16
  export declare function isSimpleCondition(condition: Condition): condition is SimpleCondition;
20
17
  /** Returns true if the condition is a 'DocIdCondition' or false otherwise. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/freshdesk-client",
3
- "version": "1.0.505",
3
+ "version": "1.0.506",
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",
@@ -23,7 +23,7 @@
23
23
  "license": "ISC",
24
24
  "dependencies": {
25
25
  "assertic": "^1.3.0",
26
- "@squidcloud/client": "^1.0.505"
26
+ "@squidcloud/client": "^1.0.506"
27
27
  },
28
28
  "engines": {
29
29
  "node": ">=20.0.0"