@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
45 lines (44 loc) • 1.61 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import AgentSessionHistoryResponse from '../../../models/AgentSessionHistoryResponse';
import AgentSessionListResponse from '../../../models/AgentSessionListResponse';
import AgentSessionResponse from '../../../models/AgentSessionResponse';
/**
* SessionsApi - object-oriented interface
* @export
* @class SessionsApi
* @extends {BaseAPI}
*/
export default class SessionsApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Create Agent Session
* @param {string} xUserId User ID used to scope agent sessions
* @throws {BitmovinError}
* @memberof SessionsApi
*/
create(): Promise<AgentSessionResponse>;
/**
* @summary Delete Agent Session
* @param {string} sessionId Id of the session
* @param {string} xUserId User ID used to scope agent sessions
* @throws {BitmovinError}
* @memberof SessionsApi
*/
delete(sessionId: string): Promise<AgentSessionResponse>;
/**
* @summary Get Agent Session Details
* @param {string} sessionId Id of the session
* @param {string} xUserId User ID used to scope agent sessions
* @throws {BitmovinError}
* @memberof SessionsApi
*/
get(sessionId: string): Promise<AgentSessionHistoryResponse>;
/**
* @summary List Agent Sessions
* @param {string} xUserId User ID used to scope agent sessions
* @throws {BitmovinError}
* @memberof SessionsApi
*/
list(): Promise<AgentSessionListResponse>;
}