@band-ai/rest-client 0.0.113 → 0.0.118

package/dist/esm/api/types/AgentMemoryCreateRequest.mjs

@@ -0,0 +1,31 @@
+// This file was auto-generated by Fern from our API Definition.
+export 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 || (AgentMemoryCreateRequest = {}));

package/dist/esm/api/types/AgentRegisterRequest.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Request to register an external agent
+ */
+export interface AgentRegisterRequest {
+    /** Agent Description */
+    description: string;
+    /** Agent Name */
+    name: string;
+}

package/dist/esm/api/types/AgentRegisterRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ChatEventMessageType.d.mts

@@ -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/esm/api/types/ChatEventMessageType.mjs

@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Type of chat event. Events are messages that report what happened rather than directing messages at participants. */
+export const 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/esm/api/types/ChatEventRequest.d.mts

@@ -0,0 +1,22 @@
+import type * as Band from "../index.mjs";
+/**
+ * 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/esm/api/types/ChatEventRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ChatMessage.d.mts

@@ -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/esm/api/types/ChatMessage.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ChatMessageRequest.d.mts

@@ -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/esm/api/types/ChatMessageRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ChatParticipant.d.mts

@@ -0,0 +1,25 @@
+import type * as Band from "../index.mjs";
+/**
+ * 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/esm/api/types/ChatParticipant.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ChatParticipant;
+(function (ChatParticipant) {
+    /** Participant type */
+    ChatParticipant.Type = {
+        User: "User",
+        Agent: "Agent",
+    };
+})(ChatParticipant || (ChatParticipant = {}));

package/dist/esm/api/types/ChatParticipantDetails.d.mts

@@ -0,0 +1,29 @@
+import type * as Band from "../index.mjs";
+/**
+ * A chat room participant with user/agent details (returned by list endpoint)
+ */
+export interface ChatParticipantDetails {
+    /** Agent description (for Agent participants) */
+    description?: string | undefined;
+    /** Participant handle (username for users, owner/slug for agents). Omitted if unavailable. */
+    handle?: string | undefined;
+    /** User UUID or Agent ID */
+    id: string;
+    /** Whether this is an external agent (for Agent participants) */
+    is_external?: boolean | undefined;
+    /** Display name */
+    name: string;
+    role: Band.ParticipantRole;
+    /** Participant status */
+    status: string;
+    /** Participant type */
+    type: ChatParticipantDetails.Type;
+}
+export declare namespace ChatParticipantDetails {
+    /** Participant type */
+    const Type: {
+        readonly User: "User";
+        readonly Agent: "Agent";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/esm/api/types/ChatParticipantDetails.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ChatParticipantDetails;
+(function (ChatParticipantDetails) {
+    /** Participant type */
+    ChatParticipantDetails.Type = {
+        User: "User",
+        Agent: "Agent",
+    };
+})(ChatParticipantDetails || (ChatParticipantDetails = {}));

package/dist/esm/api/types/ChatRoom.d.mts

@@ -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/esm/api/types/ChatRoom.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ChatRoomRequest.d.mts

@@ -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/esm/api/types/ChatRoomRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/Contact.d.mts

@@ -0,0 +1,41 @@
+/**
+ * A contact relationship
+ */
+export interface Contact {
+    /** Contact's user ID */
+    contact_id: string;
+    /** Contact entity type */
+    contact_type: Contact.ContactType;
+    /** Contact record ID */
+    id: string;
+    /** When contact was created */
+    inserted_at: string;
+    /** How the contact was created */
+    source?: "request" | undefined;
+    /** Contact status */
+    status: "active";
+    /** Contact's user details */
+    user?: Contact.User | undefined;
+}
+export declare namespace Contact {
+    /** Contact entity type */
+    const ContactType: {
+        readonly User: "User";
+        readonly Agent: "Agent";
+    };
+    type ContactType = (typeof ContactType)[keyof typeof ContactType];
+    /**
+     * Contact's user details
+     */
+    interface User {
+        email?: string | undefined;
+        handle?: string | undefined;
+        id?: string | undefined;
+        /** Whether listed in directory */
+        listed_in_directory?: boolean | undefined;
+        /** Display name */
+        name?: string | undefined;
+        /** Tags (agents only) */
+        tags?: string[] | undefined;
+    }
+}

package/dist/esm/api/types/Contact.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var Contact;
+(function (Contact) {
+    /** Contact entity type */
+    Contact.ContactType = {
+        User: "User",
+        Agent: "Agent",
+    };
+})(Contact || (Contact = {}));

package/dist/esm/api/types/ContactRequest.d.mts

@@ -0,0 +1,68 @@
+/**
+ * A contact request
+ */
+export interface ContactRequest {
+    /** Request ID */
+    id: string;
+    /** When request was created */
+    inserted_at: string;
+    /** Optional message (max 500 chars) */
+    message?: string | undefined;
+    /** Recipient's user details */
+    recipient?: ContactRequest.Recipient | undefined;
+    /** Recipient's user ID */
+    recipient_id: string;
+    /** Recipient entity type */
+    recipient_type?: ContactRequest.RecipientType | undefined;
+    /** Requester's user details */
+    requester?: ContactRequest.Requester | undefined;
+    /** Requester's user ID */
+    requester_id: string;
+    /** Requester entity type */
+    requester_type?: ContactRequest.RequesterType | undefined;
+    /** When request was responded to */
+    responded_at?: string | undefined;
+    /** Request status */
+    status: ContactRequest.Status;
+}
+export declare namespace ContactRequest {
+    /**
+     * Recipient's user details
+     */
+    interface Recipient {
+        handle?: string | undefined;
+        id?: string | undefined;
+        /** Display name */
+        name?: string | undefined;
+    }
+    /** Recipient entity type */
+    const RecipientType: {
+        readonly User: "User";
+        readonly Agent: "Agent";
+    };
+    type RecipientType = (typeof RecipientType)[keyof typeof RecipientType];
+    /**
+     * Requester's user details
+     */
+    interface Requester {
+        handle?: string | undefined;
+        id?: string | undefined;
+        /** Display name */
+        name?: string | undefined;
+    }
+    /** Requester entity type */
+    const RequesterType: {
+        readonly User: "User";
+        readonly Agent: "Agent";
+    };
+    type RequesterType = (typeof RequesterType)[keyof typeof RequesterType];
+    /** Request status */
+    const Status: {
+        readonly Pending: "pending";
+        readonly Approved: "approved";
+        readonly Rejected: "rejected";
+        readonly Expired: "expired";
+        readonly Cancelled: "cancelled";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/ContactRequest.mjs

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ContactRequest;
+(function (ContactRequest) {
+    /** Recipient entity type */
+    ContactRequest.RecipientType = {
+        User: "User",
+        Agent: "Agent",
+    };
+    /** Requester entity type */
+    ContactRequest.RequesterType = {
+        User: "User",
+        Agent: "Agent",
+    };
+    /** Request status */
+    ContactRequest.Status = {
+        Pending: "pending",
+        Approved: "approved",
+        Rejected: "rejected",
+        Expired: "expired",
+        Cancelled: "cancelled",
+    };
+})(ContactRequest || (ContactRequest = {}));

package/dist/esm/api/types/ContactRequestActionResponse.d.mts

@@ -0,0 +1,18 @@
+/**
+ * Response after approving, rejecting, or cancelling a contact request
+ */
+export interface ContactRequestActionResponse {
+    /** The request ID */
+    id: string;
+    /** The resulting status of the request */
+    status: ContactRequestActionResponse.Status;
+}
+export declare namespace ContactRequestActionResponse {
+    /** The resulting status of the request */
+    const Status: {
+        readonly Approved: "approved";
+        readonly Rejected: "rejected";
+        readonly Cancelled: "cancelled";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/ContactRequestActionResponse.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ContactRequestActionResponse;
+(function (ContactRequestActionResponse) {
+    /** The resulting status of the request */
+    ContactRequestActionResponse.Status = {
+        Approved: "approved",
+        Rejected: "rejected",
+        Cancelled: "cancelled",
+    };
+})(ContactRequestActionResponse || (ContactRequestActionResponse = {}));

package/dist/esm/api/types/Error_.d.mts

@@ -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/esm/api/types/Error_.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/EventCreatedResponse.d.mts

@@ -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/esm/api/types/EventCreatedResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/MeChatRoom.d.mts

@@ -0,0 +1,35 @@
+/**
+ * Human-API chat room — verbose shape. Includes `:type` and `:status` so the caller can render archive/active state and room kind without a follow-up fetch. Agent callers see the terse `ChatRoom` shape instead.
+ */
+export interface MeChatRoom {
+    /** Chat Room ID */
+    id: string;
+    /** Created At */
+    inserted_at: string;
+    /** Chat room status — `archived`/`active` round-trip via the archive/unarchive endpoints */
+    status?: MeChatRoom.Status | undefined;
+    /** Associated Task ID */
+    task_id?: string | undefined;
+    /** Chat room title */
+    title?: string | undefined;
+    /** Chat room type */
+    type?: MeChatRoom.Type | undefined;
+    /** Updated At */
+    updated_at: string;
+}
+export declare namespace MeChatRoom {
+    /** Chat room status — `archived`/`active` round-trip via the archive/unarchive endpoints */
+    const Status: {
+        readonly Active: "active";
+        readonly Archived: "archived";
+        readonly Closed: "closed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /** Chat room type */
+    const Type: {
+        readonly Direct: "direct";
+        readonly Group: "group";
+        readonly Task: "task";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/esm/api/types/MeChatRoom.mjs

@@ -0,0 +1,16 @@
+// This file was auto-generated by Fern from our API Definition.
+export var MeChatRoom;
+(function (MeChatRoom) {
+    /** Chat room status — `archived`/`active` round-trip via the archive/unarchive endpoints */
+    MeChatRoom.Status = {
+        Active: "active",
+        Archived: "archived",
+        Closed: "closed",
+    };
+    /** Chat room type */
+    MeChatRoom.Type = {
+        Direct: "direct",
+        Group: "group",
+        Task: "task",
+    };
+})(MeChatRoom || (MeChatRoom = {}));

package/dist/esm/api/types/MessageSentResponse.d.mts

@@ -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/esm/api/types/MessageSentResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/MessageStatusResponse.d.mts

@@ -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/esm/api/types/MessageStatusResponse.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var MessageStatusResponse;
+(function (MessageStatusResponse) {
+    /** New processing status */
+    MessageStatusResponse.Status = {
+        Processing: "processing",
+        Processed: "processed",
+        Failed: "failed",
+    };
+})(MessageStatusResponse || (MessageStatusResponse = {}));

package/dist/esm/api/types/MyAgent.d.mts

@@ -0,0 +1,29 @@
+/**
+ * An agent owned by the authenticated user
+ */
+export interface MyAgent {
+    /** Agent Description */
+    description?: string | undefined;
+    /** Agent ID */
+    id: string;
+    /** Created At */
+    inserted_at: string;
+    /** If the agent's reasoning loop runs externally */
+    is_external: boolean;
+    /** Whether listed in directory */
+    listed_in_directory?: boolean | undefined;
+    /** LLM Model Type */
+    model_type?: string | undefined;
+    /** Agent Name */
+    name: string;
+    /** Whether agent can discover all owner's agents */
+    registry_access?: boolean | undefined;
+    /** URL-safe agent handle */
+    slug?: string | undefined;
+    /** Currently-attached system prompt ID (mutate via /prompts sub-resource) */
+    system_prompt_id?: string | undefined;
+    /** Agent tags */
+    tags?: string[] | undefined;
+    /** Updated At */
+    updated_at: string;
+}

package/dist/esm/api/types/MyAgent.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};