@band-ai/rest-client 0.0.113 → 0.0.117

package/dist/cjs/api/types/AgentMemory.d.ts

@@ -0,0 +1,71 @@
+/**
+ * A memory entry stored by an agent
+ */
+export interface AgentMemory {
+    /** The memory content */
+    content: string;
+    /** Memory ID */
+    id: string;
+    /** When the memory was created */
+    inserted_at: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown> | undefined;
+    /** Organization this memory belongs to */
+    organization_id?: string | undefined;
+    /** Visibility scope of the memory */
+    scope: AgentMemory.Scope;
+    /** Logical segment of the memory */
+    segment: AgentMemory.Segment;
+    /** UUID of the agent that stored this memory */
+    source_agent_id?: string | undefined;
+    /** Memory lifecycle status */
+    status?: AgentMemory.Status | undefined;
+    /** UUID of the subject this memory is about (user or agent) */
+    subject_id?: string | undefined;
+    /** Memory system tier */
+    system: AgentMemory.System;
+    /** Agent's reasoning for storing this memory */
+    thought?: string | undefined;
+    /** Memory type within the system */
+    type: AgentMemory.Type;
+}
+export declare namespace AgentMemory {
+    /** Visibility scope of the memory */
+    const Scope: {
+        readonly Subject: "subject";
+        readonly Organization: "organization";
+    };
+    type Scope = (typeof Scope)[keyof typeof Scope];
+    /** Logical segment of the memory */
+    const Segment: {
+        readonly User: "user";
+        readonly Agent: "agent";
+        readonly Tool: "tool";
+        readonly Guideline: "guideline";
+    };
+    type Segment = (typeof Segment)[keyof typeof Segment];
+    /** Memory lifecycle status */
+    const Status: {
+        readonly Active: "active";
+        readonly Superseded: "superseded";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /** Memory system tier */
+    const System: {
+        readonly Sensory: "sensory";
+        readonly Working: "working";
+        readonly LongTerm: "long_term";
+    };
+    type System = (typeof System)[keyof typeof System];
+    /** Memory type within the system */
+    const Type: {
+        readonly Iconic: "iconic";
+        readonly Echoic: "echoic";
+        readonly Haptic: "haptic";
+        readonly Episodic: "episodic";
+        readonly Semantic: "semantic";
+        readonly Procedural: "procedural";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/AgentMemory.js

@@ -0,0 +1,40 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentMemory = void 0;
+var AgentMemory;
+(function (AgentMemory) {
+    /** Visibility scope of the memory */
+    AgentMemory.Scope = {
+        Subject: "subject",
+        Organization: "organization",
+    };
+    /** Logical segment of the memory */
+    AgentMemory.Segment = {
+        User: "user",
+        Agent: "agent",
+        Tool: "tool",
+        Guideline: "guideline",
+    };
+    /** Memory lifecycle status */
+    AgentMemory.Status = {
+        Active: "active",
+        Superseded: "superseded",
+        Archived: "archived",
+    };
+    /** Memory system tier */
+    AgentMemory.System = {
+        Sensory: "sensory",
+        Working: "working",
+        LongTerm: "long_term",
+    };
+    /** Memory type within the system */
+    AgentMemory.Type = {
+        Iconic: "iconic",
+        Echoic: "echoic",
+        Haptic: "haptic",
+        Episodic: "episodic",
+        Semantic: "semantic",
+        Procedural: "procedural",
+    };
+})(AgentMemory || (exports.AgentMemory = AgentMemory = {}));

package/dist/cjs/api/types/AgentMemoryCreateRequest.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Request to create a new memory
+ */
+export interface AgentMemoryCreateRequest {
+    /** The memory content */
+    content: string;
+    /** Additional metadata (tags, references, etc.) */
+    metadata?: AgentMemoryCreateRequest.Metadata | undefined;
+    /** Visibility: subject (cross-agent, about this subject) or organization (all agents) */
+    scope?: AgentMemoryCreateRequest.Scope | undefined;
+    /** Logical segment */
+    segment: AgentMemoryCreateRequest.Segment;
+    /** UUID of the subject this memory is about. Required for subject scope. */
+    subject_id?: string | undefined;
+    /** Memory system tier */
+    system: AgentMemoryCreateRequest.System;
+    /** Agent's reasoning for storing this memory */
+    thought: string;
+    /** Memory type (must be valid for selected system) */
+    type: AgentMemoryCreateRequest.Type;
+}
+export declare namespace AgentMemoryCreateRequest {
+    /**
+     * Additional metadata (tags, references, etc.)
+     */
+    interface Metadata {
+        /** Related memory IDs */
+        references?: string[] | undefined;
+        /** Tags for categorization */
+        tags?: string[] | undefined;
+    }
+    /** Visibility: subject (cross-agent, about this subject) or organization (all agents) */
+    const Scope: {
+        readonly Subject: "subject";
+        readonly Organization: "organization";
+    };
+    type Scope = (typeof Scope)[keyof typeof Scope];
+    /** Logical segment */
+    const Segment: {
+        readonly User: "user";
+        readonly Agent: "agent";
+        readonly Tool: "tool";
+        readonly Guideline: "guideline";
+    };
+    type Segment = (typeof Segment)[keyof typeof Segment];
+    /** Memory system tier */
+    const System: {
+        readonly Sensory: "sensory";
+        readonly Working: "working";
+        readonly LongTerm: "long_term";
+    };
+    type System = (typeof System)[keyof typeof System];
+    /** Memory type (must be valid for selected system) */
+    const Type: {
+        readonly Iconic: "iconic";
+        readonly Echoic: "echoic";
+        readonly Haptic: "haptic";
+        readonly Episodic: "episodic";
+        readonly Semantic: "semantic";
+        readonly Procedural: "procedural";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/AgentMemoryCreateRequest.js

@@ -0,0 +1,34 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentMemoryCreateRequest = void 0;
+var AgentMemoryCreateRequest;
+(function (AgentMemoryCreateRequest) {
+    /** Visibility: subject (cross-agent, about this subject) or organization (all agents) */
+    AgentMemoryCreateRequest.Scope = {
+        Subject: "subject",
+        Organization: "organization",
+    };
+    /** Logical segment */
+    AgentMemoryCreateRequest.Segment = {
+        User: "user",
+        Agent: "agent",
+        Tool: "tool",
+        Guideline: "guideline",
+    };
+    /** Memory system tier */
+    AgentMemoryCreateRequest.System = {
+        Sensory: "sensory",
+        Working: "working",
+        LongTerm: "long_term",
+    };
+    /** Memory type (must be valid for selected system) */
+    AgentMemoryCreateRequest.Type = {
+        Iconic: "iconic",
+        Echoic: "echoic",
+        Haptic: "haptic",
+        Episodic: "episodic",
+        Semantic: "semantic",
+        Procedural: "procedural",
+    };
+})(AgentMemoryCreateRequest || (exports.AgentMemoryCreateRequest = AgentMemoryCreateRequest = {}));

package/dist/cjs/api/types/ChatEventMessageType.d.ts

@@ -0,0 +1,19 @@
+/** Type of chat event. Events are messages that report what happened rather than directing messages at participants. */
+export declare const ChatEventMessageType: {
+    /**
+     * Agent is invoking a tool. Metadata contains function name and arguments. */
+    readonly ToolCall: "tool_call";
+    /**
+     * Result returned from a tool execution. Metadata contains the result data. */
+    readonly ToolResult: "tool_result";
+    /**
+     * Agent's internal reasoning or thinking process. */
+    readonly Thought: "thought";
+    /**
+     * Error message or failure notification. Metadata can contain error details. */
+    readonly Error: "error";
+    /**
+     * Task-related message or status update. */
+    readonly Task: "task";
+};
+export type ChatEventMessageType = (typeof ChatEventMessageType)[keyof typeof ChatEventMessageType];

package/dist/cjs/api/types/ChatEventMessageType.js

@@ -0,0 +1,22 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatEventMessageType = void 0;
+/** Type of chat event. Events are messages that report what happened rather than directing messages at participants. */
+exports.ChatEventMessageType = {
+    /**
+     * Agent is invoking a tool. Metadata contains function name and arguments. */
+    ToolCall: "tool_call",
+    /**
+     * Result returned from a tool execution. Metadata contains the result data. */
+    ToolResult: "tool_result",
+    /**
+     * Agent's internal reasoning or thinking process. */
+    Thought: "thought",
+    /**
+     * Error message or failure notification. Metadata can contain error details. */
+    Error: "error",
+    /**
+     * Task-related message or status update. */
+    Task: "task",
+};

package/dist/cjs/api/types/ChatEventRequest.d.ts

@@ -0,0 +1,22 @@
+import type * as Band from "../index.js";
+/**
+ * Request to create a chat event.
+ *
+ * For **tool_call**: `content` is a human-readable description, `metadata` contains the function call details.
+ * For **tool_result**: `content` is a human-readable summary, `metadata` contains the structured result.
+ * For **thought**: `content` is the agent's reasoning text.
+ * For **error**: `content` is the error message, `metadata` can contain error details.
+ * For **task**: `content` is the task-related message.
+ */
+export interface ChatEventRequest {
+    /** Human-readable event content */
+    content: string;
+    message_type: Band.ChatEventMessageType;
+    /**
+     * Structured data for the event. Contents vary by message_type:
+     * - tool_call: {function: {name, arguments}, id, type}
+     * - tool_result: {success, message, ...result data}
+     * - error: {error_code, details}
+     */
+    metadata?: Record<string, unknown> | undefined;
+}

package/dist/cjs/api/types/ChatEventRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ChatMessage.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A chat message
+ */
+export interface ChatMessage {
+    /** Chat Room ID */
+    chat_room_id?: string | undefined;
+    /** Message content */
+    content: string;
+    /** Message ID */
+    id: string;
+    /** Created At */
+    inserted_at?: string | undefined;
+    /** Message type */
+    message_type: string;
+    /** Additional metadata including mentions */
+    metadata?: Record<string, unknown> | undefined;
+    /** Sender ID */
+    sender_id: string;
+    /** Display name of sender (full name for Users, name for Agents) */
+    sender_name?: string | undefined;
+    /** Sender type (User or Agent) */
+    sender_type: string;
+    /** Updated At */
+    updated_at?: string | undefined;
+}

package/dist/cjs/api/types/ChatMessage.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ChatMessageRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Request to create a text message. For other message types (tool_call, tool_result, thought, etc.), use the /events endpoint.
+ */
+export interface ChatMessageRequest {
+    /** Message content with @mentions for recipients (e.g. '@DataAnalyst please analyze this'). Each mentioned handle must have a corresponding entry in the mentions array. If a mentioned user is not @-referenced in the content, it will be prepended automatically. */
+    content: string;
+    /** List of mentioned users (required). Each mentioned user in the content must have a corresponding entry here. */
+    mentions: ChatMessageRequest.Mentions.Item[];
+}
+export declare namespace ChatMessageRequest {
+    type Mentions = Mentions.Item[];
+    namespace Mentions {
+        interface Item {
+            /** Handle for the mention (user handle or owner/slug for agents) */
+            handle?: string | undefined;
+            /** Mentioned user/agent ID */
+            id: string;
+            /** Display name as it appears in the content (without @ prefix) */
+            name?: string | undefined;
+        }
+    }
+}

package/dist/cjs/api/types/ChatMessageRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ChatParticipant.d.ts

@@ -0,0 +1,25 @@
+import type * as Band from "../index.js";
+/**
+ * A chat room participant
+ */
+export interface ChatParticipant {
+    /** Participant handle (username for users, owner/slug for agents). Omitted if unavailable. */
+    handle?: string | undefined;
+    /** Participant ID (User UUID or Agent ID) */
+    id: string;
+    /** Participant display name */
+    name?: string | undefined;
+    role: Band.ParticipantRole;
+    /** Participant status */
+    status: string;
+    /** Participant type */
+    type: ChatParticipant.Type;
+}
+export declare namespace ChatParticipant {
+    /** Participant type */
+    const Type: {
+        readonly User: "User";
+        readonly Agent: "Agent";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/ChatParticipant.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatParticipant = void 0;
+var ChatParticipant;
+(function (ChatParticipant) {
+    /** Participant type */
+    ChatParticipant.Type = {
+        User: "User",
+        Agent: "Agent",
+    };
+})(ChatParticipant || (exports.ChatParticipant = ChatParticipant = {}));

package/dist/cjs/api/types/ChatRoom.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A chat room
+ */
+export interface ChatRoom {
+    /** Chat Room ID */
+    id: string;
+    /** Created At */
+    inserted_at: string;
+    /** Associated Task ID */
+    task_id?: string | undefined;
+    /** Chat room title */
+    title?: string | undefined;
+    /** Updated At */
+    updated_at: string;
+}

package/dist/cjs/api/types/ChatRoom.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ChatRoomRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Request to create a chat room. Status defaults to 'active'. Type defaults to 'direct'. The owner is automatically set to the authenticated user or agent.
+ */
+export interface ChatRoomRequest {
+    /** Associated task ID (optional) */
+    task_id?: string | undefined;
+    /** Optional title for the chat room. If provided and non-blank after trimming, the room is marked title_locked: true and LLM auto-titling is skipped. Empty/whitespace-only/null falls through to the default and LLM auto-titles on the first message. Control characters (newline, carriage return, null) are rejected with 422. Max 120 chars. Note: agent callers can set this at creation but cannot rename later — the rename endpoint is /me-scoped and human-owner-only. */
+    title?: string | undefined;
+}

package/dist/cjs/api/types/ChatRoomRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/Error_.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Standard error response with request ID for tracing
+ */
+export interface Error_ {
+    error: Error_.Error_;
+}
+export declare namespace Error_ {
+    interface Error_ {
+        /** Machine-readable error code */
+        code: string;
+        /** Additional error details (optional) */
+        details?: Record<string, unknown> | undefined;
+        /** Human-readable error message */
+        message: string;
+        /** Unique request identifier for tracing and debugging */
+        request_id: string;
+    }
+}

package/dist/cjs/api/types/Error_.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/EventCreatedResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Response after creating an event.
+ */
+export interface EventCreatedResponse {
+    /** ID of the created event */
+    id: string;
+    /** Type of event recorded */
+    message_type: string;
+    /** Whether the event was created successfully */
+    success: boolean;
+}

package/dist/cjs/api/types/EventCreatedResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MessageSentResponse.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Minimal response after sending a message. Contains only essential fields to confirm delivery.
+ */
+export interface MessageSentResponse {
+    /** ID of the created message */
+    id: string;
+    /** List of participants who will receive the message */
+    recipients: MessageSentResponse.Recipients.Item[];
+    /** Whether the message was sent successfully */
+    success: boolean;
+}
+export declare namespace MessageSentResponse {
+    type Recipients = Recipients.Item[];
+    namespace Recipients {
+        interface Item {
+            /** Recipient handle */
+            handle: string;
+            /** Recipient ID */
+            id: string;
+            /** Recipient display name (optional) */
+            name?: string | undefined;
+        }
+    }
+}

package/dist/cjs/api/types/MessageSentResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MessageStatusResponse.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Minimal response after updating message processing status.
+ */
+export interface MessageStatusResponse {
+    /** Current attempt number */
+    attempt_number: number;
+    /** ID of the message */
+    id: string;
+    /** New processing status */
+    status: MessageStatusResponse.Status;
+    /** Whether the status was updated successfully */
+    success: boolean;
+}
+export declare namespace MessageStatusResponse {
+    /** New processing status */
+    const Status: {
+        readonly Processing: "processing";
+        readonly Processed: "processed";
+        readonly Failed: "failed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/MessageStatusResponse.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageStatusResponse = void 0;
+var MessageStatusResponse;
+(function (MessageStatusResponse) {
+    /** New processing status */
+    MessageStatusResponse.Status = {
+        Processing: "processing",
+        Processed: "processed",
+        Failed: "failed",
+    };
+})(MessageStatusResponse || (exports.MessageStatusResponse = MessageStatusResponse = {}));

package/dist/cjs/api/types/ParticipantRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Request to add a participant to a chat room
+ */
+export interface ParticipantRequest {
+    /** Participant ID (User UUID or Agent ID) */
+    participant_id: string;
+    /** Participant role */
+    role?: ParticipantRequest.Role | undefined;
+}
+export declare namespace ParticipantRequest {
+    /** Participant role */
+    const Role: {
+        readonly Owner: "owner";
+        readonly Admin: "admin";
+        readonly Member: "member";
+    };
+    type Role = (typeof Role)[keyof typeof Role];
+}

package/dist/cjs/api/types/ParticipantRequest.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParticipantRequest = void 0;
+var ParticipantRequest;
+(function (ParticipantRequest) {
+    /** Participant role */
+    ParticipantRequest.Role = {
+        Owner: "owner",
+        Admin: "admin",
+        Member: "member",
+    };
+})(ParticipantRequest || (exports.ParticipantRequest = ParticipantRequest = {}));

package/dist/cjs/api/types/ParticipantRole.d.ts

@@ -0,0 +1,13 @@
+/** Role of a participant in a chat room. Determines permissions and capabilities. */
+export declare const ParticipantRole: {
+    /**
+     * Full control over the chat room. Can manage participants and settings. */
+    readonly Owner: "owner";
+    /**
+     * Can manage participants but not room settings. */
+    readonly Admin: "admin";
+    /**
+     * Can send messages and view chat history. */
+    readonly Member: "member";
+};
+export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantRole];

package/dist/cjs/api/types/ParticipantRole.js

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParticipantRole = void 0;
+/** Role of a participant in a chat room. Determines permissions and capabilities. */
+exports.ParticipantRole = {
+    /**
+     * Full control over the chat room. Can manage participants and settings. */
+    Owner: "owner",
+    /**
+     * Can manage participants but not room settings. */
+    Admin: "admin",
+    /**
+     * Can send messages and view chat history. */
+    Member: "member",
+};

package/dist/cjs/api/types/Peer.d.ts

@@ -0,0 +1,39 @@
+/**
+ * An entity available for interaction in chat rooms (user or agent)
+ */
+export interface Peer {
+    /** Description (for agents) */
+    description?: string | undefined;
+    /** Handle without @ prefix (user handle or owner/slug for agents) */
+    handle: string;
+    /** Entity ID (User UUID or Agent ID) */
+    id: string;
+    /** Whether this peer is also in the agent's contacts */
+    is_contact: boolean;
+    /** Whether this is an external agent */
+    is_external?: boolean | undefined;
+    /** Whether listed in directory */
+    listed_in_directory?: boolean | undefined;
+    /** Display name */
+    name: string;
+    /** How the peer was discovered (registry = owner/sibling/global, contact = from contacts) */
+    source: Peer.Source;
+    /** Tags (agents only) */
+    tags?: string[] | undefined;
+    /** Entity type */
+    type: Peer.Type;
+}
+export declare namespace Peer {
+    /** How the peer was discovered (registry = owner/sibling/global, contact = from contacts) */
+    const Source: {
+        readonly Registry: "registry";
+        readonly Contact: "contact";
+    };
+    type Source = (typeof Source)[keyof typeof Source];
+    /** Entity type */
+    const Type: {
+        readonly User: "User";
+        readonly Agent: "Agent";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/Peer.js

@@ -0,0 +1,17 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Peer = void 0;
+var Peer;
+(function (Peer) {
+    /** How the peer was discovered (registry = owner/sibling/global, contact = from contacts) */
+    Peer.Source = {
+        Registry: "registry",
+        Contact: "contact",
+    };
+    /** Entity type */
+    Peer.Type = {
+        User: "User",
+        Agent: "Agent",
+    };
+})(Peer || (exports.Peer = Peer = {}));