@squidcloud/client 1.0.441 → 1.0.443

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

@@ -324,7 +324,7 @@ export interface AiAgentExecutionPlanOptions {
     /** Whether to enable an execution plan for the agent. */
     enabled: boolean;
     /** The model to use for the execution plan - defaults to the model used by the agent. */
-    model?: AiChatModelName;
+    model?: AiChatModelSelection;
     /** In case the model supports reasoning, this will control the level of effort - defaults to `high`. */
     reasoningEffort?: AiReasoningEffort;
     /**
@@ -557,7 +557,7 @@ export interface AnthropicChatOptions extends BaseAiChatOptions {
  * the type is inferred from the provided overrideModel (or falls back to BaseAiAgentChatOptions).
  * @category AI
  */
-export type AiChatOptions<T extends AiChatModelName | undefined = undefined> = T extends undefined ? BaseAiChatOptions | GeminiChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : T extends GrokChatModelName ? GrokChatOptions : never;
+export type AiChatOptions<T extends AiChatModelSelection | undefined = undefined> = T extends undefined ? BaseAiChatOptions | GeminiChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : T extends GrokChatModelName ? GrokChatOptions : BaseAiChatOptions;
 /**
  * @category AI
  */
@@ -568,7 +568,7 @@ export type AllAiAgentChatOptions = {
  * A definition of an AI agent with its properties and default chat options.
  * @category AI
  */
-export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
+export interface AiAgent<T extends AiChatModelSelection | undefined = undefined> {
     /** The unique identifier of the AI agent. */
     id: AiAgentId;
     /** The date and time the agent was created. */
@@ -773,7 +773,7 @@ export interface FileContextRequest extends BaseContextRequest {
     /** The minimum size for extracted images, if applicable. */
     imageMinSizePixels?: number;
     /** The AI model to use for extraction, if specified. */
-    extractionModel?: AiChatModelName;
+    extractionModel?: AiChatModelSelection;
     /** General options for how to process the file. */
     options?: AiContextFileOptions;
     /** The preferred method for extracting data from the document. */

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

@@ -1,5 +1,5 @@
-import { AgentContextRequest, UpsertContextStatusError } from './ai-agent.public-types';
-import { AiChatModelName, AiEmbeddingsModelName, AiRerankProvider } from './ai-common.public-types';
+import { AgentContextRequest, AiChatModelSelection, UpsertContextStatusError } from './ai-agent.public-types';
+import { AiEmbeddingsModelName, AiRerankProvider } from './ai-common.public-types';
 import { AiContextId, AiKnowledgeBaseId, AppId } from './communication.public-types';
 import { DocumentExtractionMethod } from './extraction.public-types';
 /**
@@ -18,7 +18,7 @@ export interface AiKnowledgeBase {
     /** The embedding model name that should be used for this knowledge base.*/
     embeddingModel: AiEmbeddingsModelName;
     /** The model name that should be used when asking questions of this knowledge base. */
-    chatModel: AiChatModelName;
+    chatModel: AiChatModelSelection;
     /** The timestamp the knowledge base was last updated */
     updatedAt: Date;
 }
@@ -125,7 +125,7 @@ export interface AiKnowledgeBaseChatOptions {
     /** How many chunks to look over. Defaults to 100 */
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
-    chatModel?: AiChatModelName;
+    chatModel?: AiChatModelSelection;
 }
 /**
  * @category AI
@@ -216,7 +216,7 @@ export interface AiKnowledgeBaseFileContextRequest extends BaseAiKnowledgeBaseCo
     /** The minimum size for extracted images, if applicable. */
     imageMinSizePixels?: number;
     /** The AI model to use for extraction, if specified. */
-    imageExtractionModel?: AiChatModelName;
+    imageExtractionModel?: AiChatModelSelection;
     /** General options for how to process the file. */
     options?: AiKnowledgeBaseContextFileOptions;
     /** The preferred method for extracting data from the document. */
@@ -262,7 +262,7 @@ export interface AiKnowledgeBaseSearchOptions {
     /** How many chunks to look over. Defaults to 100 */
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
-    chatModel?: string;
+    chatModel?: AiChatModelSelection;
 }
 /**
  * A single chunk of data returned from an AI search operation.
@@ -320,7 +320,7 @@ export interface BaseAiKnowledgeBaseSearchContextsRequest {
     /** Whether to rerank the results with AI and provide reasoning - defaults to true */
     rerank?: boolean;
     /** Which chat model to use when doing reranking */
-    chatModel?: string;
+    chatModel?: AiChatModelSelection;
 }
 /**
  * Request structure for searching AI contexts in the AiKnowledgeBase with prompt.

package/dist/internal-common/src/types/management-api-key.types.d.ts

@@ -46,10 +46,10 @@ export interface CreateManagementApiKeyRequest {
  * @category ManagementApiKey
  */
 export interface CreateManagementApiKeyResponse {
-    /** The created key with its value (only shown once) */
-    key: ManagementApiKey & {
-        keyValue: string;
-    };
+    /** The created key metadata */
+    key: ManagementApiKey;
+    /** The raw key value (only returned once during creation) */
+    keyValue: string;
 }
 /**
  * Request to update a management API key's status.

package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts

@@ -1,6 +1,5 @@
 import { Observable } from 'rxjs';
 import { AiAgent, AiChatMessage, AiChatModelSelection, AiConnectedAgentMetadata, AiStatusMessage, AiTranscribeAndAskResponse, AllAiAgentChatOptions, GuardrailsOptions, ListAgentRevisionsResponse, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
-import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
 import { JobId } from '../../../internal-common/src/public-types/job.public-types';
 import { Paths } from '../../../internal-common/src/public-types/typescript.public-types';
 import { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskResponse, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
@@ -96,7 +95,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    chat<T extends AiChatModelName | undefined>(prompt: string, options?: AiChatOptionsWithoutVoice<T>, jobId?: JobId): Observable<string>;
+    chat<T extends AiChatModelSelection | undefined>(prompt: string, options?: AiChatOptionsWithoutVoice<T>, jobId?: JobId): Observable<string>;
     /**
      * Transcribes the given file and performs a chat interaction.
      * @param fileToTranscribe The audio file to transcribe and send to the agent.
@@ -114,7 +113,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    ask<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
+    ask<T extends AiChatModelSelection | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
     /**
      * Sends a prompt and returns the string response and file annotations.
      * @param prompt The text prompt to send to the agent.
@@ -123,7 +122,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    askWithAnnotations<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<AskResponse>;
+    askWithAnnotations<T extends AiChatModelSelection | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<AskResponse>;
     /**
      * Sends a prompt and not wait for the result - the result can be tracked using the job ID
      * (`squid.jobs().awaitJob(jobId)` or `squid.jobs().getJob(jobId)).
@@ -134,7 +133,7 @@ export declare class AiAgentReference {
      to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
      * @param options Optional parameters for the AI ask request.
      */
-    askAsync<T extends AiChatModelName | undefined = undefined>(prompt: string, jobId: JobId, options?: AiAskOptions<T>): Promise<void>;
+    askAsync<T extends AiChatModelSelection | undefined = undefined>(prompt: string, jobId: JobId, options?: AiAskOptions<T>): Promise<void>;
     /**
      * Observes live status messages from the agent.
      * @param jobId The job ID to filter status updates for a specific job. If not provided, all status updates for the agent are observed.
@@ -153,7 +152,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    transcribeAndAsk<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptions<T>, jobId?: JobId): Promise<AiTranscribeAndAskResponse>;
+    transcribeAndAsk<T extends AiChatModelSelection | undefined>(fileToTranscribe: File, options?: AiAskOptions<T>, jobId?: JobId): Promise<AiTranscribeAndAskResponse>;
     /**
      * Transcribes audio and gets both text and voice response from the agent.
      * @param fileToTranscribe The audio file to transcribe and send to the agent.
@@ -162,7 +161,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    transcribeAndAskWithVoiceResponse<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<TranscribeAndAskWithVoiceResponse>;
+    transcribeAndAskWithVoiceResponse<T extends AiChatModelSelection | undefined>(fileToTranscribe: File, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<TranscribeAndAskWithVoiceResponse>;
     /**
      * Sends a prompt and gets both text and voice response from the agent.
      * @param prompt The text prompt to send to the agent.
@@ -171,7 +170,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    askWithVoiceResponse<T extends AiChatModelName | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<AskWithVoiceResponse>;
+    askWithVoiceResponse<T extends AiChatModelSelection | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<AskWithVoiceResponse>;
     /**
      * Sets a value at a specific path within the agent's options.
      */

package/dist/typescript-client/src/agent/ai-agent-client.types.d.ts

@@ -1,6 +1,5 @@
 import { Observable } from 'rxjs';
-import { AiAnnotation, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
-import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
+import { AiAnnotation, AiChatModelSelection, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
 /**
  * Response format for transcribing audio and generating a chat response.
  * Contains the transcribed text and a stream of AI-generated responses.
@@ -50,20 +49,20 @@ export interface AskWithVoiceResponse {
  * Chat options that exclude voice-specific configurations.
  * @category AI
  */
-export type AiChatOptionsWithoutVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions'> & {
+export type AiChatOptionsWithoutVoice<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions'> & {
     model?: T;
 };
 /**
  * Options for AI-generated responses that exclude voice-specific settings and smooth typing behavior.
  * @category AI
  */
-export type AiAskOptions<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions' | 'smoothTyping'> & {
+export type AiAskOptions<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions' | 'smoothTyping'> & {
     model?: T;
 };
 /**
  * Options for AI-generated responses that include voice-specific settings but excludes smooth typing.
  * @category AI
  */
-export type AiAskOptionsWithVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'smoothTyping'> & {
+export type AiAskOptionsWithVoice<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'smoothTyping'> & {
     model?: T;
 };

package/dist/typescript-client/src/management-client.d.ts

@@ -7,7 +7,7 @@ export interface ManagementClientOptions {
     /** The management API key (starts with 'squid_mgmt_') */
     apiKey: string;
     /** The Squid region to connect to */
-    region: SquidRegion;
+    consoleRegion: SquidRegion;
 }
 /**
  * Request to create a new organization.
@@ -44,14 +44,30 @@ export interface ManagementCreateApplicationRequest {
 export interface ManagementCreateApplicationResponse {
     /** The ID of the created application */
     appId: string;
+    /** The API key for the dev environment */
+    devApiKey: string;
+    /** The API key for the prod environment */
+    prodApiKey: string;
+}
+/**
+ * Request to rename an organization.
+ * @category ManagementClient
+ */
+export interface ManagementRenameOrganizationRequest {
+    /** The ID of the organization to rename */
+    organizationId: string;
+    /** New name for the organization (2-50 characters) */
+    name: string;
 }
 /**
- * Request to delete an application.
+ * Request to rename an application.
  * @category ManagementClient
  */
-export interface ManagementDeleteApplicationRequest {
-    /** The ID of the application to delete */
+export interface ManagementRenameApplicationRequest {
+    /** The ID of the application to rename */
     appId: string;
+    /** New name for the application */
+    name: string;
 }
 /**
  * Client for programmatic management of Squid organizations and applications.
@@ -77,14 +93,14 @@ export interface ManagementDeleteApplicationRequest {
  * });
  *
  * // Delete an application
- * await client.deleteApplication({ appId });
+ * await client.deleteApplication('my-app-id');
  * ```
  *
  * @category ManagementClient
  */
 export declare class ManagementClient {
     private readonly apiKey;
-    private readonly region;
+    private readonly consoleRegion;
     /**
      * Creates a new ManagementClient.
      *
@@ -106,7 +122,7 @@ export declare class ManagementClient {
      * Requires the user to be an admin in the target organization.
      *
      * @param request - The application creation request
-     * @returns The created application's ID
+     * @returns The created application's ID and API keys
      * @throws Error if user is not admin or organization quota reached
      */
     createApplication(request: ManagementCreateApplicationRequest): Promise<ManagementCreateApplicationResponse>;
@@ -114,8 +130,24 @@ export declare class ManagementClient {
      * Deletes an application.
      * Requires the user to be an admin in the application's organization.
      *
-     * @param request - The application deletion request
+     * @param appId - The ID of the application to delete
+     * @throws Error if user is not admin or application not found
+     */
+    deleteApplication(appId: string): Promise<void>;
+    /**
+     * Renames an organization.
+     * Requires the user to be an admin in the organization.
+     *
+     * @param request - The rename request containing organizationId and new name
+     * @throws Error if user is not admin or organization not found
+     */
+    renameOrganization(request: ManagementRenameOrganizationRequest): Promise<void>;
+    /**
+     * Renames an application.
+     * Requires the user to be an admin in the application's organization.
+     *
+     * @param request - The rename request containing appId and new name
      * @throws Error if user is not admin or application not found
      */
-    deleteApplication(request: ManagementDeleteApplicationRequest): Promise<void>;
+    renameApplication(request: ManagementRenameApplicationRequest): Promise<void>;
 }

package/dist/typescript-client/src/squid.d.ts

@@ -149,6 +149,8 @@ export declare class Squid {
      * Returns the application ID of the current Squid instance.
      */
     get appId(): AppId;
+    /** Set to true if the client was destructured. */
+    get isDestructed(): boolean;
     /**
      * Returns the global Squid instance with the given options, creating a new instance if one with the same options
      * does not exist.
@@ -379,8 +381,6 @@ export declare class Squid {
      * @returns A promise that resolves when the destruct process is complete.
      */
     destruct(): Promise<void>;
-    /** Set to true if the client was destructured. */
-    get isDestructed(): boolean;
     /** Provides information about the connection to the Squid Server. */
     connectionDetails(): ConnectionDetails;
     /** Returns the notification client for handling (publishing and receiving) custom messages. */

package/dist/typescript-client/src/version.d.ts

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.441";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.443";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.441",
+  "version": "1.0.443",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",