@amigo-ai/sdk 0.100.0 → 0.100.1

package/dist/types/index.d.ts

@@ -17,12 +17,17 @@ export interface AmigoSdkConfig {
     /** Retry configuration for HTTP requests */
     retry?: RetryOptions;
 }
+/**
+ * Main client for the Amigo API.
+ * Provides access to all API resources (organizations, conversations, services, users).
+ */
 export declare class AmigoClient {
     readonly organizations: OrganizationResource;
     readonly conversations: ConversationResource;
     readonly services: ServiceResource;
     readonly users: UserResource;
     readonly config: AmigoSdkConfig;
+    /** Create a new Amigo client with the given configuration. */
     constructor(config: AmigoSdkConfig);
 }
 export * as errors from './core/errors';

package/dist/types/resources/conversation.d.ts

@@ -2,10 +2,12 @@ import type { AmigoFetch } from '../core/openapi-client';
 import type { components, operations } from '../generated/api-types';
 type VoiceData = Blob | Uint8Array | ReadableStream<Uint8Array>;
 export type InteractionInput = string | VoiceData;
+/** Resource for managing conversations and interactions. */
 export declare class ConversationResource {
     private c;
     private orgId;
     constructor(c: AmigoFetch, orgId: string);
+    /** Create a new conversation and return an async stream of NDJSON events. */
     createConversation(body: components['schemas']['conversation__create_conversation__Request'], queryParams: operations['create-conversation']['parameters']['query'], headers?: operations['create-conversation']['parameters']['header'], options?: {
         signal?: AbortSignal;
     }): Promise<AsyncGenerator<{
@@ -32,6 +34,7 @@ export declare class ConversationResource {
         http_error_code: number;
         error_description: string;
     }, any, any>>;
+    /** Send a text or voice interaction and return an async stream of NDJSON events. */
     interactWithConversation(conversationId: string, input: InteractionInput, queryParams: operations['interact-with-conversation']['parameters']['query'], headers?: operations['interact-with-conversation']['parameters']['header'], options?: {
         signal?: AbortSignal;
     }): Promise<AsyncGenerator<{
@@ -59,22 +62,27 @@ export declare class ConversationResource {
         message_id: string;
         user_message: string;
     }, any, any>>;
+    /** List conversations, optionally filtered by query parameters. */
     getConversations(queryParams?: operations['get-conversations']['parameters']['query'], headers?: operations['get-conversations']['parameters']['header']): Promise<{
         conversations: components["schemas"]["ConversationInstance"][];
         has_more: boolean;
         continuation_token: number | null;
     }>;
+    /** Get messages for a conversation. */
     getConversationMessages(conversationId: string, queryParams?: operations['get-conversation-messages']['parameters']['query'], headers?: operations['get-conversation-messages']['parameters']['header']): Promise<{
         messages: components["schemas"]["MessageInstance"][];
         has_more: boolean;
         continuation_token: number | null;
     }>;
+    /** Finish (close) a conversation. */
     finishConversation(conversationId: string, headers?: operations['finish-conversation']['parameters']['header']): Promise<void>;
+    /** Get recommended responses for an interaction. */
     recommendResponsesForInteraction(conversationId: string, interactionId: string, body?: {
         context?: string;
     }, headers?: operations['recommend-responses-for-interaction']['parameters']['header']): Promise<{
         recommended_responses: string[];
     }>;
+    /** Get insights for an interaction. */
     getInteractionInsights(conversationId: string, interactionId: string, headers?: operations['get-interaction-insights']['parameters']['header']): Promise<{
         current_state_name: string;
         current_state_action: string;
@@ -86,7 +94,9 @@ export declare class ConversationResource {
         select_next_action_tool_call_logs: components["schemas"]["ToolCallLog"][][];
         engage_user_tool_call_logs: components["schemas"]["ToolCallLog"][][];
     }>;
+    /** Get the audio/media source URL for a message. */
     getMessageSource(conversationId: string, messageId: string, headers?: operations['retrieve-message-source']['parameters']['header']): Promise<{}>;
+    /** Generate conversation starter suggestions. */
     generateConversationStarters(body: components['schemas']['conversation__generate_conversation_starter__Request'], headers?: operations['generate-conversation-starter']['parameters']['header']): Promise<{
         prompts: components["schemas"]["Prompt"][];
     }>;

package/dist/types/resources/organization.d.ts

@@ -1,5 +1,6 @@
 import type { AmigoFetch } from '../core/openapi-client';
 import type { operations } from '../generated/api-types';
+/** Resource for retrieving organization details. */
 export declare class OrganizationResource {
     private c;
     private orgId;
@@ -16,6 +17,6 @@ export declare class OrganizationResource {
         main_description: string;
         sub_description: string;
         onboarding_instructions: string[];
-        default_user_preferences: import("..").components["schemas"]["amigo_lib__mongo__collections__user__User__Preferences"] | null;
+        default_user_preferences: import("..").components["schemas"]["Preferences-Output"] | null;
     }>;
 }

package/dist/types/resources/services.d.ts

@@ -1,5 +1,6 @@
 import type { AmigoFetch } from '../core/openapi-client';
 import type { operations } from '../generated/api-types';
+/** Resource for retrieving available services. */
 export declare class ServiceResource {
     private c;
     private orgId;

package/dist/types/resources/user.d.ts

@@ -1,19 +1,24 @@
 import type { AmigoFetch } from '../core/openapi-client';
 import type { components, operations } from '../generated/api-types';
+/** Resource for managing users in the organization. */
 export declare class UserResource {
     private c;
     private orgId;
     constructor(c: AmigoFetch, orgId: string);
+    /** List users in the organization. */
     getUsers(queryParams?: operations['get-users']['parameters']['query'], headers?: operations['get-users']['parameters']['header']): Promise<{
-        users: components["schemas"]["user__get_users__Response__UserInstance"][];
+        users: components["schemas"]["UserInstance"][];
         has_more: boolean;
         continuation_token: number | null;
     }>;
+    /** Create (invite) a new user to the organization. */
     createUser(body: components['schemas']['user__create_invited_user__Request'], headers?: operations['create-invited-user']['parameters']['header']): Promise<{
         user_id: string;
         verify_link: string | null;
     }>;
+    /** Delete a user by ID. */
     deleteUser(userId: string, headers?: operations['delete-user']['parameters']['header']): Promise<void>;
+    /** Update user information. */
     updateUser(userId: string, body: components['schemas']['user__update_user_info__Request'], headers?: operations['update-user-info']['parameters']['header']): Promise<void>;
     getUserModel(userId: string, headers?: operations['get-user-model']['parameters']['header']): Promise<{
         user_models: components["schemas"]["UserModel"][];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amigo-ai/sdk",
-  "version": "0.100.0",
+  "version": "0.100.1",
   "description": "Amigo TypeScript SDK",
   "publishConfig": {
     "access": "public"