@band-ai/rest-client 0.0.117 → 0.0.118

package/dist/cjs/api/resources/agentApiMessages/client/Client.js

@@ -366,35 +366,40 @@ class AgentApiMessagesClient {
         });
     }
     /**
-     * Marks a message processing as failed by the agent. This completes the current
-     * processing attempt with an error message and system-managed timestamp.
+     * Marks a message as being processed by the agent. This creates a new processing attempt
+     * with a system-managed timestamp. The agent must be a participant in the chat room.
      *
      * ## What It Does
      *
-     * - Sets the current attempt's completed_at timestamp (system-managed)
-     * - Sets the current attempt status to "failed"
-     * - Records the error message in the current attempt
-     * - Updates the agent's delivery status to "failed"
+     * - Creates a new attempt with auto-incremented attempt_number
+     * - Sets the attempt status to "processing"
+     * - Records the started_at timestamp (system-managed)
+     * - Updates the agent's delivery status to "processing"
      *
-     * ## Requirements
+     * ## Multiple Calls
      *
-     * **Requires an active processing attempt.** You must call `/processing` first.
-     * Returns 422 if no processing attempt exists.
+     * This endpoint can be called multiple times on the same message. Each call creates
+     * a **new attempt**. This is intentional for crash recovery:
      *
-     * ## After Calling
+     * 1. Agent calls `/processing` (attempt 1)
+     * 2. Agent crashes while processing
+     * 3. Agent restarts, calls `/next`, gets the same message back
+     * 4. Agent calls `/processing` again (attempt 2)
+     * 5. Agent completes processing, calls `/processed`
      *
-     * Failed messages remain available for retry. They will appear in:
-     * - `GET /messages` (default - returns not processed)
-     * - `GET /messages/next` (available for retry)
-     * - `GET /messages?status=failed`
-     * - `GET /messages?status=all`
+     * The attempts array in the message metadata tracks the full history.
      *
-     * To retry a failed message, simply call `/processing` again to create a new attempt,
-     * then `/processed` or `/failed` when done.
+     * ## Workflow
+     *
+     * Always call this endpoint before starting work on a message:
+     *
+     * 1. `GET /messages/next` → Get message
+     * 2. `POST /messages/{id}/processing` → **This endpoint**
+     * 3. Process the message
+     * 4. `POST /messages/{id}/processed` or `/failed`
      *
      * @param {string} chat_id - Chat Room ID
      * @param {string} id - Message ID
-     * @param {Band.MarkAgentMessageFailedRequest} request
      * @param {AgentApiMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Band.UnauthorizedError}
@@ -403,26 +408,21 @@ class AgentApiMessagesClient {
      * @throws {@link Band.UnprocessableEntityError}
      *
      * @example
-     *     await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
-     *         error: "error"
-     *     })
+     *     await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id")
      */
-    markAgentMessageFailed(chat_id, id, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__markAgentMessageFailed(chat_id, id, request, requestOptions));
+    markAgentMessageProcessing(chat_id, id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__markAgentMessageProcessing(chat_id, id, requestOptions));
     }
-    __markAgentMessageFailed(chat_id, id, request, requestOptions) {
+    __markAgentMessageProcessing(chat_id, id, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BandEnvironment.Default, `api/v1/agent/chats/${core.url.encodePathParam(chat_id)}/messages/${core.url.encodePathParam(id)}/failed`),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BandEnvironment.Default, `api/v1/agent/chats/${core.url.encodePathParam(chat_id)}/messages/${core.url.encodePathParam(id)}/processing`),
                 method: "POST",
                 headers: _headers,
-                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
-                requestType: "json",
-                body: request,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -430,7 +430,10 @@ class AgentApiMessagesClient {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -450,19 +453,19 @@ class AgentApiMessagesClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/api/v1/agent/chats/{chat_id}/messages/{id}/failed");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/api/v1/agent/chats/{chat_id}/messages/{id}/processing");
         });
     }
     /**
-     * Marks a message as successfully processed by the agent. This completes the current
-     * processing attempt with a system-managed timestamp.
+     * Marks a message processing as failed by the agent. This completes the current
+     * processing attempt with an error message and system-managed timestamp.
      *
      * ## What It Does
      *
      * - Sets the current attempt's completed_at timestamp (system-managed)
-     * - Sets the current attempt status to "success"
-     * - Sets the agent's processed_at timestamp (system-managed)
-     * - Updates the agent's delivery status to "processed"
+     * - Sets the current attempt status to "failed"
+     * - Records the error message in the current attempt
+     * - Updates the agent's delivery status to "failed"
      *
      * ## Requirements
      *
@@ -471,17 +474,18 @@ class AgentApiMessagesClient {
      *
      * ## After Calling
      *
-     * Once marked as processed, the message will no longer appear in:
+     * Failed messages remain available for retry. They will appear in:
      * - `GET /messages` (default - returns not processed)
-     * - `GET /messages/next`
-     * - `GET /messages?status=pending`
-     *
-     * It will only appear in:
-     * - `GET /messages?status=processed`
+     * - `GET /messages/next` (available for retry)
+     * - `GET /messages?status=failed`
      * - `GET /messages?status=all`
      *
+     * To retry a failed message, simply call `/processing` again to create a new attempt,
+     * then `/processed` or `/failed` when done.
+     *
      * @param {string} chat_id - Chat Room ID
      * @param {string} id - Message ID
+     * @param {Band.MarkAgentMessageFailedRequest} request
      * @param {AgentApiMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Band.UnauthorizedError}
@@ -490,21 +494,26 @@ class AgentApiMessagesClient {
      * @throws {@link Band.UnprocessableEntityError}
      *
      * @example
-     *     await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id")
+     *     await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
+     *         error: "error"
+     *     })
      */
-    markAgentMessageProcessed(chat_id, id, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__markAgentMessageProcessed(chat_id, id, requestOptions));
+    markAgentMessageFailed(chat_id, id, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__markAgentMessageFailed(chat_id, id, request, requestOptions));
     }
-    __markAgentMessageProcessed(chat_id, id, requestOptions) {
+    __markAgentMessageFailed(chat_id, id, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BandEnvironment.Default, `api/v1/agent/chats/${core.url.encodePathParam(chat_id)}/messages/${core.url.encodePathParam(id)}/processed`),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BandEnvironment.Default, `api/v1/agent/chats/${core.url.encodePathParam(chat_id)}/messages/${core.url.encodePathParam(id)}/failed`),
                 method: "POST",
                 headers: _headers,
+                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: request,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -535,41 +544,35 @@ class AgentApiMessagesClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/api/v1/agent/chats/{chat_id}/messages/{id}/processed");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/api/v1/agent/chats/{chat_id}/messages/{id}/failed");
         });
     }
     /**
-     * Marks a message as being processed by the agent. This creates a new processing attempt
-     * with a system-managed timestamp. The agent must be a participant in the chat room.
+     * Marks a message as successfully processed by the agent. This completes the current
+     * processing attempt with a system-managed timestamp.
      *
      * ## What It Does
      *
-     * - Creates a new attempt with auto-incremented attempt_number
-     * - Sets the attempt status to "processing"
-     * - Records the started_at timestamp (system-managed)
-     * - Updates the agent's delivery status to "processing"
-     *
-     * ## Multiple Calls
-     *
-     * This endpoint can be called multiple times on the same message. Each call creates
-     * a **new attempt**. This is intentional for crash recovery:
+     * - Sets the current attempt's completed_at timestamp (system-managed)
+     * - Sets the current attempt status to "success"
+     * - Sets the agent's processed_at timestamp (system-managed)
+     * - Updates the agent's delivery status to "processed"
      *
-     * 1. Agent calls `/processing` (attempt 1)
-     * 2. Agent crashes while processing
-     * 3. Agent restarts, calls `/next`, gets the same message back
-     * 4. Agent calls `/processing` again (attempt 2)
-     * 5. Agent completes processing, calls `/processed`
+     * ## Requirements
      *
-     * The attempts array in the message metadata tracks the full history.
+     * **Requires an active processing attempt.** You must call `/processing` first.
+     * Returns 422 if no processing attempt exists.
      *
-     * ## Workflow
+     * ## After Calling
      *
-     * Always call this endpoint before starting work on a message:
+     * Once marked as processed, the message will no longer appear in:
+     * - `GET /messages` (default - returns not processed)
+     * - `GET /messages/next`
+     * - `GET /messages?status=pending`
      *
-     * 1. `GET /messages/next` → Get message
-     * 2. `POST /messages/{id}/processing` → **This endpoint**
-     * 3. Process the message
-     * 4. `POST /messages/{id}/processed` or `/failed`
+     * It will only appear in:
+     * - `GET /messages?status=processed`
+     * - `GET /messages?status=all`
      *
      * @param {string} chat_id - Chat Room ID
      * @param {string} id - Message ID
@@ -581,18 +584,18 @@ class AgentApiMessagesClient {
      * @throws {@link Band.UnprocessableEntityError}
      *
      * @example
-     *     await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id")
+     *     await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id")
      */
-    markAgentMessageProcessing(chat_id, id, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__markAgentMessageProcessing(chat_id, id, requestOptions));
+    markAgentMessageProcessed(chat_id, id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__markAgentMessageProcessed(chat_id, id, requestOptions));
     }
-    __markAgentMessageProcessing(chat_id, id, requestOptions) {
+    __markAgentMessageProcessed(chat_id, id, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BandEnvironment.Default, `api/v1/agent/chats/${core.url.encodePathParam(chat_id)}/messages/${core.url.encodePathParam(id)}/processing`),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BandEnvironment.Default, `api/v1/agent/chats/${core.url.encodePathParam(chat_id)}/messages/${core.url.encodePathParam(id)}/processed`),
                 method: "POST",
                 headers: _headers,
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
@@ -626,7 +629,7 @@ class AgentApiMessagesClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/api/v1/agent/chats/{chat_id}/messages/{id}/processing");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/api/v1/agent/chats/{chat_id}/messages/{id}/processed");
         });
     }
 }

package/dist/cjs/api/resources/humanApiAgents/client/Client.d.ts

@@ -0,0 +1,107 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Band from "../../../index.js";
+export declare namespace HumanApiAgentsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Register and manage external agents owned by the user.
+ */
+export declare class HumanApiAgentsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<HumanApiAgentsClient.Options>;
+    constructor(options: HumanApiAgentsClient.Options);
+    /**
+     * Registers a new external agent and returns its API key.
+     *
+     * External agents run their own reasoning loop and connect to the platform
+     * to participate in chat rooms and execute tasks.
+     *
+     * **Important**: The API key is only shown once - store it securely.
+     *
+     * @param {Band.RegisterMyAgentRequest} request
+     * @param {HumanApiAgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Band.UnauthorizedError}
+     * @throws {@link Band.ForbiddenError}
+     * @throws {@link Band.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.humanApiAgents.registerMyAgent({
+     *         agent: {
+     *             description: "description",
+     *             name: "name"
+     *         }
+     *     })
+     */
+    registerMyAgent(request: Band.RegisterMyAgentRequest, requestOptions?: HumanApiAgentsClient.RequestOptions): core.HttpResponsePromise<Band.RegisterMyAgentResponse>;
+    private __registerMyAgent;
+    /**
+     * Returns a list of agents that you own (platform + external + your global agents).
+     *
+     * **Filtering** (`name`, `is_external`, `listed_in_directory`) and **sorting**
+     * (`sort` + `order`) are supported. `metadata.available_filters` and
+     * `metadata.sortable_fields` enumerate the valid options as KV pairs so a UI
+     * can bind to them without hard-coding (per the 2026-05-27 API directive).
+     *
+     * **Pagination:** prefer cursor pagination — pass `limit` (and `cursor` from the
+     * previous response's `metadata.next_cursor`). Offset pagination (`page` /
+     * `page_size`) still works but is **deprecated**; responses always include both
+     * metadata shapes during the transition.
+     *
+     * @param {Band.ListMyAgentsRequest} request
+     * @param {HumanApiAgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Band.UnauthorizedError}
+     * @throws {@link Band.ForbiddenError}
+     * @throws {@link Band.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.humanApiAgents.listMyAgents({
+     *         name: "name",
+     *         is_external: true,
+     *         listed_in_directory: true,
+     *         sort: "name",
+     *         order: "asc",
+     *         cursor: "cursor",
+     *         limit: 1,
+     *         page: 1,
+     *         page_size: 1
+     *     })
+     */
+    listMyAgents(request?: Band.ListMyAgentsRequest, requestOptions?: HumanApiAgentsClient.RequestOptions): core.HttpResponsePromise<Band.ListMyAgentsResponse>;
+    private __listMyAgents;
+    /**
+     * Deletes an agent that you own.
+     *
+     * **Default behavior**: Returns 422 if agent has execution history.
+     * This protects audit trails and task history.
+     *
+     * **Force deletion** (`?force=true`): Deletes all execution history first,
+     * then deletes the agent. Use with caution - this is irreversible.
+     *
+     * Deletion will:
+     * - Revoke the agent's API key
+     * - Remove the agent from all chat rooms (soft delete)
+     * - Delete associated memories and tool configurations
+     * - With `force=true`: Delete all execution history
+     *
+     * @param {string} id - Agent ID
+     * @param {Band.DeleteMyAgentRequest} request
+     * @param {HumanApiAgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Band.UnauthorizedError}
+     * @throws {@link Band.ForbiddenError}
+     * @throws {@link Band.NotFoundError}
+     * @throws {@link Band.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.humanApiAgents.deleteMyAgent("550e8400-e29b-41d4-a716-446655440000", {
+     *         force: true
+     *     })
+     */
+    deleteMyAgent(id: string, request?: Band.DeleteMyAgentRequest, requestOptions?: HumanApiAgentsClient.RequestOptions): core.HttpResponsePromise<Band.DeleteMyAgentResponse>;
+    private __deleteMyAgent;
+}