@or-sdk/hitl 0.36.3-beta.4070.0 → 0.36.3

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.36.3](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/hitl@0.36.2...@or-sdk/hitl@0.36.3) (2026-04-01)
+
+
+### Bug Fixes
+
+* **hitl:** param for reopen hitl session query ([833a728](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/833a728c3b9059b2f941c63bc5770ad791524dfc))
+
+
+
 ## [0.36.2](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/hitl@0.36.1...@or-sdk/hitl@0.36.2) (2026-03-31)
 
 

package/dist/types/HITL.d.ts

@@ -2,6 +2,13 @@ import { AxiosError, Base } from '@or-sdk/base';
 import { Migrations, Settings, Agents, RuleGroups, ContactRuleGroups, EventTemplates, Conferences, Filters, CannedMessages, Sessions, SessionEvents, Listeners, Commands, ContactsMeta, Helpers, Versions, Tasks, SessionRelations, Contacts } from './api';
 import { AppError } from './AppError';
 import { HITLConfig, AppErrorObject } from './types';
+/**
+ * OneReach HitL service client
+ *  ## Installation:
+ * ```
+ * $ npm i @or-sdk/hitl
+ * ```
+ */
 export declare class HITL extends Base {
     readonly migrations: typeof Migrations;
     readonly settings: typeof Settings;
@@ -22,6 +29,12 @@ export declare class HITL extends Base {
     readonly tasks: typeof Tasks;
     readonly sessionRelations: typeof SessionRelations;
     readonly contacts: typeof Contacts;
+    /**
+     * ```typescript
+     * import { HITL } from '@or-sdk/hitl'
+     * const hitlApi = new HITL({token: 'my-account-token-string', discoveryUrl: 'http://example.hitl/endpoint'});
+     * ```
+     */
     constructor(params: HITLConfig);
     parseError(e: AxiosError<AppErrorObject>): AppError;
 }

package/dist/types/HITL.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HITL.d.ts","sourceRoot":"","sources":["../../src/HITL.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EACL,UAAU,EACV,QAAQ,EACR,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,WAAW,EACX,OAAO,EACP,cAAc,EACd,QAAQ,EACR,aAAa,EACb,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,KAAK,EACL,gBAAgB,EAChB,QAAQ,EACT,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AASrD,qBAAa,IAAK,SAAQ,IAAI;IAC5B,SAAgB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9C,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,MAAM,EAAE,OAAO,MAAM,CAAC;IACtC,SAAgB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9C,SAAgB,iBAAiB,EAAE,OAAO,iBAAiB,CAAC;IAC5D,SAAgB,cAAc,EAAE,OAAO,cAAc,CAAC;IACtD,SAAgB,WAAW,EAAE,OAAO,WAAW,CAAC;IAChD,SAAgB,OAAO,EAAE,OAAO,OAAO,CAAC;IACxC,SAAgB,cAAc,EAAE,OAAO,cAAc,CAAC;IACtD,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,aAAa,EAAE,OAAO,aAAa,CAAC;IACpD,SAAgB,SAAS,EAAE,OAAO,SAAS,CAAC;IAC5C,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,OAAO,EAAE,OAAO,OAAO,CAAC;IACxC,SAAgB,YAAY,EAAE,OAAO,YAAY,CAAC;IAClD,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,KAAK,EAAE,OAAO,KAAK,CAAC;IACpC,SAAgB,gBAAgB,EAAE,OAAO,gBAAgB,CAAC;IAC1D,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;gBAQ9B,MAAM,EAAE,UAAU;IA+BvB,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,GAAG,QAAQ;CAG3D;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"HITL.d.ts","sourceRoot":"","sources":["../../src/HITL.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EACL,UAAU,EACV,QAAQ,EACR,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,WAAW,EACX,OAAO,EACP,cAAc,EACd,QAAQ,EACR,aAAa,EACb,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,KAAK,EACL,gBAAgB,EAChB,QAAQ,EACT,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAErD;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,IAAI;IAC5B,SAAgB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9C,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,MAAM,EAAE,OAAO,MAAM,CAAC;IACtC,SAAgB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9C,SAAgB,iBAAiB,EAAE,OAAO,iBAAiB,CAAC;IAC5D,SAAgB,cAAc,EAAE,OAAO,cAAc,CAAC;IACtD,SAAgB,WAAW,EAAE,OAAO,WAAW,CAAC;IAChD,SAAgB,OAAO,EAAE,OAAO,OAAO,CAAC;IACxC,SAAgB,cAAc,EAAE,OAAO,cAAc,CAAC;IACtD,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,aAAa,EAAE,OAAO,aAAa,CAAC;IACpD,SAAgB,SAAS,EAAE,OAAO,SAAS,CAAC;IAC5C,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,OAAO,EAAE,OAAO,OAAO,CAAC;IACxC,SAAgB,YAAY,EAAE,OAAO,YAAY,CAAC;IAClD,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1C,SAAgB,KAAK,EAAE,OAAO,KAAK,CAAC;IACpC,SAAgB,gBAAgB,EAAE,OAAO,gBAAgB,CAAC;IAC1D,SAAgB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAE1C;;;;;OAKG;gBACS,MAAM,EAAE,UAAU;IA+BvB,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,GAAG,QAAQ;CAG3D;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/types/api/Agents.d.ts

@@ -1,5 +1,18 @@
 import { Agent, GetAgentStatusResponse, GetCompleteAgentsOptions, GetCompleteAgentByIdOptions, AgentStatusOptions, SetAgentStatusOptions, GetAgentsOptions, GetAgentsResponse, SearchAgentsOptions, SearchAgentsResponse, UpdateAgentOptions, UpdateAgentResponse, UpdateAgentRuleGroupsOptions, UpdateAgentRuleGroupsResponse, UpdateAgentsStatusByQueryOptions } from '../types/agents';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages HitL (Human-in-the-Loop) agents in the system
+ *
+ * This class provides functionality to:
+ * - Retrieve and search agents
+ * - Manage agent permissions, status, and additional meta information
+ *
+ * @remarks
+ * - All methods in this class interact with the `/agents` endpoint
+ * - For the methods `getAgentStatus`, `setAgentStatus`, and `updateAgentsStatusByQuery`, you must pass `{ version: 2 }` in the parameters for the method to execute correctly.
+ *
+ * @public
+ */
 export declare class Agents extends HITLBase {
     protected static MODULE_URL: string;
     protected static AGENT_SEARCH_URL: string;
@@ -10,18 +23,352 @@ export declare class Agents extends HITLBase {
     protected static PING_AGENT_STATUS_URL: string;
     protected static AGENT_STATUS_URL: string;
     protected static UPDATE_AGENTS_STATUS_BY_QUERY_URL: string;
+    /**
+     * Gets a list of agents with HITL (Human in the Loop) information
+     *
+     * @param options - Configuration parameters for the agent list request
+     *
+     * Optional parameters:
+     * - `agentIds` - (string[]) List of specific agent identifiers to retrieve
+     * - `projection` - (string[]) List of fields to include in the response
+     * - `limit` - (number) Maximum number of agents to return
+     * - `offset` - (number) Number of agents to skip for pagination
+     * - `orderBy` - (string) Field name to order the results by
+     * - `order` - ('asc'|'desc') Order direction
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<GetAgentsResponse>} Promise resolving to:
+     * - `data` - Array of partial agent objects {@link Agent}
+     * - `last` - Optional pagination information:
+     *   - `id` - Optional ID of the last agent in the list
+     *   - `accountId` - Optional account ID of the last agent
+     *
+     * @example
+     * ```typescript
+     * const response = await hitlApi.agents.getAgents({
+     *   limit: 10,
+     *   offset: 0,
+     *   orderBy: 'createdAt',
+     *   order: 'desc'
+     * });
+     * ```
+     *
+     * @example
+     * Using projection and filtering by specific agents:
+     * ```typescript
+     * const response = await hitlApi.agents.getAgents({
+     *   agentIds: ['agent1', 'agent2'],
+     *   projection: ['id', 'name', 'statusData'],
+     *   orderBy: 'name',
+     *   order: 'asc'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/agents` endpoint
+     * @public
+     */
     static getAgents(options?: GetAgentsOptions): Promise<GetAgentsResponse>;
+    /**
+     * Get Agents list with full info (additional data from Users API DB)
+     *
+     * @param options - Configuration parameters for the complete agent list request
+     *
+     * Optional parameters:
+     * - `accountId` - (string) Account identifier to filter agents
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<GetAgentsResponse>} Promise resolving to:
+     * - `data` - Array of partial agent objects with complete information
+     * - `last` - Optional pagination information
+     *
+     * @example
+     * ```typescript
+     * const response = await hitlApi.agents.getCompleteAgents();
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/agents/complete` endpoint
+     * @public
+     */
     static getCompleteAgents(options?: GetCompleteAgentsOptions): Promise<GetAgentsResponse>;
+    /**
+     * Get Agent with full info (additional data from Users API DB)
+     *
+     * @param options - Configuration parameters for retrieving a complete agent
+     *
+     * Required parameters:
+     * - `agentId` - (string) Identifier of the agent to retrieve complete information for
+     *
+     * Optional parameters:
+     * - `multiUserId` - (string) Multi-user identifier
+     * - `accountId` - (string) Account identifier
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<Agent>} Promise resolving to a complete agent object
+     *
+     * @example
+     * ```typescript
+     * const agent = await hitlApi.agents.getCompleteAgentById({
+     *   agentId: 'agent-id',
+     *   multiUserId: 'multi-id-2'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/agents/complete/:agentId` endpoint
+     * @public
+     */
     static getCompleteAgentById({ accountId, multiUserId, ...options }: GetCompleteAgentByIdOptions & {
         accountId?: string;
     }): Promise<Agent>;
+    /**
+     * Search Agents by Rule Groups, status etc.
+     *
+     * @param options - Configuration parameters for the agent search
+     *
+     * Optional parameters:
+     * - `contactRuleGroupIds` - (string[]) Array of contact rule group identifiers
+     * - `excludeAgentIds` - (string[]) Array of agent IDs to exclude
+     * - `projection` - (string[]) List of fields to include in response
+     * - `ruleGroupIds` - (string[]) Array of rule group identifiers to filter by
+     * - `ruleTags` - (string[]) Array of rule tags to filter by
+     * - `statuses` - ({@link AgentsStatusForSearch}[]) Array of agent statuses
+     * - `timeout` - (number) Search timeout in milliseconds
+     * - `version` - (string|number) API version
+     *
+     * @returns {Promise<SearchAgentsResponse>} Promise resolving to:
+     * - `data` - Array of partial agent objects matching the search criteria
+     *
+     * @example
+     * ```typescript
+     * const response = await hitlApi.agents.searchAgents({
+     *   ruleGroupIds: ['group1', 'group2'],
+     *   statuses: ['AVAILABLE', 'BUSY'],
+     *   projection: ['id', 'name', 'statusData']
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/agents/search` endpoint
+     * @public
+     */
     static searchAgents(options?: SearchAgentsOptions): Promise<SearchAgentsResponse>;
+    /**
+     * Updates an agent
+     *
+     * @param options - Configuration parameters for the agent update request
+     *
+     * Required parameters:
+     * - `agentId` - (string) Identifier of the agent to update
+     *
+     * Optional parameters:
+     * - `ruleGroupIds` - (string[]) Array of rule group identifiers
+     * - `contactRuleGroupIds` - (string[]) Array of contact rule group identifiers
+     * - `meta` - (Object) Metadata object for the agent
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<UpdateAgentResponse>} Promise resolving to a partial agent object with updated information
+     *
+     * @example
+     * ```typescript
+     * const updatedAgent = await hitlApi.agents.updateAgent({
+     *   agentId: 'agent-id',
+     *   ruleGroupIds: ['group1', 'group2'],
+     *   meta: {
+     *     department: 'Support',
+     *     skills: ['chat', 'voice']
+     *   }
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/agents` endpoint with agentId as a query parameter
+     * @public
+     */
     static updateAgent({ agentId, ...options }: UpdateAgentOptions): Promise<UpdateAgentResponse>;
+    /**
+     * Update Rule Groups for Agent
+     *
+     * @param options - Configuration parameters for updating agent rule groups
+     *
+     * Required parameters:
+     * - `agentId` - (string) Identifier of the agent to update
+     *
+     *  Optional parameters:
+     * - `addRuleGroupIds` - (string[]) Array of rule group IDs to add
+     * - `removeRuleGroupIds` - (string[]) Array of rule group IDs to remove
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<UpdateAgentRuleGroupsResponse>} Promise resolving to a partial agent object with updated rule groups
+     *
+     * @example
+     * ```typescript
+     * const updatedAgent = await hitlApi.agents.updateAgentRuleGroups({
+     *   agentId: 'agent-id',
+     *   addRuleGroupIds: ['group1', 'group2'],
+     *   removeRuleGroupIds: ['group3', 'group4']
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/agents/rule-groups` endpoint with agentId as a query parameter
+     * @public
+     */
     static updateAgentRuleGroups({ agentId, ...options }: UpdateAgentRuleGroupsOptions): Promise<UpdateAgentRuleGroupsResponse>;
+    /**
+     * Update Contact Rule Groups for Agent
+     *
+     * @param options - Configuration parameters for updating agent contact rule groups
+     *
+     * Required parameters:
+     * - `agentId` - (string) Identifier of the agent to update
+     *
+     *  Optional parameters:
+     * - `addRuleGroupIds` - (string[]) Array of rule group IDs to add
+     * - `removeRuleGroupIds` - (string[]) Array of rule group IDs to remove
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<UpdateAgentRuleGroupsResponse>} Promise resolving to a partial agent object with updated rule groups
+     *
+     * @example
+     * ```typescript
+     * const updatedAgent = await hitlApi.agents.updateAgentContactRuleGroups({
+     *   agentId: 'agent-id',
+     *   addRuleGroupIds: ['group1', 'group2'],
+     *   removeRuleGroupIds: ['group3', 'group4']
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/agents/contact-rule-groups` endpoint with agentId as a query parameter
+     * @public
+     */
     static updateAgentContactRuleGroups({ agentId, ...options }: UpdateAgentRuleGroupsOptions): Promise<UpdateAgentRuleGroupsResponse>;
+    /**
+     * Gets agent status
+     *
+     * @param options - Configuration parameters for retrieving agent status
+     *
+     * Optional parameters:
+     * - `agentId` - (string) Identifier of the agent
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<GetAgentStatusResponse>} Promise resolving to agent status object
+     *
+     * @example
+     * ```typescript
+     * const status = await hitlApi.agents.getAgentStatus({
+     *   agentId: 'agent-id',
+     *   version: 2
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/agents/agent-status` endpoint or `/agents/status` endpoint if version is 2
+     * @public
+     */
     static getAgentStatus(options?: AgentStatusOptions): Promise<GetAgentStatusResponse>;
+    /**
+     * Sends an agent status "ping" message to keep the agent "online"
+     *
+     * @param options - Configuration parameters for the agent status ping
+     *
+     * Optional parameters:
+     * - `agentId` - (string) Identifier of the agent
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<GetAgentStatusResponse>} Promise resolving to updated agent status
+     *
+     * @example
+     * ```typescript
+     * const status = await hitlApi.agents.pingAgentStatus();
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/agents/ping-agent-status` endpoint
+     * @public
+     */
     static pingAgentStatus(options?: AgentStatusOptions): Promise<GetAgentStatusResponse>;
+    /**
+     * Set Agent status
+     *
+     * @param options - Configuration parameters for setting agent status
+     *
+     * Required parameters:
+     * - `agentId` - (string) Identifier of the agent
+     * - `statusData` - (Object) Status information:
+     *
+     * Optional parameters:
+     * - `notifyStatusChange` - (boolean) Flag to notify about status change
+     * - `statusChangeContext` - (Object) Context data for status change
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     * @returns {Promise<void>} Promise that resolves when status is successfully set
+     *
+     * @example
+     * ```typescript
+     * await hitlApi.agents.setAgentStatus({
+     *   agentId: 'agent-id',
+     *   statusData: {
+     *     key: 'busy',
+     *     order: 1,
+     *     status: 'BUSY',
+     *     isBasic: true,
+     *     expireIn: 60,
+     *     canToggle: ['on', 'off']
+     *   },
+     *   statusChangeContext: {
+     *     type: 'Manual',
+     *     source: 'Agent UI'
+     *   },
+     *   notifyStatusChange: false,
+     *   version: 2
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/agents/status` endpoint with agentId as a query parameter
+     * @public
+     */
     static setAgentStatus({ agentId, ...options }: SetAgentStatusOptions): Promise<void>;
+    /**
+     * Update Agents status by providing a raw SQL query
+     *
+     * @param options - Configuration parameters for updating agents' status
+     *
+     * Required parameters:
+     * - `query` - (string) SQL query or filter conditions to select agents
+     *
+     * Optional parameters:
+     * - `statusChangeContext` - (Object) Context data for status change
+     * - `maxRetries` - (number) Number of retry attempts for concurrent updates
+     * - `version` - (number) API version
+     * - `timeout` - (number) Search timeout in milliseconds
+     *
+     * @returns {Promise<any>} Promise resolving to the result of the batch update operation
+     *
+     * @example
+     * ```typescript
+     * const result = await hitlApi.agents.updateAgentsStatusByQuery({
+     *   query: `UPDATE hitl.agents SET status_data = jsonb_set(status_data, '{key}', '"busy"') WHERE status_data->>'key'='available' RETURNING*`,
+     *   maxRetries: 5,
+     *   version: 2
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/agents/status/query` endpoint with retry mechanism for concurrent updates
+     * @public
+     */
     static updateAgentsStatusByQuery({ maxRetries, ...options }: UpdateAgentsStatusByQueryOptions): Promise<unknown>;
 }
 //# sourceMappingURL=Agents.d.ts.map

package/dist/types/api/Agents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Agents.d.ts","sourceRoot":"","sources":["../../../src/api/Agents.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,EAGL,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,4BAA4B,EAC5B,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAetC,qBAAa,MAAO,SAAQ,QAAQ;IAClC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAY;IACvC,SAAS,CAAC,MAAM,CAAC,gBAAgB,SAAY;IAC7C,SAAS,CAAC,MAAM,CAAC,eAAe,SAAc;IAC9C,SAAS,CAAC,MAAM,CAAC,oBAAoB,SAAkB;IACvD,SAAS,CAAC,MAAM,CAAC,qBAAqB,SAAiB;IACvD,SAAS,CAAC,MAAM,CAAC,6BAA6B,SAAyB;IACvE,SAAS,CAAC,MAAM,CAAC,qBAAqB,SAAuB;IAC7D,SAAS,CAAC,MAAM,CAAC,gBAAgB,SAAY;IAC7C,SAAS,CAAC,MAAM,CAAC,iCAAiC,SAAkB;WAgDhD,SAAS,CAC3B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;WAoCT,iBAAiB,CACnC,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,iBAAiB,CAAC;WAwCT,oBAAoB,CACtC,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,EAAE,2BAA2B,GAAG;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;KAAE,GAC5F,OAAO,CAAC,KAAK,CAAC;WAgDG,YAAY,CAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,oBAAoB,CAAC;WAgDZ,WAAW,CAC7B,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,kBAAkB,GAC1C,OAAO,CAAC,mBAAmB,CAAC;WA4CX,qBAAqB,CACvC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,4BAA4B,GACpD,OAAO,CAAC,6BAA6B,CAAC;WA6CrB,4BAA4B,CAC9C,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,4BAA4B,GACpD,OAAO,CAAC,6BAA6B,CAAC;WAwCrB,cAAc,CAChC,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,sBAAsB,CAAC;WAoCd,eAAe,CACjC,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,sBAAsB,CAAC;WAsDd,cAAc,CAChC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,qBAAqB,GAC7C,OAAO,CAAC,IAAI,CAAC;WA6CI,yBAAyB,CAC3C,EAAE,UAAc,EAAE,GAAG,OAAO,EAAE,EAAE,gCAAgC;CA8BnE"}
+{"version":3,"file":"Agents.d.ts","sourceRoot":"","sources":["../../../src/api/Agents.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,EAGL,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,4BAA4B,EAC5B,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAO,SAAQ,QAAQ;IAClC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAY;IACvC,SAAS,CAAC,MAAM,CAAC,gBAAgB,SAAY;IAC7C,SAAS,CAAC,MAAM,CAAC,eAAe,SAAc;IAC9C,SAAS,CAAC,MAAM,CAAC,oBAAoB,SAAkB;IACvD,SAAS,CAAC,MAAM,CAAC,qBAAqB,SAAiB;IACvD,SAAS,CAAC,MAAM,CAAC,6BAA6B,SAAyB;IACvE,SAAS,CAAC,MAAM,CAAC,qBAAqB,SAAuB;IAC7D,SAAS,CAAC,MAAM,CAAC,gBAAgB,SAAY;IAC7C,SAAS,CAAC,MAAM,CAAC,iCAAiC,SAAkB;IAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;WACiB,SAAS,CAC3B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAa7B;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACiB,iBAAiB,CACnC,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,iBAAiB,CAAC;IAY7B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;WACiB,oBAAoB,CACtC,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,EAAE,2BAA2B,GAAG;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;KAAE,GAC5F,OAAO,CAAC,KAAK,CAAC;IAiBjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,YAAY,CAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;WACiB,WAAW,CAC7B,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,kBAAkB,GAC1C,OAAO,CAAC,mBAAmB,CAAC;IAe/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,qBAAqB,CACvC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,4BAA4B,GACpD,OAAO,CAAC,6BAA6B,CAAC;IAgBzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,4BAA4B,CAC9C,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,4BAA4B,GACpD,OAAO,CAAC,6BAA6B,CAAC;IAgBzC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,cAAc,CAChC,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,sBAAsB,CAAC;IAelC;;;;;;;;;;;;;;;;;;;;OAoBG;WACiB,eAAe,CACjC,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,sBAAsB,CAAC;IAalC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;WACiB,cAAc,CAChC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,qBAAqB,GAC7C,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,yBAAyB,CAC3C,EAAE,UAAc,EAAE,GAAG,OAAO,EAAE,EAAE,gCAAgC;CA8BnE"}

package/dist/types/api/CannedMessages.d.ts

@@ -1,10 +1,178 @@
 import { CannedMessage, GetCannedMessagesOptions, GetCannedMessagesResponse, CreateCannedMessageOptions, UpdateCannedMessageOptions, DeleteCannedMessageOptions } from '../types/canned-messages';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages canned messages (predefined message templates) in the system
+ *
+ * This class provides functionality to create, retrieve, update, and delete canned messages.
+ * Canned messages are predefined templates that can be used for quick responses in various scenarios.
+ *
+ * Key features:
+ * - Manage message templates with categories and labels
+ * - Support for common (shared) messages across agents
+ * - Attachment handling capabilities
+ * - Rule-based tagging system
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * // Get all canned messages
+ * const messages = await hitlApi.cannedMessages.getCannedMessages();
+ *
+ * // Create a new template
+ * const newTemplate = await hitlApi.cannedMessages.createCannedMessage({
+ *   category: 'greeting',
+ *   text: 'Hello! How can I help you today?',
+ *   isCommon: true
+ * });
+ * ```
+ *
+ * @remarks
+ * - All methods in this class interact with the `/canned-messages` endpoint
+ * - These methods are available only when you pass `{ version: 1 }` in the parameters.
+ * @public
+ */
 export declare class CannedMessages extends HITLBase {
     protected static MODULE_URL: string;
+    /**
+     * Gets a list of canned messages (message templates)
+     *
+     * @param options - Configuration parameters for the canned messages list request
+     *
+     * Optional parameters:
+     * - `agentId` - (string) Filter messages by specific agent
+     * - `categories` - (string[]) Filter by message categories
+     * - `id` - (string) Get specific message by ID
+     * - `ignoreRuleTags` - (boolean) Whether to ignore rule tags in filtering
+     * - `isCommon` - (boolean) Filter by system or personal message status
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetCannedMessagesResponse | CannedMessage>} Promise resolving to:
+     * - `data` - Array of canned message objects {@link CannedMessage}
+     *
+     * @example
+     * ```typescript
+     * const response = await hitlApi.cannedMessages.getCannedMessages({
+     *   categories: ['support', 'greeting'],
+     *   isCommon: true,
+     *   agentId: 'agent-id-1'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/canned-messages` endpoint
+     * @public
+     */
     static getCannedMessages(options?: GetCannedMessagesOptions): Promise<GetCannedMessagesResponse | CannedMessage>;
+    /**
+     * Creates a new canned message (message template)
+     *
+     * @param options - Configuration parameters for creating the canned message
+     *
+     * Required parameters:
+     * - `category` - (string) Category of the message
+     * - `text` - (string) Content of the message
+     *
+     * Optional parameters:
+     * - `agentId` - (string) ID of the agent to associate with
+     * - `attachments` - (CannedMessageAttachment[]) Array of attachments
+     * - `isCommon` - (boolean) Whether the message is system or personal
+     * - `label` - (string) Label for the message
+     * - `ruleTags` - (string[]) Array of rule tags
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<CannedMessage>} Promise resolving to the created canned message
+     *
+     * @example
+     * ```typescript
+     * const newMessage = await hitlApi.cannedMessages.createCannedMessage({
+     *   category: 'support',
+     *   text: "Thank you for your patience!",
+     *   label: "Thank You Response",
+     *   isCommon: true,
+     *   ruleTags: ['greeting', 'sms'],
+     *   attachments: [
+     *     {
+     *       "key": "IMAGE.JPG"
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/canned-messages` endpoint
+     * @public
+     */
     static createCannedMessage({ isCommon, agentId, ...options }: CreateCannedMessageOptions): Promise<CannedMessage>;
+    /**
+     * Updates an existing canned message (message template)
+     *
+     * @param options - Configuration parameters for updating the canned message
+     *
+     * Required parameters:
+     * - `id` - (string) Unique identifier of the message to update
+     *
+     * Optional parameters:
+     * - `attachments` - (CannedMessageAttachment[]) Array of attachments
+     * - `category` - (string) New category for the message
+     * - `label` - (string) New label for the message
+     * - `ruleTags` - (string[]) New array of rule tags
+     * - `text` - (string) New content of the message
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * System fields (automatically managed):
+     * - `createdAt` - (Date) Creation timestamp
+     * - `updatedAt` - (Date) Last update timestamp
+     *
+     * @returns {Promise<CannedMessage>} Promise resolving to the updated canned message
+     *
+     * @example
+     * ```typescript
+     * const updatedMessage = await hitlApi.cannedMessages.updateCannedMessage({
+     *   id: "msg-id-1",
+     *   text: "Updated response text",
+     *   category: "support",
+     *   ruleTags: ['sms', 'admin'],
+     *   attachments: [
+     *     {
+     *       "key": "IMAGE_2.JPG"
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/canned-messages` endpoint
+     * @public
+     */
     static updateCannedMessage(options: UpdateCannedMessageOptions): Promise<CannedMessage>;
+    /**
+     * Deletes a canned message (message template)
+     *
+     * @param options - Configuration parameters for deleting the canned message
+     *
+     * Required parameters:
+     * - `id` - (string) Unique identifier of the message to delete
+     *
+     * Optional parameters:
+     * - `version` - (string | number) API version to use
+     * - `timeout` - (number) Request timeout in milliseconds
+     *
+     * @returns {Promise<void>} Promise that resolves when deletion is complete
+     *
+     * @example
+     * ```typescript
+     * await hitlApi.cannedMessages.deleteCannedMessage({
+     *   id: "msg-id-1"
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/canned-messages` endpoint
+     * @public
+     */
     static deleteCannedMessage({ id, ...options }: DeleteCannedMessageOptions): Promise<void>;
 }
 //# sourceMappingURL=CannedMessages.d.ts.map

package/dist/types/api/CannedMessages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CannedMessages.d.ts","sourceRoot":"","sources":["../../../src/api/CannedMessages.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAiCtC,qBAAa,cAAe,SAAQ,QAAQ;IAC1C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAqB;WAgC5B,iBAAiB,CACnC,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,yBAAyB,GAAG,aAAa,CAAC;WAsDjC,mBAAmB,CACrC,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GAC5D,OAAO,CAAC,aAAa,CAAC;WA4DL,mBAAmB,CACrC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;WAuCL,mBAAmB,CACrC,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GAC7C,OAAO,CAAC,IAAI,CAAC;CAUjB"}
+{"version":3,"file":"CannedMessages.d.ts","sourceRoot":"","sources":["../../../src/api/CannedMessages.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,cAAe,SAAQ,QAAQ;IAC1C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAqB;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;WACiB,iBAAiB,CACnC,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,yBAAyB,GAAG,aAAa,CAAC;IAcrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACiB,mBAAmB,CACrC,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GAC5D,OAAO,CAAC,aAAa,CAAC;IAkBzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;WACiB,mBAAmB,CACrC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAczB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,mBAAmB,CACrC,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GAC7C,OAAO,CAAC,IAAI,CAAC;CAUjB"}

package/dist/types/api/Commands.d.ts

@@ -1,7 +1,53 @@
 import { ApplyCommandOptions } from '../types/commands';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages command operations in the HitL (Human-in-the-Loop) system
+ *
+ * This class provides functionality to send and manage commands within HitL sessions,
+ * allowing control and interaction with conversations or processes.
+ *
+ * @remarks
+ * - All methods in this class interact with the `/commands` endpoint
+ * - These methods are available only when you pass `{ version: 1 }` in the parameters.
+ *
+ * @public
+ */
 export declare class Commands extends HITLBase {
     protected static MODULE_URL: string;
+    /**
+     * Sends a command to the flow currently controlling the HitL session
+     *
+     * This method allows sending specific commands to modify or control the behavior
+     * of a HitL session. The command is processed by the flow's subscription
+     * of the specified session.
+     *
+     * @param options - Configuration parameters for the command
+     *
+     * Required parameters:
+     * - `command` - (string) The command to be executed in the session
+     * - `sessionId` - (string) ID of the target HITL session
+     * - `data` - (object) Command-specific payload containing parameters for execution
+     *
+     * Optional parameters:
+     * - `version` - (number) API version to use for the request
+     * - `timeout` - (number) Request timeout in milliseconds
+     *
+     * @returns Promise<void> that resolves when the command is successfully applied
+     *
+     * @example
+     * ```typescript
+     * await hitlApi.commands.applyCommandToSession({
+     *   command: 'send_message',
+     *   sessionId: 'session-id',
+     *   data: {
+     *     media: [],
+     *     text: 'hello world'
+     *   }
+     * });
+     * ```
+     *
+     * @public
+     */
     static applyCommandToSession({ command, sessionId, data, ...options }: ApplyCommandOptions): Promise<void>;
 }
 //# sourceMappingURL=Commands.d.ts.map

package/dist/types/api/Commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Commands.d.ts","sourceRoot":"","sources":["../../../src/api/Commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AActC,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAc;WAoCrB,qBAAqB,CACvC,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,mBAAmB,GAC5D,OAAO,CAAC,IAAI,CAAC;CAcjB"}
+{"version":3,"file":"Commands.d.ts","sourceRoot":"","sources":["../../../src/api/Commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAc;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;WACiB,qBAAqB,CACvC,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,mBAAmB,GAC5D,OAAO,CAAC,IAAI,CAAC;CAcjB"}