@or-sdk/hitl 0.36.2 → 0.36.3

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

@@ -1,10 +1,145 @@
 import { GetEventTemplatesOptions, GetEventTemplatesResponse, CreateEventTemplateOptions, UpdateEventTemplateOptions, DeleteEventTemplateOptions, EventTemplate } from '../types/event-templates';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages event templates in the system
+ *
+ * This class provides functionality to manage event templates, including retrieving,
+ * creating, updating, and deleting templates.
+ *
+ * Key features:
+ * - Retrieve event templates
+ * - Create new event templates
+ * - Update existing event templates
+ * - Delete event templates
+ *
+ * @remarks
+ * - All methods in this class interact with the `/event-templates` endpoint
+ * @public
+ */
 export declare class EventTemplates extends HITLBase {
     protected static readonly MODULE_URL = "event-templates";
+    /**
+     * Retrieves event templates or a specific template
+     *
+     * @param options - Configuration parameters for retrieving templates
+     *
+     * Optional parameters:
+     * - `templateId` - (string) Specific template ID to retrieve
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetEventTemplatesResponse | EventTemplate>} Promise resolving to:
+     * - Either a list of templates or a single template if specific ID is provided
+     *
+     * @example
+     * ```typescript
+     * // Get all templates
+     * const templates = await hitlApi.eventTemplates.getEventTemplates();
+     *
+     * // Get specific template
+     * const template = await hitlApi.eventTemplates.getEventTemplates({
+     *   templateId: 'template-1'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/event-templates` endpoint
+     * @public
+     */
     static getEventTemplates({ templateId, ...options }?: GetEventTemplatesOptions): Promise<GetEventTemplatesResponse | EventTemplate>;
+    /**
+     * Creates a new event template
+     *
+     * @param options - Configuration parameters for creating the template
+     *
+     * Required parameters:
+     * - `eventType` - (string) Type of the event
+     * - `rule` - (string) Rule expression for the template
+     * - `template` - ({@link EventTemplateContent}) Content configuration for the template
+     *
+     * Optional parameters:
+     * - `isActive` - (boolean) Whether the template is active
+     * - `isVisible` - (boolean) Whether the template is visible
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<EventTemplate>} Promise resolving to the created event template
+     *
+     * @example
+     * ```typescript
+     * const template = await hitlApi.eventTemplates.createTemplate({
+     *   eventType: "Custom",
+     *   rule: "type == 'Transcript'",
+     *   template: {
+     *     html: '', js: 'return {}', sass: ''
+     *   }
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/event-templates` endpoint
+     * @public
+     */
     static createEventTemplate(options: CreateEventTemplateOptions): Promise<EventTemplate>;
+    /**
+     * Updates an existing event template
+     *
+     * @param options - Configuration parameters for updating the template
+     *
+     * Required parameters:
+     * - `templateId` - (string) ID of the template to update
+     *
+     * Optional parameters:
+     * - `eventType` - (string) Type of the event
+     * - `isActive` - (boolean) Whether the template is active
+     * - `isVisible` - (boolean) Whether the template is visible
+     * - `rule` - (string) Rule expression for the template
+     * - `template` - ({@link EventTemplateContent}) Content configuration for the template
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<EventTemplate>} Promise resolving to the updated template
+     *
+     * @example
+     * ```typescript
+     * const updatedTemplate = await hitlApi.eventTemplates.updateEventTemplate({
+     *   templateId: "template-1",
+     *   eventType: "Custom",
+     *   rule: "type == 'Transcript'",
+     *   isVisible: true,
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/event-templates` endpoint
+     * @public
+     */
     static updateEventTemplate(options: UpdateEventTemplateOptions): Promise<EventTemplate>;
+    /**
+     * Deletes an event template
+     *
+     * @param options - Configuration parameters for deleting the template
+     *
+     * Required parameters:
+     * - `templateId` - (string) ID of the template 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.eventTemplates.deleteEventTemplate({
+     *   templateId: 'template-1'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/event-templates` endpoint
+     * @public
+     */
     static deleteEventTemplate({ templateId, ...options }: DeleteEventTemplateOptions): Promise<void>;
 }
 //# sourceMappingURL=EventTemplates.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"EventTemplates.d.ts","sourceRoot":"","sources":["../../../src/api/EventTemplates.ts"],"names":[],"mappings":"AACA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,0BAA0B,EAC1B,aAAa,EAGd,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAkBtC,qBAAa,cAAe,SAAQ,QAAQ;IAC1C,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,qBAAqB;WA8BrC,iBAAiB,CACnC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAE,wBAA6B,GACxD,OAAO,CAAC,yBAAyB,GAAG,aAAa,CAAC;WA4CjC,mBAAmB,CACrC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;WA+CL,mBAAmB,CACrC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;WAuCL,mBAAmB,CACrC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GACrD,OAAO,CAAC,IAAI,CAAC;CAUjB"}
+{"version":3,"file":"EventTemplates.d.ts","sourceRoot":"","sources":["../../../src/api/EventTemplates.ts"],"names":[],"mappings":"AACA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,0BAA0B,EAC1B,aAAa,EAGd,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAe,SAAQ,QAAQ;IAC1C,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,qBAAqB;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;WACiB,iBAAiB,CACnC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAE,wBAA6B,GACxD,OAAO,CAAC,yBAAyB,GAAG,aAAa,CAAC;IAWrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;WACiB,mBAAmB,CACrC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAczB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;WACiB,mBAAmB,CACrC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAczB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,mBAAmB,CACrC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GACrD,OAAO,CAAC,IAAI,CAAC;CAUjB"}

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

@@ -1,20 +1,235 @@
 import { FilterV1, Filter, GetFiltersOptionsV1, GetFiltersOptions, GetFiltersResponseV1, GetFiltersResponse, CreateFilterOptionsV1, CreateFilterOptions, UpdateFilterOptionsV1, UpdateFilterOptions, DeleteFilterOptionsV1, DeleteFilterOptions, BulkGetFiltersOptionsV1, BulkGetFiltersOptions, BulkUpdateFiltersOptionsV1, BulkUpdateFiltersOptions, BulkUpdateFiltersResponseV1, BulkUpdateFiltersResponse } from '../types/filters';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages conversation view filters in the system
+ *
+ * This class provides functionality to manage conversation filters, including retrieving,
+ * creating, updating, and deleting filters, with support for both individual and bulk operations.
+ *
+ * Key features:
+ * - Retrieve conversation filters
+ * - Create new filters
+ * - Update existing filters
+ * - Delete filters
+ * - Bulk operations for filters
+ *
+ * @remarks
+ * - All methods in this class interact with the `/filters` endpoint
+ * - For all methods in this class, you must include `{ version: 2 }` in the parameters for the method to execute correctly.
+ * @public
+ */
 export declare class Filters extends HITLBase {
     protected static MODULE_URL: string;
     protected static BULK_URL: string;
     protected static DEFAULT_FIELDS: string[];
     protected static FILTER_VERSION_FIELD: "filterVersion";
+    /**
+     * Retrieves a list of conversation view filters
+     *
+     * @param options - Configuration parameters for retrieving filters
+     *
+     * Optional parameters:
+     * - `id` - (string) Specific filter ID
+     * - `agentId` - (string) Agent ID to filter by
+     * - `ignoreRuleTags` - (boolean) Whether to ignore rule tags
+     * - `isCommon` - (boolean) Filter by system or personal filters
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetFiltersResponse | GetFiltersResponseV1>} Promise resolving to the filters list
+     *
+     * @example
+     * ```typescript
+     * const filters = await hitlApi.filters.getFilters({
+     *   agentId: 'agent-1',
+     *   isCommon: true,
+     *   version: 2,
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/filters` endpoint
+     * @public
+     */
     static getFilters(options: GetFiltersOptionsV1): Promise<GetFiltersResponseV1>;
     static getFilters(options: GetFiltersOptions): Promise<GetFiltersResponse>;
+    /**
+     * Bulk retrieves conversation view filters, ignoring userId for personal filters
+     *
+     * @param options - Configuration parameters for bulk retrieving filters
+     *
+     * Optional parameters:
+     * - `accountId` - (string) Account ID
+     * - `ignoreRuleTags` - (boolean) Whether to ignore rule tags
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetFiltersResponse | GetFiltersResponseV1>} Promise resolving to the filters list
+     *
+     * @example
+     * ```typescript
+     * const filters = await hitlApi.filters.bulkGetFilters({
+     *   ignoreRuleTags: true,
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/filters/bulk` endpoint
+     * @public
+     */
     static bulkGetFilters(options: BulkGetFiltersOptionsV1): Promise<GetFiltersResponseV1>;
     static bulkGetFilters(options: BulkGetFiltersOptions): Promise<GetFiltersResponse>;
+    /**
+     * Creates a new conversation view filter
+     *
+     * @param options - Configuration parameters for creating the filter
+     *
+     * Required parameters:
+     * - `isDefault` - (boolean) Whether this is a default filter
+     * - `name` - (string) Name of the filter
+     * - `order` - (number) Order/priority of the filter
+     * - `settings` - (any) Filter settings configuration
+     *
+     * Optional parameters:
+     * - `agentId` - (string) Agent ID associated with the filter
+     * - `filterVersion` - (number) Version of the filter
+     * - `isCommon` - (boolean) Whether the filter is common
+     * - `isEnabled` - (boolean) Whether the filter is enabled
+     * - `ruleTags` - (string[]) Array of rule tags
+     * - `tags` - (string[]) Array of tags
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<Filter | FilterV1>} Promise resolving to the created filter
+     *
+     * @example
+     * ```typescript
+     * const filter = await hitlApi.filters.createFilter({
+     *   name: 'My Filter',
+     *   isCommon: true,
+     *   ruleTags: ['hitl'],
+     *   settings: {
+     *     customization: {},
+     *     display: {
+     *       type: "GROUP_BY_CONTACT"
+     *     },
+     *     contacts: {},
+     *     conversations: {
+     *       tags: [],
+     *       needsAction: false,
+     *       status: [
+     *         'CLAIMED',
+     *       ],
+     *       claimedBy: "[agent-id]",
+     *       claimedByHistory: ""
+     *     }
+     *   },
+     *   filterVersion: 2,
+     *   version: 2
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/filters` endpoint
+     * @public
+     */
     static createFilter(options: CreateFilterOptionsV1): Promise<FilterV1>;
     static createFilter(options: CreateFilterOptions): Promise<Filter>;
+    /**
+     * Updates an existing conversation view filter
+     *
+     * @param options - Configuration parameters for updating the filter
+     *
+     * Required parameters:
+     * - `id` - (string) ID of the filter to update
+     *
+     * Optional parameters:
+     * - `filterVersion` - (number) Version of the filter
+     * - `isDefault` - (boolean) Whether this is a default filter
+     * - `isEnabled` - (boolean) Whether the filter is enabled
+     * - `name` - (string) Name of the filter
+     * - `order` - (number) Order/priority of the filter
+     * - `ruleTags` - (string[]) Array of rule tags
+     * - `settings` - (any) Filter settings configuration
+     * - `tags` - (string[]) Array of tags
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<Filter | FilterV1>} Promise resolving to the updated filter
+     *
+     * @example
+     * ```typescript
+     * const filter = await hitlApi.filters.updateFilter({
+     *   id: 'filter-1',
+     *   name: 'Updated Filter',
+     *   tags: ['pets'],
+     *   version: 2,
+     *   filterVersion: 2,
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/filters` endpoint
+     * @public
+     */
     static updateFilter(options: UpdateFilterOptionsV1): Promise<FilterV1>;
     static updateFilter(options: UpdateFilterOptions): Promise<Filter>;
+    /**
+     * Bulk updates conversation view filters
+     *
+     * @param options - Configuration parameters for bulk updating filters
+     *
+     * Required parameters:
+     * - `filters` - ({@link UpdateFilterBody|UpdateFilterBodyV1 }[]) Array of filters to update
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<BulkUpdateFiltersResponse | BulkUpdateFiltersResponseV1>} Promise resolving to the update response
+     *
+     * @example
+     * ```typescript
+     * const result = await hitlApi.filters.bulkUpdateFilters({
+     *   filters: [
+     *     { id: 'filter-1', name: 'Updated Filter 1', ... },
+     *     { id: 'filter-2', name: 'Updated Filter 2', ... },
+     *   ],
+     *   version: 2
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/filters/bulk` endpoint
+     * @public
+     */
     static bulkUpdateFilters(options: BulkUpdateFiltersOptionsV1): Promise<BulkUpdateFiltersResponseV1>;
     static bulkUpdateFilters(options: BulkUpdateFiltersOptions): Promise<BulkUpdateFiltersResponse>;
+    /**
+     * Deletes a conversation view filter
+     *
+     * @param options - Configuration parameters for deleting the filter
+     *
+     * Required parameters:
+     * - `id` - (string) ID of the filter to delete
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetFiltersResponse | Filter | GetFiltersResponseV1 | FilterV1>} Promise resolving to remaining filters or deleted filter
+     *
+     * @example
+     * ```typescript
+     * await hitlApi.filters.deleteFilter({
+     *   id: 'filter-1',
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/filters` endpoint
+     * @public
+     */
     static deleteFilter(options: DeleteFilterOptionsV1): Promise<GetFiltersResponseV1 | FilterV1>;
     static deleteFilter(options: DeleteFilterOptions): Promise<GetFiltersResponse | Filter>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"Filters.d.ts","sourceRoot":"","sources":["../../../src/api/Filters.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,MAAM,EAKN,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAoBtC,qBAAa,OAAQ,SAAQ,QAAQ;IACnC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAa;IACxC,SAAS,CAAC,MAAM,CAAC,QAAQ,SAAU;IACnC,SAAS,CAAC,MAAM,CAAC,cAAc,WAQ7B;IACF,SAAS,CAAC,MAAM,CAAC,oBAAoB,kBAA4B;WA8BnD,UAAU,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WACvE,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;WA0CnE,cAAc,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAC/E,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC;WAqE3E,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;WAC/D,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;WA2D3D,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;WAC/D,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;WA+C3D,iBAAiB,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,CAAC;WAC5F,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,yBAAyB,CAAC;WAiDxF,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,GAAG,QAAQ,CAAC;WACtF,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC;CAW/F"}
+{"version":3,"file":"Filters.d.ts","sourceRoot":"","sources":["../../../src/api/Filters.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,MAAM,EAKN,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,OAAQ,SAAQ,QAAQ;IACnC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAa;IACxC,SAAS,CAAC,MAAM,CAAC,QAAQ,SAAU;IACnC,SAAS,CAAC,MAAM,CAAC,cAAc,WAQ7B;IACF,SAAS,CAAC,MAAM,CAAC,oBAAoB,kBAA4B;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;WACW,UAAU,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WACvE,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAkBjF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACW,cAAc,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAC/E,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAezF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;WACW,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;WAC/D,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;WACW,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;WAC/D,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACW,iBAAiB,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,CAAC;WAC5F,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAwBtG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACW,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,GAAG,QAAQ,CAAC;WACtF,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC;CAW/F"}

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

@@ -1,9 +1,42 @@
 import { ApiVersionOptions } from '../types';
 import { CleanUpDuplicatesResponse } from '../types/helpers';
 import { HITLBase } from './HITLBase';
+/**
+ * Provides helper utilities for the HITL system
+ *
+ * This class contains utility methods for maintaining and cleaning up
+ * system data, such as removing duplicate contacts.
+ *
+ * Key features:
+ * - Clean up duplicate contacts
+ *
+ * @remarks
+ * - All methods in this class interact with the `/helpers` endpoint
+ * @public
+ */
 export declare class Helpers extends HITLBase {
     protected static MODULE_URL: string;
     protected static CLEAN_CONTACTS: string;
+    /**
+     * Deletes duplicate contacts from Tables-based contacts (v1)
+     *
+     * @param options - Configuration parameters for the cleanup operation
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<CleanUpDuplicatesResponse>} Promise resolving to the cleanup operation results
+     *
+     * @example
+     * ```typescript
+     * const result = await hitlApi.helpers.deleteContactDuplicates();
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/helpers/clean-contact-duplicates` endpoint
+     * @public
+     */
     static deleteContactDuplicates(options: ApiVersionOptions): Promise<CleanUpDuplicatesResponse>;
 }
 //# sourceMappingURL=Helpers.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Helpers.d.ts","sourceRoot":"","sources":["../../../src/api/Helpers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAetC,qBAAa,OAAQ,SAAQ,QAAQ;IACnC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAa;IACxC,SAAS,CAAC,MAAM,CAAC,cAAc,SAA8B;WAsBzC,uBAAuB,CACzC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,yBAAyB,CAAC;CAUtC"}
+{"version":3,"file":"Helpers.d.ts","sourceRoot":"","sources":["../../../src/api/Helpers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,qBAAa,OAAQ,SAAQ,QAAQ;IACnC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAa;IACxC,SAAS,CAAC,MAAM,CAAC,cAAc,SAA8B;IAE7D;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,uBAAuB,CACzC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,yBAAyB,CAAC;CAUtC"}

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

@@ -1,12 +1,162 @@
 import { Listener, GetListenersOptions, GetListenerByIdOptions, GetListenersResponse, CreateListenersOptions, UpdateListenersOptions, DeleteListenersOptions } from '../types/listeners';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages HitL event listeners in the system
+ *
+ * This class provides functionality to manage event listeners, which can be:
+ * - Active WebSocket connections in Agent UI
+ * - Flow event subscription callbacks
+ * - Mobile application push notification callbacks
+ *
+ * Key features:
+ * - Retrieve listeners (all or by ID)
+ * - Create new listeners
+ * - Update existing listeners
+ * - Delete listeners
+ *
+ * @remarks
+ * - All methods in this class interact with the `/listeners` endpoint
+ * @public
+ */
 export declare class Listeners extends HITLBase {
     protected static MODULE_URL: string;
     protected static LISTENER_VERSION_FIELD: "listenerVersion";
+    /**
+     * Retrieves a list of HitL event listeners
+     *
+     * @param options - Configuration parameters for retrieving listeners
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetListenersResponse>} Promise resolving to the listeners list
+     *
+     * @example
+     * ```typescript
+     * const listeners = await hitlApi.listeners.getListeners();
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/listeners` endpoint
+     * @public
+     */
     static getListeners(options?: GetListenersOptions): Promise<GetListenersResponse>;
+    /**
+     * Retrieves a specific HitL event listener by ID
+     *
+     * @param options - Configuration parameters for retrieving the listener
+     *
+     * Required parameters:
+     * - `callbackId` - (string) ID of the listener to retrieve
+     *
+     * Optional parameters:
+     * - `agentId` - (string) Agent ID to filter by
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetListenersResponse>} Promise resolving to the listener details
+     *
+     * @example
+     * ```typescript
+     * const listener = await hitlApi.listeners.getListenerById({
+     *   callbackId: 'listener-1'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/listeners/{callbackId}` endpoint
+     * @public
+     */
     static getListenerById({ agentId, callbackId, ...options }: GetListenerByIdOptions): Promise<GetListenersResponse>;
+    /**
+     * Creates a new HitL event listener
+     *
+     * @param options - Configuration parameters for creating the listener
+     *
+     * Required parameters:
+     * - `callback` - ({@link ListenerCallback}) Callback configuration for the listener
+     *
+     * Optional parameters:
+     * - `agentId` - (string) ID of the agent associated with the listener
+     * - `listenerVersion` - (number) Version of the listener
+     * - `sessionIds` - (string[]) Array of session IDs to associate with the listener
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `type` - (any) Type of the listener
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<Listener>} Promise resolving to the created listener
+     *
+     * @example
+     * ```typescript
+     * const newListener = await hitlApi.listeners.createListener({
+     *   callback: {
+     *     type: "sync",
+     *     expire: 1750940155085,
+     *     name: "MxPMqfr4PHcCGCw=",
+     *     v: 0
+     *   }
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/listeners` endpoint
+     * @public
+     */
     static createListener(options: CreateListenersOptions): Promise<Listener>;
+    /**
+     * Updates an existing HitL event listener
+     *
+     * @param options - Configuration parameters for updating the listener
+     *
+     * Required parameters:
+     * - `callbackId` - (string) ID of the listener to update
+     * - `sessionIds` - (string[]) list of subscribed sessions by this listener
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<Listener>} Promise resolving to the updated listener
+     *
+     * @example
+     * ```typescript
+     * const updatedListener = await hitlApi.listeners.updateListener({
+     *   callbackId: 'listener-1',
+     *   sessionIds: ['session-id-1']
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/listeners/{callbackId}` endpoint
+     * @public
+     */
     static updateListener({ callbackId, ...options }: UpdateListenersOptions): Promise<Listener>;
+    /**
+     * Deletes a HitL event listener
+     *
+     * @param options - Configuration parameters for deleting the listener
+     *
+     * Required parameters:
+     * - `callbackId` - (string) ID of the listener 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.listeners.deleteListener({
+     *   callbackId: 'listener-1',
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/listeners/{callbackId}` endpoint
+     * @public
+     */
     static deleteListener({ callbackId, ...options }: DeleteListenersOptions): Promise<void>;
 }
 //# sourceMappingURL=Listeners.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Listeners.d.ts","sourceRoot":"","sources":["../../../src/api/Listeners.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,QAAQ,EAGR,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAoBtC,qBAAa,SAAU,SAAQ,QAAQ;IACrC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAe;IAC1C,SAAS,CAAC,MAAM,CAAC,sBAAsB,oBAA8B;WAsBjD,YAAY,CAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,oBAAoB,CAAC;WAwCZ,eAAe,CACjC,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC1D,OAAO,CAAC,oBAAoB,CAAC;WA8CZ,cAAc,CAChC,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,QAAQ,CAAC;WA4CA,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,QAAQ,CAAC;WAwCA,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,IAAI,CAAC;CAUjB"}
+{"version":3,"file":"Listeners.d.ts","sourceRoot":"","sources":["../../../src/api/Listeners.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,QAAQ,EAGR,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,SAAU,SAAQ,QAAQ;IACrC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAe;IAC1C,SAAS,CAAC,MAAM,CAAC,sBAAsB,oBAA8B;IAErE;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,YAAY,CAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,eAAe,CACjC,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC1D,OAAO,CAAC,oBAAoB,CAAC;IAYhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;WACiB,cAAc,CAChC,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,QAAQ,CAAC;IAiBpB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,IAAI,CAAC;CAUjB"}