@squidcloud/client 1.0.343 → 1.0.344

package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts

@@ -153,75 +153,105 @@ export type AiAudioTranscribeOptions = WhisperOptions;
  */
 export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
 /**
+ * Base options for generating images with an AI model.
  * @category AI
  */
 export interface BaseAiGenerateImageOptions {
+    /** The name of the AI model to use for image generation. */
     modelName: AiImageModelName;
 }
 /**
+ * Base options for transcribing audio with an AI model.
  * @category AI
  */
 export interface BaseAiAudioTranscribeOptions {
+    /** The name of the AI model to use for audio transcription. */
     modelName: AiAudioTranscriptionModelName;
 }
 /**
+ * Base options for creating speech with an AI model.
  * @category AI
  */
 export interface BaseAiAudioCreateSpeechOptions {
+    /** The name of the AI model to use for speech creation. */
     modelName: AiAudioCreateSpeechModelName;
 }
 /**
+ * Options for generating images using the DALL-E model.
  * @category AI
  */
 export interface DallEOptions extends BaseAiGenerateImageOptions {
+    /** Specifies the DALL-E 3 model for image generation. */
     modelName: 'dall-e-3';
+    /** The quality of the generated image; defaults to 'standard'. */
     quality?: 'hd' | 'standard';
+    /** The size of the generated image; defaults to '1024x1024'. */
     size?: '1024x1024' | '1792x1024' | '1024x1792';
+    /** The number of images to generate; defaults to 1 and limited to 1. */
     numberOfImagesToGenerate?: 1;
 }
 /**
+ * Options for transcribing audio using the Whisper model.
  * @category AI
  */
 export interface WhisperOptions extends BaseAiAudioTranscribeOptions {
+    /** Specifies the Whisper-1 model for audio transcription. */
     modelName: 'whisper-1';
+    /** The format of the transcription response; defaults to 'json'. */
     responseFormat?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
+    /** The temperature for sampling during transcription; defaults to model-specific value. */
     temperature?: number;
+    /** An optional prompt to guide the transcription process. */
     prompt?: string;
 }
 /**
+ * Options for creating speech using OpenAI's text-to-speech models.
  * @category AI
  */
 export interface OpenAiCreateSpeechOptions extends BaseAiAudioCreateSpeechOptions {
+    /** The OpenAI model to use for speech creation (e.g., 'tts-1' or 'tts-1-hd'). */
     modelName: OpenAiAudioCreateSpeechModelName;
+    /** The voice to use for speech synthesis; defaults to model-specific value. */
     voice?: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
+    /** The format of the audio output; defaults to 'mp3'. */
     responseFormat?: OpenAiCreateSpeechFormat;
+    /** The speed of the speech; defaults to 1.0. */
     speed?: number;
 }
 /**
+ * Options for generating images using the Flux model.
  * @category AI
  */
 export interface FluxOptions extends BaseAiGenerateImageOptions {
+    /** Specifies the Flux Pro 1.1 model for image generation. */
     modelName: 'flux-pro-1.1';
-    /**  Must be a multiple of 32. Min 256, max 1440 - default to 1024 */
+    /** The width of the generated image, must be a multiple of 32, min 256, max 1440; defaults to 1024. */
     width?: number;
-    /**  Must be a multiple of 32. Min 256, max 1440 - default to 768 */
+    /** The height of the generated image, must be a multiple of 32, min 256, max 1440; defaults to 768. */
     height?: number;
-    /** Whether to modify the prompt for more creative generation - default to false */
+    /** Whether to enhance the prompt for more creative output; defaults to false. */
     prompt_upsampling?: boolean;
-    /** Random seed. Set for reproducible generation */
+    /** A random seed for reproducible generation, if specified. */
     seed?: number;
-    /** 1 is most strict and 5 is most permissive */
+    /** The safety tolerance level, from 1 (strict) to 5 (permissive). */
     safety_tolerance?: number;
 }
 /**
+ * Options for generating images using the Stable Diffusion Core model.
  * @category AI
  */
 export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
+    /** Specifies the Stable Diffusion Core model for image generation. */
     modelName: 'stable-diffusion-core';
+    /** The aspect ratio of the generated image; defaults to '1:1'. */
     aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '4:5' | '5:4' | '9:16' | '9:21';
+    /** An optional negative prompt to guide what to exclude from the image. */
     negativePrompt?: string;
+    /** A random seed for reproducible generation, if specified. */
     seed?: number;
+    /** A style preset to apply to the generated image, if specified. */
     stylePreset?: 'analog-film' | 'anime' | 'cinematic' | 'comic-book' | 'digital-art' | 'enhance' | 'fantasy-art' | 'isometric' | 'line-art' | 'low-poly' | 'modeling-compound' | 'neon-punk' | 'origami' | 'photographic' | 'pixel-art' | 'tile-texture';
+    /** The format of the output image; defaults to 'png'. */
     outputFormat?: 'jpeg' | 'png' | 'webp';
 }
 /**
@@ -238,40 +268,37 @@ export type AiAgentResponseFormat = 'text' | 'json_object';
  */
 export type AiFileUrlType = 'image';
 /**
+ * Represents a URL reference to an AI-processed file, such as an image.
  * @category AI
  */
 export interface AiFileUrl {
+    /** The type of file referenced by the URL (e.g., 'image'). */
     type: AiFileUrlType;
+    /** The URL pointing to the file. */
     url: string;
 }
 /**
+ * Metadata for an AI agent connected to an integration.
  * @category AI
  */
 export interface AiConnectedIntegrationMetadata {
+    /** The ID of the connected integration. */
     integrationId: IntegrationId;
-    /** Type of the connected integration. */
+    /** The type of the connected integration (e.g., API, database). */
     integrationType: IntegrationType;
-    /**
-     * Description of the connected integration for the parent agent context.
-     * Works as AI function description.
-     * If not provided the default one is used.
-     */
+    /** An optional description of the integration for the parent agent context, used as AI function description. */
     description?: string;
-    /**
-     * Instructions for the connected integration agent.
-     * If not provided the default one is used.
-     */
+    /** Optional instructions for the connected integration agent, overriding the default if provided. */
     instructions?: string;
 }
 /**
+ * Metadata for a connected AI agent callable by the current agent.
  * @category AI
  */
 export interface AiConnectedAgentMetadata {
+    /** The ID of the connected AI agent. */
     agentId: AiAgentId;
-    /**
-     * Description of the connected agent for the parent agent context.
-     * Works as AI function description.
-     */
+    /** A description of the connected agent for the parent agent context, used as AI function description. */
     description: string;
 }
 /**
@@ -342,18 +369,23 @@ export interface BaseAiAgentChatOptions {
     model?: AiChatModelName;
 }
 /**
- * Each model-specific options interface now “anchors” the overrideModel property.
+ * Chat options specific to Gemini models, extending base options.
  * @category AI
  */
 export interface GeminiChatOptions extends BaseAiAgentChatOptions {
+    /** The Gemini model to use for the chat. */
     model?: GeminiChatModelName;
+    /** Enables grounding with web search for more informed responses; defaults to false. */
     groundingWithWebSearch?: boolean;
 }
 /**
+ * Chat options specific to OpenAI models, extending base options.
  * @category AI
  */
 export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
+    /** The OpenAI model to use for the chat. */
     model?: OpenAiChatModelName;
+    /** An array of file URLs to include in the chat context. */
     fileUrls?: Array<AiFileUrl>;
 }
 /**
@@ -361,24 +393,33 @@ export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
  */
 export type OpenAiReasoningEffort = 'low' | 'medium' | 'high';
 /**
+ * Chat options for OpenAI reasoning models, extending OpenAI options.
  * @category AI
  */
 export interface OpenAiReasoningChatOptions extends OpenAiChatOptions {
+    /** The OpenAI reasoning model to use for the chat. */
     model?: OpenAiReasoningChatModelName;
+    /** The level of reasoning effort to apply; defaults to model-specific value. */
     reasoningEffort?: OpenAiReasoningEffort;
 }
 /**
+ * Chat options specific to Anthropic models, extending base options.
  * @category AI
  */
 export interface AnthropicChatOptions extends BaseAiAgentChatOptions {
+    /** The Anthropic model to use for the chat. */
     model?: AnthropicChatModelName;
 }
 /**
+ * Optional settings for an AI session, allowing partial specification of identifiers.
  * @category AI
  */
 export type AiSessionOptions = Partial<{
+    /** A unique identifier for tracing the session, if provided. */
     traceId: string;
+    /** The ID of the client initiating the session, if specified. */
     clientId: string;
+    /** The ID of the AI agent involved in the session, if specified. */
     agentId: string;
 }>;
 /**
@@ -394,17 +435,23 @@ export type AllAiAgentChatOptions = {
     [K in keyof BaseAiAgentChatOptions | keyof GeminiChatOptions | keyof OpenAiReasoningChatOptions | keyof OpenAiChatOptions | keyof AnthropicChatOptions]?: (K extends keyof BaseAiAgentChatOptions ? BaseAiAgentChatOptions[K] : never) | (K extends keyof GeminiChatOptions ? GeminiChatOptions[K] : never) | (K extends keyof OpenAiReasoningChatOptions ? OpenAiReasoningChatOptions[K] : never) | (K extends keyof OpenAiChatOptions ? OpenAiChatOptions[K] : never) | (K extends keyof AnthropicChatOptions ? AnthropicChatOptions[K] : never);
 };
 /**
- * A definition of an AI agent.
+ * A definition of an AI agent with its properties and default chat options.
  * @category AI
  */
 export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
+    /** The unique identifier of the AI agent. */
     id: AiAgentId;
+    /** The date and time the agent was created. */
     createdAt: Date;
+    /** The date and time the agent was last updated. */
     updatedAt: Date;
+    /** An optional description of the agent's purpose or capabilities. */
     description?: string;
+    /** Indicates whether the agent is publicly accessible; defaults to false. */
     isPublic?: boolean;
+    /** Enables audit logging for the agent's activities if true; defaults to false. */
     auditLog?: boolean;
-    /** The default options of the agent - can be overridden by the user when using the agent. */
+    /** The default chat options for the agent, overridable by the user during use. */
     options: AiAgentChatOptions<T>;
 }
 /**
@@ -414,6 +461,7 @@ export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'opti
     options?: AiAgentChatOptions;
 };
 /**
+ * Options for observing the status of an AI agent operation.
  * @category AI
  */
 export interface AiObserveStatusOptions {
@@ -421,12 +469,17 @@ export interface AiObserveStatusOptions {
     chatId?: string;
 }
 /**
+ * A status message from an AI agent operation.
  * @category AI
  */
 export interface AiStatusMessage {
+    /** The ID of the agent generating the status message. */
     agentId: string;
+    /** An optional chat ID associated with the status message. */
     chatId?: string;
+    /** The title or summary of the status message. */
     title: string;
+    /** Optional tags providing additional metadata about the status. */
     tags?: Record<string, any>;
 }
 /**
@@ -442,26 +495,41 @@ export interface AiSearchOptions {
     limit?: number;
 }
 /**
+ * A single chunk of data returned from an AI search operation.
  * @category AI
  */
 export interface AiSearchResultChunk {
+    /** The data content of the search result chunk. */
     data: string;
+    /** Optional metadata associated with the chunk. */
     metadata?: AiContextMetadata;
+    /** The relevance score of the chunk, indicating match quality. */
     score: number;
 }
 /**
+ * Represents an AI agent's context entry with metadata and content.
  * @category AI
  */
 export interface AiAgentContext {
+    /** The unique identifier of the context entry. */
     id: AiContextId;
+    /** The date and time the context was created. */
     createdAt: Date;
+    /** The date and time the context was last updated. */
     updatedAt: Date;
+    /** The ID of the agent owning this context. */
     agentId: AiAgentId;
+    /** The type of context (e.g., 'text' or 'file'). */
     type: AiContextType;
+    /** A title describing the context content. */
     title: string;
+    /** The text content of the context. */
     text: string;
+    /** Indicates whether the context is a preview; defaults to false. */
     preview: boolean;
+    /** The size of the context content in bytes. */
     sizeBytes: number;
+    /** Metadata associated with the context. */
     metadata: AiContextMetadata;
 }
 /**
@@ -478,23 +546,35 @@ interface BaseContextRequest {
  */
 export type AiContextType = 'text' | 'file';
 /**
+ * Request structure for adding text-based context to an AI agent.
  * @category AI
  */
 export interface TextContextRequest extends BaseContextRequest {
+    /** Specifies the context type as 'text'. */
     type: 'text';
+    /** A title for the text context. */
     title: string;
+    /** The text content to add to the context. */
     text: string;
 }
 /**
+ * Request structure for adding file-based context to an AI agent.
  * @category AI
  */
 export interface FileContextRequest extends BaseContextRequest {
+    /** Specifies the context type as 'file'. */
     type: 'file';
+    /** Whether to extract images from the file; defaults to false. */
     extractImages?: boolean;
+    /** The minimum width for extracted images, if applicable. */
     minImageWidth?: number;
+    /** The minimum height for extracted images, if applicable. */
     minImageHeight?: number;
+    /** Whether to treat the full page as an image; defaults to false. */
     fullPageAsImage?: boolean;
+    /** The AI model to use for extraction, if specified. */
     extractionModel?: AiChatModelName;
+    /** An optional password to access the file, if encrypted. */
     password?: string;
 }
 /**
@@ -537,21 +617,27 @@ interface AiContextMetadataExistsFilter {
  */
 export type AiContextMetadataSimpleFilter = AiContextMetadataEqFilter | AiContextMetadataNeFilter | AiContextMetadataGtFilter | AiContextMetadataGteFilter | AiContextMetadataLtFilter | AiContextMetadataLteFilter | AiContextMetadataInFilter | AiContextMetadataNinFilter | AiContextMetadataExistsFilter;
 /**
+ * A filter for AI context metadata based on field-specific conditions or values.
  * @category AI
  */
 export interface AiContextMetadataFieldFilter {
+    /** A record where keys are field names and values are either simple filters or direct metadata values. */
     [field: string]: AiContextMetadataSimpleFilter | AiContextMetadataValue;
 }
 /**
+ * A filter combining multiple AI context metadata filters with a logical AND operation.
  * @category AI
  */
 export interface AiContextMetadataAndFilter {
+    /** An array of filters that must all be true for the condition to pass. */
     $and: AiContextMetadataFilter[];
 }
 /**
+ * A filter combining multiple AI context metadata filters with a logical OR operation.
  * @category AI
  */
 export interface AiContextMetadataOrFilter {
+    /** An array of filters where at least one must be true for the condition to pass. */
     $or: AiContextMetadataFilter[];
 }
 /**
@@ -559,6 +645,7 @@ export interface AiContextMetadataOrFilter {
  */
 export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMetadataAndFilter | AiContextMetadataOrFilter;
 /**
+ * A record of metadata key-value pairs for AI context, where values are primitive types or undefined.
  * @category AI
  */
 export type AiContextMetadata = Record<string, AiContextMetadataValue>;
@@ -567,20 +654,29 @@ export type AiContextMetadata = Record<string, AiContextMetadataValue>;
  */
 export type GuardrailKeysType = 'disableProfanity' | 'offTopicAnswers' | 'professionalTone' | 'disablePii';
 /**
+ * Options for applying guardrails to AI responses to enforce specific constraints.
  * @category AI
  */
 export type GuardrailsOptions = {
+    /** Disables profanity in the AI response if true; defaults to false. */
     disableProfanity?: boolean;
+    /** Prevents off-topic answers if true; defaults to false. */
     offTopicAnswers?: boolean;
+    /** Enforces a professional tone in the response if true; defaults to false. */
     professionalTone?: boolean;
+    /** Disables inclusion of personally identifiable information if true; defaults to false. */
     disablePii?: boolean;
+    /** A custom guardrail instruction, if specified. */
     custom?: string;
 };
 /**
+ * Response structure for transcribing audio and asking an AI agent a question.
  * @category AI
  */
 export interface AiTranscribeAndAskResponse {
+    /** The AI agent's response to the transcribed prompt. */
     responseString: string;
+    /** The transcribed text from the audio input. */
     transcribedPrompt: string;
 }
 export {};

package/dist/internal-common/src/public-types/ai-assistant.public-types.d.ts

@@ -6,17 +6,20 @@ import { FunctionName } from './backend.public-types';
  */
 export type AssistantToolType = 'code_interpreter' | 'file_search';
 /**
- * The options for the AI assistant.
+ * The options for configuring an AI assistant's behavior and response.
  * @category AI
  */
 export interface QueryAssistantOptions {
-    /** Extra context passed to all AI functions. */
+    /** Additional context provided to all AI functions for processing. */
     agentContext?: Record<string, unknown>;
-    /** Extra context per AI function.*/
+    /** Specific context provided per AI function, keyed by function name. */
     functionContexts?: Record<FunctionName, Record<string, unknown>>;
-    /** The format of the response from the AI model. Defaults to 'text' */
+    /** The desired format of the AI model's response; defaults to 'text'. */
     responseFormat?: AiAgentResponseFormat;
+    /** The OpenAI chat model to use for the assistant, if specified. */
     model?: OpenAiChatModelName;
+    /** The level of reasoning effort to apply, as defined by OpenAI. */
     reasoningEffort?: OpenAiReasoningEffort;
+    /** Custom instructions to guide the assistant's behavior, if provided. */
     instructions?: string;
 }

package/dist/internal-common/src/public-types/ai-matchmaking.types.d.ts

@@ -5,7 +5,9 @@ import { AiContextMetadata, AiContextMetadataFilter } from './ai-agent.public-ty
  * @category AI
  */
 export interface MmCategory {
+    /** The unique identifier of the category. */
     id: string;
+    /** A description used by the AI to understand and extract features from the category content. */
     description: string;
 }
 /**
@@ -14,9 +16,13 @@ export interface MmCategory {
  * @category AI
  */
 export interface MmEntity {
+    /** The unique identifier of the entity. */
     id: string;
+    /** The content of the entity to be matched. */
     content: string;
+    /** The ID of the category this entity belongs to. */
     categoryId: string;
+    /** Metadata used for filtering entities during matching. */
     metadata: AiContextMetadata;
 }
 /**
@@ -27,12 +33,11 @@ export interface MmEntity {
  * @category AI
  */
 export interface MmMatchMaker {
+    /** The unique identifier of the matchmaker. */
     id: string;
+    /** A description aiding the AI in understanding the matchmaker's domain. */
     description: string;
-    /** @deprecated */
-    firstCategory?: MmCategory;
-    /** @deprecated */
-    secondCategory?: MmCategory;
+    /** An array of categories defining the types of entities that can be matched. */
     categories: Array<MmCategory>;
 }
 /**
@@ -40,32 +45,30 @@ export interface MmMatchMaker {
  * @category AI
  */
 export interface MmEntityMatch extends MmEntity {
-    /** The score of the match between 0 and 100 - 100 represents best match. */
+    /** The score of the match, ranging from 0 to 100, where 100 is the best match. */
     score: number;
+    /** The reasoning behind the match score, provided by the AI. */
     reasoning: string;
 }
 /**
- * Represents options for finding matches.
+ * Represents options for finding matches in the matchmaker system.
  * @category AI
  */
 export interface MmFindMatchesOptions {
-    /** Metadata filter conditions - defaults to none */
+    /** Optional metadata filter conditions to narrow down matching entities; defaults to none. */
     metadataFilter?: AiContextMetadataFilter;
-    /** The maximum number of matches to return - default: 100, max: 100 */
+    /** The maximum number of matches to return; defaults to 100, with a maximum of 100. */
     limit?: number;
-    /**
-     * The category to match the entities to - defaults to the next category provided in the matchmaker or the first one
-     * if there is no next.
-     */
+    /** The category ID to match entities against; defaults to the next or first category in the matchmaker. */
     matchToCategoryId?: string;
 }
 /**
- * Represents options for listing entities.
- * @category AI
+ * Represents options for listing entities in the matchmaker system.
+ - * @category AI
  */
 export interface MmListEntitiesOptions {
-    /** Metadata filter conditions - defaults to none */
+    /** Optional metadata filter conditions to narrow down listed entities; defaults to none. */
     metadataFilter?: AiContextMetadataFilter;
-    /** The maximum number of matches to return - default: 100 */
+    /** The maximum number of entities to return; defaults to 100. */
     limit?: number;
 }

package/dist/internal-common/src/public-types/api-client.public-types.d.ts

@@ -1,5 +1,9 @@
+/** Optional configuration for an API call, including headers, query, and path parameters. */
 export interface ApiOptions {
+    /** Headers to include in the API request. */
     headers?: Record<string, string | number | boolean>;
+    /** Query parameters to append to the API URL. */
     queryParams?: Record<string, string | number | boolean>;
+    /** Path parameters to substitute in the API URL. */
     pathParams?: Record<string, string | number | boolean>;
 }

package/dist/internal-common/src/public-types/backend.public-types.d.ts

@@ -1,13 +1,24 @@
 /** Backend related public types that should be available on the client SDK */
 /**
+ * A type alias for a service identifier.
  * @category Queue
  */
 export type TopicName = string;
+/** A type alias for a service class name. */
 export type ServiceName = string;
+/** A type alias for a function name within a service. */
 export type FunctionName = string;
-/** Function name with the contextual data. The data must be a serializable JSON. */
+/**
+ * Function name with contextual data, where the data must be serializable as JSON.
+ */
 export interface FunctionNameWithContext {
+    /** The name of the function within a service. */
     name: FunctionName;
+    /** A record of contextual data associated with the function call. */
     context: Record<string, unknown>;
 }
+/**
+ * A combined service and function name in the format 'ServiceName:FunctionName'.
+ * Uniquely identifies a function within a service.
+ */
 export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;

package/dist/internal-common/src/public-types/communication.public-types.d.ts

@@ -1,12 +1,18 @@
 /** A type alias for an application id. */
 export type AppId = string;
+/** A tuple of environment identifiers like 'dev' or 'prod'. */
 export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
+/** A type representing valid environment identifiers derived from ENVIRONMENT_IDS. */
 export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
+/** A type alias for a squid developer identifier. */
 export type SquidDeveloperId = string;
 /** A type alias for an integration id. */
 export type IntegrationId = string;
+/** A type alias for a client identifier. */
 export type ClientId = string;
+/** A type alias for a squid document identifier. */
 export type SquidDocId = string;
+/** A type alias for a client request identifier. */
 export type ClientRequestId = string;
 /** ID of AI agent. Also known as AI profile id. */
 export type AiAgentId = string;
@@ -16,6 +22,7 @@ export type AiAgentId = string;
  */
 export declare const BUILT_IN_AGENT_ID = "built_in_agent";
 /**
+ * A type alias for an AI context identifier.
  * @category AI
  */
 export type AiContextId = string;

package/dist/internal-common/src/public-types/context.public-types.d.ts

@@ -4,22 +4,29 @@ import { AppId, ClientId } from './communication.public-types';
  */
 export type AuthType = 'Bearer' | 'ApiKey';
 /**
- * The payload of a JWT token in case an auth token was used.
+ * The payload of a JWT token when Bearer authentication is used.
  * @category Auth
  */
 export interface AuthWithBearer {
+    /** Specifies the Bearer authentication type. */
     type: 'Bearer';
+    /** The unique identifier of the authenticated user. */
     userId: string;
+    /** The expiration timestamp of the token, in seconds. */
     expiration: number;
+    /** Additional attributes associated with the token. */
     attributes: Record<string, any>;
+    /** The raw JWT token string, if available. */
     jwt?: string;
 }
 /**
- * The authentication object for the current request in case an API key is used.
+ * The authentication object for the current request when an API key is used.
  * @category Auth
  */
 export interface AuthWithApiKey {
+    /** Specifies the API key authentication type. */
     type: 'ApiKey';
+    /** The API key string used for authentication. */
     apiKey: string;
 }
 /**
@@ -28,14 +35,18 @@ export interface AuthWithApiKey {
  */
 export type Auth = AuthWithBearer | AuthWithApiKey;
 /**
+ * Represents an authentication token with its type and associated details.
  * @category Auth
  */
 export interface AuthToken {
+    /** The type of authentication (e.g., 'Bearer' or 'ApiKey'). */
     type: AuthType;
+    /** The token string used for authentication. */
     token: string;
+    /** The ID of the integration associated with the token, if applicable. */
     integrationId?: string;
 }
-/** The context of a request to a service. */
+/** * The context of a request to a service, providing metadata about the request source. */
 export interface RunContext {
     /** Your applicationId. */
     appId: AppId;