@squidcloud/freshdesk-client 1.0.506 → 1.0.507
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.
- package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +39 -4
- package/dist/internal-common/src/public-types/ai-common.public-types.d.ts +2 -2
- package/dist/internal-common/src/public-types/ai-knowledge-base.public-types.d.ts +9 -9
- package/dist/internal-common/src/public-types/connector.public-types.d.ts +1 -1
- package/dist/internal-common/src/public-types/extraction.public-types.d.ts +1 -1
- package/dist/internal-common/src/public-types/integration.public-types.d.ts +1 -1
- package/dist/internal-common/src/public-types/schema.public-types.d.ts +38 -42
- package/dist/internal-common/src/types/connector.types.d.ts +9 -0
- package/dist/internal-common/src/types/integrations/schemas.d.ts +3 -3
- package/dist/internal-common/src/types/integrations/storage-types.d.ts +9 -0
- package/dist/internal-common/src/utils/object.d.ts +0 -2
- package/package.json +2 -3
|
@@ -434,10 +434,10 @@ export type AiModelRoutingLevel = 'simple' | 'moderate' | 'complex';
|
|
|
434
434
|
*/
|
|
435
435
|
export interface AiModelRoutingOptions {
|
|
436
436
|
/**
|
|
437
|
-
* The ladder
|
|
437
|
+
* The ladder, cheapest first: two or three distinct steps, each a vendor model name or a model with its own effort.
|
|
438
438
|
* Omitted, the platform's fast, medium and capable chat models form the ladder, at low, default and high effort.
|
|
439
439
|
*/
|
|
440
|
-
models?: VendorAiChatModelName
|
|
440
|
+
models?: Array<VendorAiChatModelName | AiModelRoutingStep>;
|
|
441
441
|
/** The vendor model that rates the question. */
|
|
442
442
|
routingModel: VendorAiChatModelName;
|
|
443
443
|
/**
|
|
@@ -446,6 +446,39 @@ export interface AiModelRoutingOptions {
|
|
|
446
446
|
*/
|
|
447
447
|
instructions?: string;
|
|
448
448
|
}
|
|
449
|
+
/**
|
|
450
|
+
* One step of a routing ladder. A bare model name in the ladder runs at the request's or agent's effort, else the
|
|
451
|
+
* model's default.
|
|
452
|
+
* @category AI
|
|
453
|
+
*/
|
|
454
|
+
export interface AiModelRoutingStep {
|
|
455
|
+
/** The vendor model of the step. */
|
|
456
|
+
model: VendorAiChatModelName;
|
|
457
|
+
/**
|
|
458
|
+
* The effort the step runs at, resolved to a level the model accepts. Overrides the request's and agent's effort.
|
|
459
|
+
*/
|
|
460
|
+
reasoningEffort?: AiReasoningEffort;
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* Gives the answering model a tool that consults a stronger model mid-turn. The turn stays on its own model, so its
|
|
464
|
+
* prompt cache survives, and the advisor gets only what the answering model passes it.
|
|
465
|
+
* @category AI
|
|
466
|
+
*/
|
|
467
|
+
export interface AiAdvisorOptions {
|
|
468
|
+
/** The model that gives the advice. */
|
|
469
|
+
model: AiChatModelSelection;
|
|
470
|
+
/** The effort the advisor runs at. A vendor model runs at the nearest level it accepts. */
|
|
471
|
+
reasoningEffort?: AiReasoningEffort;
|
|
472
|
+
/** Added to the advisor's prompt, to steer what it answers and how. */
|
|
473
|
+
instructions?: string;
|
|
474
|
+
/** Consultations allowed per turn, 1 to 10. Defaults to 3. */
|
|
475
|
+
maxConsultations?: number;
|
|
476
|
+
/**
|
|
477
|
+
* Lets the advisor call the turn's functions, including ones with side effects, and pays for its tool loop.
|
|
478
|
+
* Defaults to false: the advisor sees only what the answering model passes it.
|
|
479
|
+
*/
|
|
480
|
+
shareFunctions?: boolean;
|
|
481
|
+
}
|
|
449
482
|
/**
|
|
450
483
|
* The model of an `ask` or `chat` request: a concrete model, or a set of models a routing model chooses from.
|
|
451
484
|
* @category AI
|
|
@@ -474,8 +507,8 @@ export interface AiModelRoutingResult {
|
|
|
474
507
|
/** The ladder model the request was sent to. A `backupModel` may still have served it. */
|
|
475
508
|
model: AiChatModelName;
|
|
476
509
|
/**
|
|
477
|
-
* The reasoning effort the chosen model ran at
|
|
478
|
-
*
|
|
510
|
+
* The reasoning effort the chosen model ran at, resolved to a level the model accepts: the step's own effort,
|
|
511
|
+
* else the request's or agent's, else the platform ladder step's. Undefined is the model's default.
|
|
479
512
|
*/
|
|
480
513
|
reasoningEffort?: AiReasoningEffort;
|
|
481
514
|
/** The model that rated the question. */
|
|
@@ -616,6 +649,8 @@ export interface BaseAiChatOptions {
|
|
|
616
649
|
contextMetadataFilterForKnowledgeBase?: Record<AiKnowledgeBaseId, AiContextMetadataFilter>;
|
|
617
650
|
/** The options to use for the response in voice. */
|
|
618
651
|
voiceOptions?: AiAudioCreateSpeechOptions;
|
|
652
|
+
/** A stronger model the answering model can consult mid-turn. Overrides the stored value. */
|
|
653
|
+
advisor?: AiAdvisorOptions;
|
|
619
654
|
/** List of connected AI agents can be called by the current agent. Overrides the stored value. */
|
|
620
655
|
connectedAgents?: Array<AiConnectedAgentMetadata>;
|
|
621
656
|
/** List of connected AI agents can be called by the current agent. Overrides the stored value. */
|
|
@@ -61,12 +61,12 @@ export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4.6", "grok-4-1-fast
|
|
|
61
61
|
* Public Anthropic chat model names (active models only).
|
|
62
62
|
* @category AI
|
|
63
63
|
*/
|
|
64
|
-
export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5
|
|
64
|
+
export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5"];
|
|
65
65
|
/**
|
|
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-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra", "claude-fable-5
|
|
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-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
|
/**
|
|
@@ -682,7 +682,7 @@ export interface AiKnowledgeBaseFileContextRequest extends BaseAiKnowledgeBaseCo
|
|
|
682
682
|
* Whether Squid discards the downloadable original once the file is extracted; the extracted text and
|
|
683
683
|
* images are stored either way. Defaults to false: the original is kept so the user can download it and
|
|
684
684
|
* Squid can reprocess it. Without it, `querySpreadsheetsWithAi` cannot open a workbook context and a
|
|
685
|
-
* reupsert of the context fails, on the sync and the bulk
|
|
685
|
+
* reupsert of the context fails, on the sync and the bulk path alike.
|
|
686
686
|
*/
|
|
687
687
|
discardOriginalFile?: boolean;
|
|
688
688
|
}
|
|
@@ -705,7 +705,7 @@ export declare const BULK_INGESTION_MAX_MULTIPART_FILE_BYTES: number;
|
|
|
705
705
|
*/
|
|
706
706
|
export declare const MAX_UPLOAD_FILE_BYTES: number;
|
|
707
707
|
/**
|
|
708
|
-
* Largest OneNote section (`.one`) a knowledge base ingests, on either
|
|
708
|
+
* Largest OneNote section (`.one`) a knowledge base ingests, on either path. A section carries its attachments,
|
|
709
709
|
* each indexed as a context of its own, so it may exceed {@link MAX_UPLOAD_FILE_BYTES}.
|
|
710
710
|
* @category AI
|
|
711
711
|
*/
|
|
@@ -1969,8 +1969,8 @@ export interface BulkIngestionContext {
|
|
|
1969
1969
|
*/
|
|
1970
1970
|
stagedObjectKey?: string;
|
|
1971
1971
|
/**
|
|
1972
|
-
* The preferred method for extracting data from a file context; mirrors the sync
|
|
1973
|
-
* same name, so a caller's choice survives whichever
|
|
1972
|
+
* The preferred method for extracting data from a file context; mirrors the sync path's field of the
|
|
1973
|
+
* same name, so a caller's choice survives whichever path a deployment routes the upload through.
|
|
1974
1974
|
*/
|
|
1975
1975
|
preferredExtractionMethod?: DocumentExtractionMethod;
|
|
1976
1976
|
/**
|
|
@@ -2007,7 +2007,7 @@ export interface BulkIngestionContext {
|
|
|
2007
2007
|
scopes?: Array<string>;
|
|
2008
2008
|
}
|
|
2009
2009
|
/**
|
|
2010
|
-
* Request structure for staging contexts through bulk ingestion: a durable, asynchronous
|
|
2010
|
+
* Request structure for staging contexts through bulk ingestion: a durable, asynchronous path that
|
|
2011
2011
|
* processes contexts through provider batch APIs rather than inline, for high-volume ingestion. Poll
|
|
2012
2012
|
* {@link BulkIngestionJobStatusResponse} with the returned job id for progress.
|
|
2013
2013
|
* @category AI
|
|
@@ -2063,7 +2063,7 @@ export interface BulkIngestionUpsertContextsResponse {
|
|
|
2063
2063
|
* an existing context or accepted earlier in this same call. Absent when nothing was rejected.
|
|
2064
2064
|
*
|
|
2065
2065
|
* Same shape and `errorCode: 'DUPLICATE_CONTENT'` the synchronous `upsertContexts` returns, so a caller
|
|
2066
|
-
* handles a duplicate identically on both
|
|
2066
|
+
* handles a duplicate identically on both paths. These contexts are NOT part of the job: they are not
|
|
2067
2067
|
* extracted, not staged, and never appear in its per-file statuses.
|
|
2068
2068
|
*
|
|
2069
2069
|
* Covers TEXT contexts and MULTIPART file contexts (their bytes are in hand at staging). A file staged
|
|
@@ -2197,8 +2197,8 @@ export interface AiKnowledgeBaseFileStatusInfo {
|
|
|
2197
2197
|
errorMessage?: string;
|
|
2198
2198
|
/**
|
|
2199
2199
|
* Present only when `status` is `'failed'`: the machine-readable failure class, when known. A bulk
|
|
2200
|
-
*
|
|
2201
|
-
* reports {@link UpsertContextErrorCode} — the two
|
|
2200
|
+
* path failure reports {@link BulkIngestionFileErrorCode}; a synchronous `upsertContexts` failure
|
|
2201
|
+
* reports {@link UpsertContextErrorCode} — the two paths use distinct, mostly-overlapping codes.
|
|
2202
2202
|
*/
|
|
2203
2203
|
errorCode?: BulkIngestionFileErrorCode | UpsertContextErrorCode;
|
|
2204
2204
|
/** When this status was last recorded; absent when `status` is `'no_record'`. */
|
|
@@ -2272,7 +2272,7 @@ export interface BulkIngestionStagingRefusal {
|
|
|
2272
2272
|
}
|
|
2273
2273
|
/**
|
|
2274
2274
|
* One provider batch created for a bulk-ingestion job, so a caller can tell a job waiting on a
|
|
2275
|
-
* submitted provider batch (healthy — the designed cost/latency tradeoff of the batch
|
|
2275
|
+
* submitted provider batch (healthy — the designed cost/latency tradeoff of the batch route, with
|
|
2276
2276
|
* turnaround up to 24 hours) from a job that is actually stuck, and see since when.
|
|
2277
2277
|
* @category AI
|
|
2278
2278
|
*/
|
|
@@ -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", "confluence", "connect_companion", "cotomi", "elevenlabs", "openai_voice", "essentials", "freshdesk", "generic_site_ingester", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "outlook", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "twilio", "zendesk"];
|
|
7
|
+
export declare const CONNECTOR_IDS: readonly ["bitbucket", "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", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "twilio", "zendesk"];
|
|
8
8
|
/**
|
|
9
9
|
* Unique connector package name.
|
|
10
10
|
* @category Platform
|
|
@@ -300,7 +300,7 @@ export interface ExtractDataFromDocumentResponse {
|
|
|
300
300
|
documentMetadata?: DocumentMetadata;
|
|
301
301
|
/**
|
|
302
302
|
* Structural information about the sheets when the document is a parseable spreadsheet
|
|
303
|
-
* (best-effort). Presence marks the document for
|
|
303
|
+
* (best-effort). Presence marks the document for spreadsheet summary ingestion.
|
|
304
304
|
*/
|
|
305
305
|
spreadsheet?: SpreadsheetDocumentInfo;
|
|
306
306
|
}
|
|
@@ -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", "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", "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
|
*/
|
|
@@ -1,41 +1,40 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
1
|
+
/** The `default` of a field that has the server write the time of the mutation into it. */
|
|
2
|
+
export declare const SERVER_TIMESTAMP_DEFAULT = "__SQUID_SERVER_TIMESTAMP__";
|
|
3
|
+
/**
|
|
4
|
+
* Describes one stored field. A schema says what a collection holds, for Squid and for the AI working
|
|
5
|
+
* with it; it places no rule on a write.
|
|
6
|
+
*/
|
|
7
|
+
export interface PropertySchema {
|
|
8
|
+
/** The JSON type of the value, such as `string`, `integer` or `object`. */
|
|
9
|
+
type?: string | Array<string>;
|
|
10
|
+
/** What the field holds, in words. */
|
|
11
|
+
description?: string;
|
|
12
|
+
/** The fields of a nested object. */
|
|
13
|
+
properties?: Record<string, PropertySchema>;
|
|
14
|
+
/** The values of a nested object whose keys are not known up front, by key pattern. */
|
|
15
|
+
patternProperties?: Record<string, PropertySchema>;
|
|
16
|
+
/** The element of an array. */
|
|
17
|
+
items?: PropertySchema;
|
|
18
|
+
/** The nested fields the database holds a value for in every row. */
|
|
19
|
+
required?: Array<string>;
|
|
20
|
+
/** Whether the value is a date. */
|
|
13
21
|
isDate?: boolean;
|
|
22
|
+
/** Whether the value is JSON. */
|
|
14
23
|
isJSON?: boolean;
|
|
24
|
+
/** Has the server write the time of the mutation into the field. */
|
|
25
|
+
default?: typeof SERVER_TIMESTAMP_DEFAULT;
|
|
15
26
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
27
|
+
* When `default` applies (default to 'empty'):
|
|
28
|
+
* 'always' - no matter what the client sent, both on update and insert.
|
|
29
|
+
* 'empty' - only if the value of the field is empty (undefined).
|
|
30
|
+
* 'updateOrEmpty' - no matter what the client sent, updating the record uses the default value.
|
|
18
31
|
*/
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
/** Extended JSON schema for a single property, supporting nested structures and Squid-specific metadata. */
|
|
24
|
-
export type PropertySchema = ConvertDeep<JSONSchema>;
|
|
25
|
-
/** Extended JSON schema for a top-level property, including database-related metadata. */
|
|
26
|
-
export type TopLevelPropertySchema = PropertySchema & {
|
|
32
|
+
applyDefaultValueOn?: 'always' | 'empty' | 'updateOrEmpty';
|
|
33
|
+
}
|
|
34
|
+
/** A field at the top level of a collection, including database-related metadata. */
|
|
35
|
+
export interface TopLevelPropertySchema extends PropertySchema {
|
|
27
36
|
/** Marks the property as a primary key. */
|
|
28
37
|
primaryKey?: boolean;
|
|
29
|
-
/**
|
|
30
|
-
* Whether the property is computed based on other properties or some formula.
|
|
31
|
-
* If true, readonly also needs to be true and this field should not be part of an insert statement.
|
|
32
|
-
*/
|
|
33
|
-
isComputed?: boolean;
|
|
34
|
-
/**
|
|
35
|
-
* Whether the default value generated by the database. CURRENT_DATE is something generated by the database vs
|
|
36
|
-
* 'Hello' which is a constant.
|
|
37
|
-
*/
|
|
38
|
-
isDefaultComputed?: boolean;
|
|
39
38
|
/**
|
|
40
39
|
* The database data type that is represented by this property. This is often different from the actual property
|
|
41
40
|
* type, with is a Javascript primitive. For example, for a SMALLINT the dataType would be 'smallint', but the type
|
|
@@ -46,7 +45,7 @@ export type TopLevelPropertySchema = PropertySchema & {
|
|
|
46
45
|
* This indicates that although the field exists on the db, it should be ignored by squid.
|
|
47
46
|
*/
|
|
48
47
|
hidden?: boolean;
|
|
49
|
-
}
|
|
48
|
+
}
|
|
50
49
|
/**
|
|
51
50
|
* Milestoning kind on a Legend/PURE class. Drives `.all()` arity and the date
|
|
52
51
|
* arguments required when navigating to the class's properties:
|
|
@@ -58,20 +57,18 @@ export type TopLevelPropertySchema = PropertySchema & {
|
|
|
58
57
|
*/
|
|
59
58
|
export type MilestoningKind = 'business-temporal' | 'processing-temporal' | 'bitemporal';
|
|
60
59
|
/** Schema for a full collection, allowing partial property definitions with extended metadata. */
|
|
61
|
-
export
|
|
60
|
+
export interface CollectionSchema extends Omit<PropertySchema, 'properties'> {
|
|
61
|
+
/** The fields of the collection. */
|
|
62
62
|
properties?: Record<string, TopLevelPropertySchema>;
|
|
63
63
|
/** Legend/PURE only: milestoning stereotype on the class, if any. */
|
|
64
64
|
milestoning?: MilestoningKind;
|
|
65
|
-
}
|
|
65
|
+
}
|
|
66
66
|
/**
|
|
67
67
|
* API-boundary view of {@link CollectionSchema} for use in OpenAPI-exposed
|
|
68
|
-
* controllers.
|
|
69
|
-
* recursive generic, which tsoa's type resolver cannot walk.
|
|
68
|
+
* controllers.
|
|
70
69
|
*
|
|
71
70
|
* The on-the-wire payload is the same as {@link CollectionSchema} — this type
|
|
72
|
-
* just describes it as an opaque JSON object for the generated OpenAPI spec
|
|
73
|
-
* (which is also what tsoa 5.x emitted for {@link CollectionSchema}: a bare
|
|
74
|
-
* `object` with no properties).
|
|
71
|
+
* just describes it as an opaque JSON object for the generated OpenAPI spec.
|
|
75
72
|
*/
|
|
76
73
|
export interface CollectionSchemaApi {
|
|
77
74
|
/** JSON Schema `type` keyword (e.g. "object"). */
|
|
@@ -82,7 +79,6 @@ export interface CollectionSchemaApi {
|
|
|
82
79
|
required?: string[];
|
|
83
80
|
/** Human-readable description of the collection. */
|
|
84
81
|
description?: string;
|
|
85
|
-
/** Additional
|
|
82
|
+
/** Additional fields are preserved as-is. */
|
|
86
83
|
[key: string]: unknown;
|
|
87
84
|
}
|
|
88
|
-
export {};
|
|
@@ -80,3 +80,12 @@ export interface ConnectorSyncFailedItemsPage {
|
|
|
80
80
|
/** Pass as the next page's `afterId` to continue. Undefined when this is the last page. */
|
|
81
81
|
nextAfterId?: string;
|
|
82
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
* Starts the built-in database collections a connector owns, which schema discovery hides.
|
|
85
|
+
* Never change it: stored connector data lives under names built from it.
|
|
86
|
+
*/
|
|
87
|
+
export declare const CONNECTOR_COLLECTION_PREFIX = "__squid_";
|
|
88
|
+
/** Returns the name of a built-in database collection owned by a connector of the given type. */
|
|
89
|
+
export declare function buildConnectorCollectionName(integrationType: IntegrationType, collectionName: string): string;
|
|
90
|
+
/** Returns whether a built-in database collection is owned by a connector. */
|
|
91
|
+
export declare function isConnectorCollectionName(collectionName: string): boolean;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { IntegrationType } from '../../public-types/integration.public-types';
|
|
2
2
|
export { isIntegrationDisabled } from '../../public-types/integration.public-types';
|
|
3
|
-
/** Returns whether an integration of [type]
|
|
3
|
+
/** Returns whether an integration of [type] accepts a per-request access token. */
|
|
4
4
|
export declare function supportsPerRequestAccessToken(type: IntegrationType): boolean;
|
|
5
|
-
/** Narrows a
|
|
6
|
-
export declare function isPerRequestAccessTokenIntegration(integration: IntegrationConfig): integration is IntegrationConfigTypes[
|
|
5
|
+
/** Narrows a database configuration to the driver that accepts per-request access tokens. */
|
|
6
|
+
export declare function isPerRequestAccessTokenIntegration(integration: IntegrationConfig): integration is IntegrationConfigTypes['databricks'];
|
|
@@ -1,4 +1,13 @@
|
|
|
1
1
|
import { KbVersionRules } from '../../ai/kb-version-rules';
|
|
2
|
+
/** Controls delegated, request-time Microsoft 365 retrieval. */
|
|
3
|
+
export interface MicrosoftGraphLiveConfiguration {
|
|
4
|
+
/** Live mode requires a signed-in user and disables indexing and background sync. */
|
|
5
|
+
mode?: 'indexed' | 'live';
|
|
6
|
+
/** Audience of the incoming Entra access token; defaults to the application client ID. */
|
|
7
|
+
delegatedAudience?: string;
|
|
8
|
+
/** SharePoint site, library, or folder URLs allowed for live search and reads. */
|
|
9
|
+
liveSearchRootUrls?: string[];
|
|
10
|
+
}
|
|
2
11
|
/** How the SharePoint connector groups versions of one document (`Deck v01 … v05, vF`). */
|
|
3
12
|
export interface SharePointVersioningConfiguration {
|
|
4
13
|
/**
|
|
@@ -13,8 +13,6 @@ export declare function isDateObject(value: unknown): value is Date;
|
|
|
13
13
|
/** Sets a value by path, as own properties of the objects on it. Does not support array indexes. */
|
|
14
14
|
export declare function setInPath(obj: object, path: string, value: unknown, delimiter?: string): void;
|
|
15
15
|
export declare function deleteInPath(obj: object, path: string, delimiter?: string): void;
|
|
16
|
-
export declare function replaceKeyInMap<K, T>(map: Map<K, T | undefined>, a: K, b: K): void;
|
|
17
|
-
export declare function replaceKeyInRecord<K extends keyof any, T>(record: Record<K, T>, a: K, b: K): void;
|
|
18
16
|
export declare function isNil(obj: unknown): obj is null | undefined;
|
|
19
17
|
export declare function isEqual(a: unknown, b: unknown): boolean;
|
|
20
18
|
export declare function isEmpty(a: unknown): boolean;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@squidcloud/freshdesk-client",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.507",
|
|
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,8 +22,7 @@
|
|
|
22
22
|
"author": "",
|
|
23
23
|
"license": "ISC",
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"
|
|
26
|
-
"@squidcloud/client": "^1.0.506"
|
|
25
|
+
"@squidcloud/client": "^1.0.507"
|
|
27
26
|
},
|
|
28
27
|
"engines": {
|
|
29
28
|
"node": ">=20.0.0"
|