@or-sdk/hitl 0.36.1 → 0.36.2

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

@@ -1,160 +1,15 @@
 import { GetNewEventsCountOptions, GetNewEventsCountResponse, SaveLastReadEventOptions } from '../types/read-events';
 import { GetSessionEventsOptions, GetSessionEventsResponse, AddEventsOptions, AddEventsResponse, GetBulkSessionEventsOptions, GetBulkSessionsEventsResponse } from '../types/session-events';
 import { HITLBase } from './HITLBase';
-/**
- * Manages events for Human-in-the-Loop (HitL) sessions
- *
- * This class provides functionality to:
- * - Retrieve and manage session events
- * - Track event read status
- * - Handle bulk event operations
- * - Manage event counts
- *
- * @remarks
- * - All methods interact with the `/session-events` endpoint
- * @public
- */
 export declare class SessionEvents extends HITLBase {
     protected static MODULE_URL: string;
     protected static GET_BULK_EVENTS_URL: string;
     protected static GET_EVENTS_COUNT_URL: string;
     protected static SAVE_READ_EVENT_URL: string;
-    /**
-     * Retrieves events for a specific HitL session
-     *
-     * @param options - Configuration parameters for retrieving session events
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of the session to retrieve events for
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<SessionEvent[]>} Promise resolving to the list of session events
-     *
-     * @example
-     * ```typescript
-     * const events = await hitlApi.sessionEvents.getSessionEventsList({
-     *   sessionId: 'session-id'
-     * });
-     * ```
-     *
-     * @remarks Makes a GET request to `/session-events`
-     * @public
-     */
     static getSessionEventsList(options: GetSessionEventsOptions): Promise<GetSessionEventsResponse>;
-    /**
-     * Retrieves events for multiple HitL sessions in bulk
-     *
-     * @param options - Configuration parameters for bulk event retrieval
-     *
-     * Required parameters:
-     * - `sessionIds` - (string[]) Array of session IDs to retrieve events for
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetBulkSessionsEventsResponse>} Promise resolving to events for multiple sessions
-     *
-     * @example
-     * ```typescript
-     * const bulkEvents = await hitlApi.sessionEvents.getBulkSessionEventsList({
-     *   sessionIds: ['session-id-1', 'session-id-2']
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/session-events/bulk`
-     * @public
-     */
     static getBulkSessionEventsList(options: GetBulkSessionEventsOptions): Promise<GetBulkSessionsEventsResponse>;
-    /**
-     * Adds new events to a HITL session
-     *
-     * @param options - Configuration parameters for adding session events
-     *
-     * Required parameters:
-     * - `events` - (Partial<SessionEvent>[]) Array of partial event objects
-     * - `sessionId` - (string) ID of the session to add events to
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<AddEventsResult>} Promise resolving to the add operation result
-     *
-     * @example
-     * ```typescript
-     * const result = await hitlApi.sessionEvents.addEvents({
-     *   sessionId: 'session-id',
-     *   events: [
-     *     { type: 'message', content: 'Hello' },
-     *     { type: 'status', content: 'typing' }
-     *   ]
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/session-events`
-     * @public
-     */
     static addEvents({ sessionId, events, ...options }: AddEventsOptions): Promise<AddEventsResponse>;
-    /**
-     * Retrieves count of unread events for specified sessions
-     *
-     * @param options - Configuration parameters for retrieving unread events count
-     *
-     * Required parameters:
-     * - `sessionIds` - (string[]) Array of session IDs to get events count for
-     *
-     * Optional parameters:
-     * - `agentId` - (string) ID of the agent to get unread events for
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<NewEventsCount>} Promise resolving to the unread events count
-     *
-     * @example
-     * ```typescript
-     * // Basic usage with required parameters
-     * const count = await hitlApi.sessionEvents.getNewEventsCount({
-     *   sessionIds: ['session-id-1', 'session-id-2']
-     * });
-     * ```
-     *
-     * @remarks Makes a GET request to `/sessions-events/get-new-events`
-     * @public
-     */
     static getNewEventsCount({ agentId, ...options }: GetNewEventsCountOptions): Promise<GetNewEventsCountResponse>;
-    /**
-     * Records the last read event for a specific session
-     *
-     * @param options - Configuration parameters for saving last read event
-     *
-     * Required parameters:
-     * - `eventId` - (string) ID of the last read event
-     * - `eventTimestamp` - (string | number) Timestamp of the last read event
-     * - `sessionId` - (string) ID of the session
-     *
-     * Optional parameters:
-     * - `agentId` - (string) ID of the agent who read the event
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<void>} Promise resolving when the read status is saved
-     *
-     * @example
-     * ```typescript
-     * await hitlApi.sessionEvents.saveLastReadEvent({
-     *   sessionId: 'session-id-1',
-     *   eventId: 'event-id-2',
-     *   eventTimestamp: Date.now()
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/sessions-events/save-read-event`
-     * @public
-     */
     static saveReadEventByUserId({ agentId, ...options }: SaveLastReadEventOptions): Promise<void>;
 }
 //# sourceMappingURL=SessionEvents.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SessionEvents.d.ts","sourceRoot":"","sources":["../../../src/api/SessionEvents.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAGL,uBAAuB,EACvB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,2BAA2B,EAC3B,6BAA6B,EAC9B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,qBAAa,aAAc,SAAQ,QAAQ;IACzC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAoB;IAC/C,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAU;IAC9C,SAAS,CAAC,MAAM,CAAC,oBAAoB,SAAoB;IACzD,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAqB;IAEzD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,oBAAoB,CACtC,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAcpC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,wBAAwB,CAC1C,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,6BAA6B,CAAC;IAezC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACW,SAAS,CACrB,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,gBAAgB,GAClD,OAAO,CAAC,iBAAiB,CAAC;IAY7B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,iBAAiB,CACnC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GAChD,OAAO,CAAC,yBAAyB,CAAC;IAgBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,qBAAqB,CACvC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GAChD,OAAO,CAAC,IAAI,CAAC;CAejB"}
+{"version":3,"file":"SessionEvents.d.ts","sourceRoot":"","sources":["../../../src/api/SessionEvents.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAGL,uBAAuB,EACvB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,2BAA2B,EAC3B,6BAA6B,EAC9B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAetC,qBAAa,aAAc,SAAQ,QAAQ;IACzC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAoB;IAC/C,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAU;IAC9C,SAAS,CAAC,MAAM,CAAC,oBAAoB,SAAoB;IACzD,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAqB;WA0BrC,oBAAoB,CACtC,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;WAsChB,wBAAwB,CAC1C,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,6BAA6B,CAAC;WA4C3B,SAAS,CACrB,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,gBAAgB,GAClD,OAAO,CAAC,iBAAiB,CAAC;WAsCT,iBAAiB,CACnC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GAChD,OAAO,CAAC,yBAAyB,CAAC;WA6CjB,qBAAqB,CACvC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GAChD,OAAO,CAAC,IAAI,CAAC;CAejB"}

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

@@ -1,19 +1,5 @@
 import { Session, GetSessionsOptions, GetSessionByIdOptions, GetSessionsResponse, GetQueueSessionOptions, GetQueueSessionResponse, SearchSessionsOptions, SearchSessionsResponse, SearchSessionsWithContactsOptions, SearchSessionsWithContactsResponse, GetInitTriggersOptions, GetInitTriggersResponse, ClaimSessionByAgentOptions, StartConversationOptions, TransferToBotOptions, UpdateSessionOptions, CloseSessionOptions, ReopenSessionOptions, DeleteClosedSessionOptions, CreateSessionsOptions, CreateSessionsResponse, BulkDeleteSessionsOptions } from '../types/sessions';
 import { HITLBase } from './HITLBase';
-/**
- * Manages Human-in-the-Loop sessions and related operations
- *
- * This class provides functionality to:
- * - Manage session lifecycle (create, update, close, reopen, delete)
- * - Handle session assignments and transfers
- * - Search and retrieve sessions
- * - Manage queue sessions
- *
- * @remarks
- * - Makes requests to the `/sessions` endpoints
- * - For the methods `claimSessionByAgent` and `searchSessionsWithContacts`, you must include `{ version: 2 }` in the parameters for the method to execute correctly.
- * @public
- */
 export declare class Sessions extends HITLBase {
     protected static MODULE_URL: string;
     protected static SEARCH_URL: "search";
@@ -25,460 +11,21 @@ export declare class Sessions extends HITLBase {
     protected static START_CONVERSATION_URL: "start-conversation";
     protected static CLOSE_URL: "close";
     protected static REOPEN_URL: "reopen";
-    /**
-     * Retrieves a list of HITL sessions
-     *
-     * @param options - Configuration parameters for retrieving sessions
-     *
-     * Optional parameters:
-     * - `agentId` - (string) ID of agent to filter sessions by
-     * - `contactId` - (string) ID of contact to filter sessions by
-     * - `ignoreRuleTags` - (boolean) Whether to ignore rule tags in filtering
-     * - `limit` - (number) Maximum number of sessions to return
-     * - `order` - ('asc' | 'desc') Sort order direction
-     * - `orderBy` - (string) Field to sort results by
-     * - `page` - ({@link PageOptions}) Pagination options
-     * - `projection` - (string[]) Fields to include in the response
-     * - `status` - (string[]) Filter by session status(es)
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetSessionsResponse>} Promise resolving to list of sessions
-     *
-     * @example
-     * ```typescript
-     * // Get all active sessions for an agent
-     * const sessions = await hitlApi.sessions.getSessions({
-     *   status: ['ONGOING', 'CLAIMED'],
-     *   limit: 50
-     * });
-     * ```
-     *
-     * @remarks Makes a GET request to `/hitl/sessions`
-     */
     static getSessions(options?: GetSessionsOptions): Promise<GetSessionsResponse>;
-    /**
-     * Retrieves a specific HitL session by ID
-     *
-     * @param options - Configuration parameters for retrieving a session
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of the session to retrieve
-     *
-     * Optional parameters:
-     * - `agentId` - (string) ID of agent accessing the session
-     * - `ignoreRuleTags` - (boolean) Whether to ignore rule tags in filtering
-     * - `projection` - (string[]) Fields to include in the response
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Session>} Promise resolving to session details
-     *
-     * @example
-     * ```typescript
-     * const session = await hitlApi.sessions.getSessionById({
-     *   sessionId: 'session-id-1',
-     *   projection: ['hitlSessionId', 'status', 'transcript']
-     * });
-     * ```
-     *
-     * @remarks Makes a GET request to `/sessions/{sessionId}`
-     */
     static getSessionById({ agentId, projection, ...options }: GetSessionByIdOptions): Promise<Session>;
-    /**
-     * Searches for HitL sessions based on provided criteria
-     *
-     * @param options - Search configuration and filters
-     *
-     * Optional parameters:
-     * - `agentId` - (string) Filter by assigned agent
-     * - `claimedBy` - (string) Filter by currently assigned agent
-     * - `claimedByHistory` - (string) Filter by previously assigned agent
-     * - `contactIds` - (string[]) Array of contact IDs to filter by
-     * - `dateRange` - (DateRangeOptions) Date range filtering options
-     * - `meta` - (Record<string, string | number | boolean | MetaWithCondition>) Metadata filters
-     * - `needsAction` - (boolean) Filter sessions requiring action
-     * - `searchPhrase` - (string) Text search query
-     * - `sessionIds` - (string[]) Array of session IDs to filter by
-     * - `sessionsSearchOptions` - (SessionSearchOptions) Additional search configuration
-     * - `status` - (string[]) Filter by session status(es)
-     * - `tags` - (TagsQuery | string[]) Filter by tags
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `type` - (string) Filter by session type
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<SearchSessionsResponse>} Promise resolving to search results
-     *
-     * @example
-     * ```typescript
-     * // Search by different options
-     * const results = await hitlApi.sessions.searchSessions({
-     *   claimedBy: BASIC_USER_ID,
-     *   status: ['ONGOING', 'CLAIMED'],
-     *   tags: ['wait_for_agent'],
-     *   type: 'SMS',
-     *   limit: 25
-     * });
-     *
-     * // Search by meta with conditions
-     * const results = await hitlApi.sessions.searchSessions({
-     *   meta: {
-     *      botIdentifier: { value: botIdentifier, condition: 'IS_EQUAL' },
-     *      hiddenFromHistory: { value: true, condition: 'IS_NOT_EQUAL' },
-     *      userIdentifier: { value: userIdentifier1.slice(3), condition: 'CONTAINS' },
-     *   },
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/sessions/search`
-     */
     static searchSessions({ agentId, ...options }?: SearchSessionsOptions): Promise<SearchSessionsResponse>;
-    /**
-     * Searches for HitL sessions and includes associated contact information
-     *
-     * @param options - Search configuration including contact-related filters
-     *
-     * Optional parameters:
-     * - `agentId` - (string) Filter by assigned agent
-     * - `contact` - (ContactSearchParams) Contact search parameters
-     * - `contactsSearchOptions` - (ContactSearchOptions) Additional contact search configuration
-     * - `dateRange` - (DateRangeOptions) Date range filtering options
-     * - `searchPhrase` - (string) Text search query
-     * - `sessionsSearchOptions` - (SessionSearchOptions) Additional session search configuration
-     * - `tags` - (string[]) Filter by tags
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<SearchSessionsWithContactsResponse>} Promise resolving to sessions with contact details
-     *
-     * @example
-     * ```typescript
-     * const results = await hitlApi.sessions.searchSessionsWithContacts({
-     *   searchPhrase: 'billing issue',
-     *   tags: ['vip', 'missed'],
-     *   limit: 10,
-     *   version: 2
-     * });
-     *
-     * // Search sessions by contact info
-     * const results = await hitlApi.sessions.searchSessionsWithContacts({
-     *   contact: { name: 'Alison' },
-     *   contactsSearchOptions: { size: 2 },
-     *   version: 2
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/sessions/search-with-contacts`
-     */
     static searchSessionsWithContacts({ agentId, ...options }?: SearchSessionsWithContactsOptions): Promise<SearchSessionsWithContactsResponse>;
-    /**
-     * Retrieves the next session in NEEDS_ACTION state from the queue
-     *
-     * @param options - Queue configuration including agent and rule tags
-     *
-     * Required parameters:
-     * - `agentId` - (string) ID of agent requesting next session
-     *
-     * Optional parameters:
-     * - `ruleTags` - (string[]) Filter sessions by rule tags
-     * - `ignoreRuleTags` - (boolean) Whether to ignore rule tags in filtering
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetQueueSessionResponse>} Promise resolving to next available session
-     *
-     * @example
-     * ```typescript
-     * // Get next session for agent
-     * const session = await hitlApi.sessions.getQueueSession({
-     *   agentId: 'agent-id'
-     * });
-     * ```
-     *
-     * @remarks Makes a GET request to `sessions/helpers/queue`
-     */
     static getQueueSession({ agentId, ruleTags, ...options }: GetQueueSessionOptions): Promise<GetQueueSessionResponse>;
-    /**
-     * Retrieves available initialization triggers for starting new HitL sessions
-     *
-     * @param options - Configuration parameters for trigger retrieval
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetInitTriggersResponse>} Promise resolving to available triggers
-     *
-     * @example
-     * ```typescript
-     * // Get all available triggers
-     * const triggers = await hitlApi.sessions.getSessionInitTriggers();
-     * ```
-     *
-     * @remarks Makes a GET request to `/sessions/helpers/triggers`
-     */
     static getSessionInitTriggers(options?: GetInitTriggersOptions): Promise<GetInitTriggersResponse>;
-    /**
-     * Claims a session for a specific agent
-     *
-     * @param options - Claim configuration including agent and parameters
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of session to claim
-     * - `claimBy` - (string) ID of agent claiming the session
-     *
-     * Optional parameters:
-     * - `params` - (object) Additional claim parameters
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Session>} Promise resolving to the claimed session
-     * @remarks Makes a POST request to `/api/v2/hitl/sessions/{sessionId}/claim`
-     *
-     * @example
-     * ```typescript
-     * // Claim session by current token agent
-     * const session = await hitlApi.sessions.claimSessionByAgent({
-     *   sessionId: 'session-id',
-     *   version: 2
-     * });
-     * ```
-     */
     static claimSessionByAgent({ claimBy, params, ...options }: ClaimSessionByAgentOptions): Promise<Session>;
-    /**
-     * Transfers session control back to the bot
-     *
-     * @param options - Transfer configuration including agent and parameters
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of session to transfer
-     * - `agentId` - (string) ID of agent transferring the session
-     *
-     * Optional parameters:
-     * - `params` - (object) Additional transfer parameters
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Session>} Promise resolving to transferred session
-     * @remarks Makes a POST request to `/api/v2/hitl/sessions/{sessionId}/transfer-to-bot`
-     *
-     * @example
-     * ```typescript
-     * // Basic transfer
-     * const session = await hitlApi.sessions.transferToBot({
-     *   sessionId: 'session-id',
-     * });
-     * ```
-     */
     static transferToBot({ agentId, params, ...options }: TransferToBotOptions): Promise<Session>;
-    /**
-     * Initiates a new conversation session
-     *
-     * @param options - Conversation configuration including contact and trigger details
-     *
-     * Required parameters:
-     * - `contactId` - (string) ID of contact to start conversation with
-     * - `triggerId` - (string) ID of trigger to initiate conversation
-     *
-     * Optional parameters:
-     * - `params` - (object) Additional conversation parameters
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Session>} Promise resolving to new session
-     *
-     * @example
-     * ```typescript
-     * // Start basic conversation
-     * const session = await hitlApi.sessions.startConversation({
-     *   contactId: 'contact-id-1',
-     *   triggerId: 'trigger-id-2'
-     * });
-     *
-     * // Start conversation with parameters
-     * const session = await hitlApi.sessions.startConversation({
-     *   contactId: 'contact-id',
-     *   triggerId: 'hitl/init-conversation/voice',
-     *   params: { visibilityTags: [] }
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/sessions/start-conversation`
-     */
     static startConversation({ contactId, triggerId, params, ...options }: StartConversationOptions): Promise<Session>;
-    /**
-     * Updates an existing session with new information
-     *
-     * @param options - Update configuration including tags and metadata
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of session to update
-     *
-     * Optional parameters:
-     * - `tags` - (string[]) New tags for the session
-     * - `contactId` - (string) Updated contact ID
-     * - `meta` - (object) Updated metadata
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Session>} Promise resolving to updated session
-     *
-     * @example
-     * ```typescript
-     * const session = await hitlApi.sessions.updateSession({
-     *   sessionId: 'session-id',
-     *   tags: ['support'],
-     *   meta: {
-     *     status: 'in-progress',
-     *     priority: 'high',
-     *     notes: 'Customer requesting callback'
-     *   }
-     * });
-     * ```
-     *
-     * @remarks Makes a PUT request to `/sessions/{sessionId}`
-     */
     static updateSession({ sessionId, tags, contactId, meta, ...options }: UpdateSessionOptions): Promise<Session>;
-    /**
-     * Creates multiple sessions in bulk
-     *
-     * @param options - Bulk creation configuration including session details
-     *
-     * Required parameters:
-     * - `sessions` - ({@link Session}[]) Array of session configurations to create
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<CreateSessionsResponse>} Promise resolving to creation results
-     *
-     * @example
-     * ```typescript
-     * const created = await hitlApi.sessions.createSessions({
-     *   sessions: [
-     *     {
-     *       hitlSessionId: 'session-id',
-     *       contactId: 'contact-id-1',
-     *       status: 'CLOSED',
-     *       isArchived: true,
-     *       createdAt: new Date('1971'),
-     *       ruleTags: ['sms'],
-     *     },
-     *     {
-     *       contactId: 'contact-id-2',
-     *       status: 'ONGOING',
-     *       ruleTags: ['voice'],
-     *     },
-     *   ]
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/sessions`
-     */
     static createSessions({ sessions, ...options }: CreateSessionsOptions): Promise<CreateSessionsResponse>;
-    /**
-     * Closes an active session
-     *
-     * @param options - Close configuration including session identifier
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of session to close
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Session>} Promise resolving to closed session
-     *
-     * @example
-     * ```typescript
-     * // Close a session
-     * const session = await hitlApi.sessions.closeSession({
-     *   sessionId: 'session-id'
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `sessions/{sessionId}/close`
-     */
     static closeSession(options: CloseSessionOptions): Promise<Session>;
-    /**
-     * Reopens a previously closed session
-     *
-     * @param options - Reopen configuration including session identifier
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of session to reopen
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Session>} Promise resolving to reopened session
-     *
-     * @example
-     * ```typescript
-     * // Reopen a session
-     * const session = await hitlApi.sessions.reopenSession({
-     *   sessionId: 'session-id'
-     * });
-     * ```
-     *
-     * @remarks Makes a POST request to `/sessions/{sessionId}/reopen`
-     */
     static reopenSession(options: ReopenSessionOptions): Promise<Session>;
-    /**
-     * Deletes a closed session
-     *
-     * @param options - Delete configuration including session identifier
-     *
-     * Required parameters:
-     * - `sessionId` - (string) ID of session to delete
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<void>} Promise resolving when deletion is complete
-     *
-     * @example
-     * ```typescript
-     * // Delete a closed session
-     * await hitlApi.sessions.deleteClosedSession({
-     *   sessionId: 'session-id'
-     * });
-     * ```
-     *
-     * @remarks Makes a DELETE request to `/sessions/{sessionId}`
-     */
     static deleteClosedSession(options: DeleteClosedSessionOptions): Promise<unknown>;
-    /**
-     * @deprecated Use bulkDeleteSessions instead
-     */
     static buldDeleteSessions({ sessionIds, ...options }: BulkDeleteSessionsOptions): Promise<unknown>;
-    /**
-     * Deletes multiple sessions in bulk
-     *
-     * @param options - Bulk deletion configuration including session identifiers
-     *
-     * Required parameters:
-     * - `sessionIds` - (string[]) Array of session IDs to delete
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<void>} Promise resolving when deletion is complete
-     * @remarks Makes a DELETE request to `/api/v2/hitl/sessions`
-     *
-     * @example
-     * ```typescript
-     * // Delete multiple sessions
-     * await hitlApi.sessions.bulkDeleteSessions({
-     *   sessionIds: ['session-id-1', 'session-id-2', 'session-id-3']
-     * });
-     * ```
-     */
     static bulkDeleteSessions({ sessionIds, ...options }: BulkDeleteSessionsOptions): Promise<unknown>;
 }
 //# sourceMappingURL=Sessions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Sessions.d.ts","sourceRoot":"","sources":["../../../src/api/Sessions.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,OAAO,EAEP,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,iCAAiC,EACjC,kCAAkC,EAClC,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;GAaG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAc;IAEzC,SAAS,CAAC,MAAM,CAAC,UAAU,WAAqB;IAChD,SAAS,CAAC,MAAM,CAAC,wBAAwB,yBAAmC;IAC5E,SAAS,CAAC,MAAM,CAAC,gBAAgB,qBAA+B;IAChE,SAAS,CAAC,MAAM,CAAC,qBAAqB,kBAA4B;IAElE,SAAS,CAAC,MAAM,CAAC,SAAS,UAAoB;IAC9C,SAAS,CAAC,MAAM,CAAC,mBAAmB,oBAA8B;IAClE,SAAS,CAAC,MAAM,CAAC,sBAAsB,uBAAiC;IACxE,SAAS,CAAC,MAAM,CAAC,SAAS,UAAoB;IAC9C,SAAS,CAAC,MAAM,CAAC,UAAU,WAAqB;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,WAAW,CAC7B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC;IAc/B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,cAAc,CAChC,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,qBAAqB,GACzD,OAAO,CAAC,OAAO,CAAC;IAenB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;WACiB,cAAc,CAChC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAE,qBAA0B,GAClD,OAAO,CAAC,sBAAsB,CAAC;IAgBlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;WACiB,0BAA0B,CAC5C,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAE,iCAAsC,GAC9D,OAAO,CAAC,kCAAkC,CAAC;IAmB9C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,eAAe,CACjC,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACxD,OAAO,CAAC,uBAAuB,CAAC;IAenC;;;;;;;;;;;;;;;;;;OAkBG;WACiB,sBAAsB,CACxC,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,uBAAuB,CAAC;IAWnC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,mBAAmB,CACrC,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GAC1D,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,aAAa,CAC/B,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,oBAAoB,GACpD,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;WACiB,iBAAiB,CACnC,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GACrE,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;WACiB,aAAa,CAC/B,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,oBAAoB,GACrE,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;WACiB,cAAc,CAChC,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,qBAAqB,GAC9C,OAAO,CAAC,sBAAsB,CAAC;IAUlC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,YAAY,CAC9B,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,OAAO,CAAC;IAcnB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,aAAa,CAC/B,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,OAAO,CAAC;IAcnB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,mBAAmB,CACrC,OAAO,EAAE,0BAA0B;IAWrC;;OAEG;WACiB,kBAAkB,CACpC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,yBAAyB;IAQvD;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACiB,kBAAkB,CACpC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,yBAAyB;CAUxD"}
+{"version":3,"file":"Sessions.d.ts","sourceRoot":"","sources":["../../../src/api/Sessions.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,OAAO,EAEP,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,iCAAiC,EACjC,kCAAkC,EAClC,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAgBtC,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAc;IAEzC,SAAS,CAAC,MAAM,CAAC,UAAU,WAAqB;IAChD,SAAS,CAAC,MAAM,CAAC,wBAAwB,yBAAmC;IAC5E,SAAS,CAAC,MAAM,CAAC,gBAAgB,qBAA+B;IAChE,SAAS,CAAC,MAAM,CAAC,qBAAqB,kBAA4B;IAElE,SAAS,CAAC,MAAM,CAAC,SAAS,UAAoB;IAC9C,SAAS,CAAC,MAAM,CAAC,mBAAmB,oBAA8B;IAClE,SAAS,CAAC,MAAM,CAAC,sBAAsB,uBAAiC;IACxE,SAAS,CAAC,MAAM,CAAC,SAAS,UAAoB;IAC9C,SAAS,CAAC,MAAM,CAAC,UAAU,WAAqB;WAiC5B,WAAW,CAC7B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC;WAyCX,cAAc,CAChC,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,qBAAqB,GACzD,OAAO,CAAC,OAAO,CAAC;WA8DC,cAAc,CAChC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAE,qBAA0B,GAClD,OAAO,CAAC,sBAAsB,CAAC;WAqDd,0BAA0B,CAC5C,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAE,iCAAsC,GAC9D,OAAO,CAAC,kCAAkC,CAAC;WA6C1B,eAAe,CACjC,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACxD,OAAO,CAAC,uBAAuB,CAAC;WAkCf,sBAAsB,CACxC,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,uBAAuB,CAAC;WAqCf,mBAAmB,CACrC,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,0BAA0B,GAC1D,OAAO,CAAC,OAAO,CAAC;WAyCC,aAAa,CAC/B,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,oBAAoB,GACpD,OAAO,CAAC,OAAO,CAAC;WAkDC,iBAAiB,CACnC,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,EAAE,wBAAwB,GACrE,OAAO,CAAC,OAAO,CAAC;WAgDC,aAAa,CAC/B,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,oBAAoB,GACrE,OAAO,CAAC,OAAO,CAAC;WAqDC,cAAc,CAChC,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,qBAAqB,GAC9C,OAAO,CAAC,sBAAsB,CAAC;WAkCd,YAAY,CAC9B,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,OAAO,CAAC;WAuCC,aAAa,CAC/B,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,OAAO,CAAC;WAsCC,mBAAmB,CACrC,OAAO,EAAE,0BAA0B;WAcjB,kBAAkB,CACpC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,yBAAyB;WA+BnC,kBAAkB,CACpC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,yBAAyB;CAUxD"}