@or-sdk/hitl 0.36.1 → 0.36.2

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

@@ -1,129 +1,9 @@
 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;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"}
+{"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"}

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

@@ -1,141 +1,10 @@
 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;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"}
+{"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"}

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

@@ -1,145 +1,10 @@
 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;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"}
+{"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"}

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

@@ -1,235 +1,20 @@
 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;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"}
+{"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"}