@or-sdk/hitl 0.36.2 → 0.36.3

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"}

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

@@ -1,9 +1,129 @@
 import { GetConferenceMembersOptions, GetConferenceMembersResponse, ConferenceMember, AddOrUpdateConferenceMemberOptions, CleanUpConferenceOptions } from '../types/conferences';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages voice conference members in the system
+ *
+ * This class provides functionality to manage conference participants, including retrieving,
+ * adding, updating, and removing conference members.
+ *
+ * Key features:
+ * - Manage conference member states and statuses
+ * - Track member connection states
+ * - Support for cleanup operations
+ *
+ * @remarks
+ * - All methods in this class interact with the `/conferences` endpoint
+ * @public
+ */
 export declare class Conferences extends HITLBase {
     protected static MODULE_URL: string;
+    /**
+     * Gets a list of conference members or a specific member
+     *
+     * @param options - Configuration parameters for the conference members request
+     *
+     * Required parameters:
+     * - `hitlSessionId` - (string) ID of the HitL session
+     *
+     * Optional parameters:
+     * - `memberId` - (string) Get specific member by ID
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetConferenceMembersResponse | ConferenceMember>} Promise resolving to:
+     * - Either a list of conference members or a single member if memberId is provided
+     *
+     * @example
+     * ```typescript
+     * // Get all members in a conference
+     * const response = await hitlApi.conferences.getConferenceMembers({
+     *   hitlSessionId: 'session-id'
+     * });
+     *
+     * // Get a specific member
+     * const member = await hitlApi.conferences.getConferenceMembers({
+     *   hitlSessionId: 'session-id',
+     *   memberId: 'member-id'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/conferences` endpoint
+     * @public
+     */
     static getConferenceMembers({ hitlSessionId, memberId, ...options }: GetConferenceMembersOptions): Promise<GetConferenceMembersResponse | ConferenceMember>;
+    /**
+     * Adds or updates a conference member
+     *
+     * @param options - Configuration parameters for adding/updating the conference member
+     *
+     * Required parameters:
+     * - `hitlSessionId` - (string) ID of the HitL session
+     * - `identifier` - (string) Unique identifier for the member
+     * - `type` - (string) Type of the conference member
+     *
+     * Optional parameters:
+     * - `memberId` - (string) ID of the member to update
+     * - `status` - (string) Member's status
+     * - `state` - (string) Member's state
+     * - `disconnectedAt` - (Date) Timestamp when member disconnected
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<ConferenceMember>} Promise resolving to the created/updated conference member
+     *
+     * @example
+     * ```typescript
+     * const member = await hitlApi.conferences.addOrUpdateConferenceMember({
+     *   hitlSessionId: 'session-id',
+     *   identifier: '+1234567890',
+     *   type: 'contact',
+     *   status: 'JOINED',
+     *   state: {
+     *     isMuted: false,
+     *     isOnHold: false
+     *   }
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/conferences` endpoint
+     * @public
+     */
     static addOrUpdateConferenceMember({ hitlSessionId, memberId, identifier, type, status, state, disconnectedAt, ...options }: AddOrUpdateConferenceMemberOptions): Promise<ConferenceMember>;
+    /**
+     * Removes conference members from a session
+     *
+     * @param options - Configuration parameters for cleaning up the conference
+     *
+     * Required parameters:
+     * - `hitlSessionId` - (string) ID of the HitL session
+     *
+     * Optional parameters:
+     * - `memberId` - (string) Specific member to remove
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<void>} Promise that resolves when cleanup is complete
+     *
+     * @example
+     * ```typescript
+     * // Clean up all conference members
+     * await hitlApi.conferences.cleanUpConference({
+     *   hitlSessionId: 'session-id'
+     * });
+     *
+     * // Remove specific member
+     * await hitlApi.conferences.cleanUpConference({
+     *   hitlSessionId: 'session-id',
+     *   memberId: 'member-id'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/conferences` endpoint
+     * @public
+     */
     static cleanUpConference({ hitlSessionId, memberId, ...options }: CleanUpConferenceOptions): Promise<void>;
 }
 //# sourceMappingURL=Conferences.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Conferences.d.ts","sourceRoot":"","sources":["../../../src/api/Conferences.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,gBAAgB,EAChB,kCAAkC,EAClC,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAiBtC,qBAAa,WAAY,SAAQ,QAAQ;IACvC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAiB;WAoC9B,oBAAoB,CAChC,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,2BAA2B,GACnE,OAAO,CAAC,4BAA4B,GAAG,gBAAgB,CAAC;WAmD7C,2BAA2B,CACvC,EACE,aAAa,EACb,QAAQ,EACR,UAAU,EACV,IAAI,EACJ,MAAM,EACN,KAAK,EACL,cAAc,EACd,GAAG,OAAO,EACX,EAAE,kCAAkC,GACpC,OAAO,CAAC,gBAAgB,CAAC;WAoDd,iBAAiB,CAC7B,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GAChE,OAAO,CAAC,IAAI,CAAC;CAajB"}
+{"version":3,"file":"Conferences.d.ts","sourceRoot":"","sources":["../../../src/api/Conferences.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,gBAAgB,EAChB,kCAAkC,EAClC,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,WAAY,SAAQ,QAAQ;IACvC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAiB;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;WACW,oBAAoB,CAChC,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,2BAA2B,GACnE,OAAO,CAAC,4BAA4B,GAAG,gBAAgB,CAAC;IAa3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;WACW,2BAA2B,CACvC,EACE,aAAa,EACb,QAAQ,EACR,UAAU,EACV,IAAI,EACJ,MAAM,EACN,KAAK,EACL,cAAc,EACd,GAAG,OAAO,EACX,EAAE,kCAAkC,GACpC,OAAO,CAAC,gBAAgB,CAAC;IAmB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;WACW,iBAAiB,CAC7B,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GAChE,OAAO,CAAC,IAAI,CAAC;CAajB"}

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

@@ -1,10 +1,141 @@
 import { SearchRuleGroupsOptions, SearchRuleGroupsResponse, RuleGroup, CreateRuleGroupOptions, UpdateRuleGroupOptions, DeleteRuleGroupOptions } from '../types/rule-groups';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages contact rule groups in the system
+ *
+ * This class provides functionality to manage contact rule groups, including searching,
+ * creating, updating, and deleting contact rule groups.
+ *
+ * Key features:
+ * - Search and retrieve contact rule groups
+ * - Create new contact rule groups
+ * - Update existing contact rule groups
+ * - Delete contact rule groups
+ *
+ * @remarks
+ * - All methods in this class interact with the `/contact-rule-groups` endpoint
+ * @public
+ */
 export declare class ContactRuleGroups extends HITLBase {
     protected static MODULE_URL: string;
+    /**
+     * Searches for contact rule groups or retrieves specific groups
+     *
+     * @param options - Configuration parameters for the rule groups search
+     *
+     * Optional parameters:
+     * - `groupIdList` - (string[]) List of specific group IDs to retrieve
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<SearchRuleGroupsResponse | RuleGroup>} Promise resolving to:
+     * - Either a list of rule groups or a single rule group if specific ID is provided
+     *
+     * @example
+     * ```typescript
+     * // Search all rule groups
+     * const response = await hitlApi.contactRuleGroups.searchContactRuleGroups();
+     *
+     * // Search specific rule groups
+     * const groups = await hitlApi.contactRuleGroups.searchContactRuleGroups({
+     *   groupIdList: ['group-1', 'group-2']
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/contact-rule-groups` endpoint
+     * @public
+     */
     static searchContactRuleGroups({ groupIdList, ...options }?: SearchRuleGroupsOptions): Promise<SearchRuleGroupsResponse | RuleGroup>;
+    /**
+     * Creates a new contact rule group
+     *
+     * @param options - Configuration parameters for creating the rule group
+     *
+     * Required parameters:
+     * - `groupId` - (string) Unique identifier for the group
+     * - `name` - (string) Name of the rule group
+     * - `rules` - (RuleDefinition[]) Array of rules for the group
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<RuleGroup>} Promise resolving to the created rule group
+     *
+     * @example
+     * ```typescript
+     * const newGroup = await hitlApi.contactRuleGroups.createContactRuleGroup({
+     *   groupId: 'group-1',
+     *   name: 'Students',
+     *   rules: [
+     *     'student', 'postgraduate student'
+     *   ]
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/contact-rule-groups` endpoint
+     * @public
+     */
     static createContactRuleGroup({ groupId, name, rules, ...options }: CreateRuleGroupOptions): Promise<RuleGroup>;
+    /**
+     * Updates an existing contact rule group
+     *
+     * @param options - Configuration parameters for updating the rule group
+     *
+     * Required parameters:
+     * - `groupId` - (string) ID of the group to update
+     * - `name` - (string) Updated name for the rule group
+     * - `rules` - (RuleDefinition[]) Updated array of rules
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<RuleGroup>} Promise resolving to the updated rule group
+     *
+     * @example
+     * ```typescript
+     * const updatedGroup = await hitlApi.contactRuleGroups.updateContactRuleGroup({
+     *   groupId: 'group-1',
+     *   name: 'Updated Students',
+     *   rules: [
+     *     'student'
+     *   ]
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/contact-rule-groups` endpoint
+     * @public
+     */
     static updateContactRuleGroup({ groupId, name, rules, ...options }: UpdateRuleGroupOptions): Promise<RuleGroup>;
+    /**
+     * Deletes a contact rule group
+     *
+     * @param options - Configuration parameters for deleting the rule group
+     *
+     * Required parameters:
+     * - `groupId` - (string) ID of the group to delete
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<void>} Promise that resolves when deletion is complete
+     *
+     * @example
+     * ```typescript
+     * await hitlApi.contactRuleGroups.deleteContactRuleGroup({
+     *   groupId: 'group-1'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/contact-rule-groups` endpoint
+     * @public
+     */
     static deleteContactRuleGroup({ groupId, ...options }: DeleteRuleGroupOptions): Promise<void>;
 }
 //# sourceMappingURL=ContactRuleGroups.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ContactRuleGroups.d.ts","sourceRoot":"","sources":["../../../src/api/ContactRuleGroups.ts"],"names":[],"mappings":"AACA,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,SAAS,EACT,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAkBtC,qBAAa,iBAAkB,SAAQ,QAAQ;IAC7C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAyB;WA8BtC,uBAAuB,CACnC,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,GAAE,uBAA4B,GACxD,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC;WA6ClC,sBAAsB,CAClC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;WA8CP,sBAAsB,CAClC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;WAwCP,sBAAsB,CAClC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC9C,OAAO,CAAC,IAAI,CAAC;CAUjB"}
+{"version":3,"file":"ContactRuleGroups.d.ts","sourceRoot":"","sources":["../../../src/api/ContactRuleGroups.ts"],"names":[],"mappings":"AACA,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,SAAS,EACT,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,iBAAkB,SAAQ,QAAQ;IAC7C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAyB;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;WACW,uBAAuB,CACnC,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,GAAE,uBAA4B,GACxD,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC;IAchD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACW,sBAAsB,CAClC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;IAerB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACW,sBAAsB,CAClC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;IAerB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACW,sBAAsB,CAClC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC9C,OAAO,CAAC,IAAI,CAAC;CAUjB"}

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

@@ -1,7 +1,44 @@
 import { SearchContactsOptions, SearchContactsResponse } from '../types/contacts';
 import { HITLBase } from './HITLBase';
+/**
+ * This class provides functionality to search contacts with respect to
+ * agent's permissions and rule groups.
+ *
+ * Key features:
+ * - Search contacts with filtering based on agent's contact rule groups
+ *
+ * @remarks
+ * - All methods in this class interact with the `/contacts` endpoint
+ * @public
+ */
 export declare class Contacts extends HITLBase {
     protected static MODULE_URL: string;
+    /**
+     * Searches for contacts limited by the agent's contact rule groups
+     *
+     * Filters out contact records not visible to a given agent, according
+     * to the contact rule groups the agent is a member of
+     *
+     * @param options - Configuration parameters for the contacts search
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<SearchContactsResponse>} Promise resolving to the search results
+     *
+     * @example
+     * ```typescript
+     * const contacts = await hitlApi.contacts.searchContacts({
+     *   contact_book: '0cc3f3bb-a064-4b2d-89d9-4c4846a061e2',
+     *   contactIds: ['contact-id-1', 'contact-id-2']
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/contacts` endpoint
+     * @public
+     */
     static searchContacts(options: SearchContactsOptions): Promise<SearchContactsResponse>;
 }
 //# sourceMappingURL=Contacts.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Contacts.d.ts","sourceRoot":"","sources":["../../../src/api/Contacts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAElF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAatC,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAc;WA4BrB,cAAc,CAChC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,sBAAsB,CAAC;CAUnC"}
+{"version":3,"file":"Contacts.d.ts","sourceRoot":"","sources":["../../../src/api/Contacts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAElF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAc;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,cAAc,CAChC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,sBAAsB,CAAC;CAUnC"}

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

@@ -1,8 +1,41 @@
 import { SearchContactsMetaOptions, SearchContactsMetaResponse } from '../types/contacts-meta';
 import { HITLBase } from './HITLBase';
+/**
+ * This class provides functionality to retrieve metadata information about contacts.
+ *
+ * @remarks
+ * - All methods in this class interact with the `/contacts-meta` endpoint
+ * @public
+ */
 export declare class ContactsMeta extends HITLBase {
     protected static MODULE_URL: string;
     protected static SEARCH_URL: string;
+    /**
+     * Retrieves HitL-specific contact parameters (metadata)
+     *
+     * @param options - Configuration parameters for the metadata search
+     *
+     * Required parameters:
+     * - `contactIds` - (string[]) List of specific contact IDs to retrieve
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<SearchContactsMetaResponse>} Promise resolving to:
+     * - `data` - Contact last event timestamps
+     *
+     * @example
+     * ```typescript
+     * const metadata = await hitlApi.contactsMeta.searchContactsMeta({
+     *   contactIds: ['contact-id-1', 'contact-id-2']
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/contacts-meta/search` endpoint
+     * @public
+     */
     static searchContactsMeta(options: SearchContactsMetaOptions): Promise<SearchContactsMetaResponse>;
 }
 //# sourceMappingURL=ContactsMeta.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ContactsMeta.d.ts","sourceRoot":"","sources":["../../../src/api/ContactsMeta.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC3B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAStC,qBAAa,YAAa,SAAQ,QAAQ;IACxC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAmB;IAC9C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAY;WA4BnB,kBAAkB,CACpC,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;CAcvC"}
+{"version":3,"file":"ContactsMeta.d.ts","sourceRoot":"","sources":["../../../src/api/ContactsMeta.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC3B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACxC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAmB;IAC9C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAY;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,kBAAkB,CACpC,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;CAcvC"}