plivo/dist/resources/maskingSession.d.ts

A Node.js SDK to make voice calls and send SMS using Plivo and to generate Plivo XML

export class CreateMaskingSessionResponse {
	constructor(params: object);
	apiId: string;
	sessionUuid:string;
	virtualNumber:string;
	message: string;
	session: object;
}
export class GetMaskingSessionResponse {
	constructor(params: object);
	apiId: string;
	response: object;
}
export class DeleteMaskingSessionResponse {
	constructor(params: object);
	apiId: string;
	message: string;
}
export class UpdateMaskingSessionResponse {
	constructor(params: object);
	apiId: string;
	message: string;
	session: object;
}
export class ListMaskingSessionResponse {
	constructor(params: object);
	apiId: string;
	response: object;
}
export class MaskingSession extends PlivoResource {
	constructor(client: Function, data ? : {});
	id: string;
    /**
	 * Update a masking session
	 * @method
	 * @param {string} sessionUuid - unique idenfier of a session
	 * @param {object} params - optional params to update a session
	 * @param {number} [params.sessionExpiry] - The duration in seconds for which the masking session will be active.
	 * @param {number} [params.callTimeLimit] - The maximum duration in seconds for each call in the masking session.
	 * @param {boolean} [params.record] - Indicates whether the calls in the masking session should be recorded.
	 * @param {string} [params.recordFileFormat] - The file format for the recorded calls.
	 * @param {string} [params.recordingCallbackUrl] - The URL to which the recording callback will be sent.
	 * @param {string} [params.callbackUrl] - The URL to which the callback for the masking session will be sent.
	 * @param {string} [params.callbackMethod] - The HTTP method for the callback request.
	 * @param {number} [params.ringTimeout] - The duration in seconds for which the call will ring before being canceled.
	 * @param {string} [params.firstPartyPlayUrl] - The URL to play audio to the first party when the call is established.
	 * @param {string} [params.secondPartyPlayUrl] - The URL to play audio to the second party when the call is established.
	 * @param {string} [params.recordingCallbackMethod] - The HTTP method for the recording callback request.
	 * @returns {Promise<PlivoGenericResponse>} - Resolves to a PlivoGenericResponse object
	 * @throws {Error} - Throws an error if the update masking session request fails
	 */
	updateMaskingSession(params ? : {}): Promise < UpdateMaskingSessionResponse > ;
    /**
     * Get a masking session
     * @method
	 * @param {string} sessionUuid - unique idenfier of a session
	 * @promise {object} returns PlivoGenericResponse Object
     * @fail {Error} returns Error
     */
	getMaskingSession(): Promise < GetMaskingSessionResponse > ;
	/**
     * Delete a masking session
     * @method
	 * @param {string} sessionUuid - unique idenfier of a session
	 * @promise {object} returns PlivoGenericResponse Object
     * @fail {Error} returns Error
     */
	deleteMaskingSession(): Promise < DeleteMaskingSessionResponse > ;

}

export class MaskingSessionInterface extends PlivoResourceInterface {
	constructor(client: Function, data ? : {});
    /**
     * Create a masking session
     * @method
     * @param {string} firstParty - The phone number or SIP endpoint of the first party.
     * @param {string} secondParty - The phone number or SIP endpoint of the second party.
     * @param {object} params - optional params to make a call
     * @param {number} [params.sessionExpiry]- The duration in seconds for which the masking session will be active.
     * @param {number} [params.callTimeLimit] - The maximum duration in seconds for each call in the masking session.
     * @param {boolean} [params.record] - Indicates whether the calls in the masking session should be recorded.
     * @param {string} [params.recordFileFormat] - The file format for the recorded calls.
     * @param {string} [params.recordingCallbackUrl] - The URL to which the recording callback will be sent.
     * @param {boolean} [params.initiateCallToFirstParty] - Indicates whether the call to the first party should be initiated automatically.
     * @param {string} [params.callbackUrl] - The URL to which the callback for the masking session will be sent.
     * @param {string} [params.callbackMethod] - The HTTP method for the callback request.
     * @param {number} [params.ringTimeout] - The duration in seconds for which the call will ring before being canceled.
     * @param {string} [params.firstPartyPlayUrl] - The URL to play audio to the first party when the call is established.
     * @param {string} [params.secondPartyPlayUrl] - The URL to play audio to the second party when the call is established.
     * @param {string} [params.recordingCallbackMethod] - The HTTP method for the recording callback request.
     * @promise {object} returns PlivoGenericResponse Object
     * @fail {Error} returns Error
     */
	createMaskingSession(firstParty: string, secondParty: string, params ? : {}): Promise < CreateMaskingSessionResponse > ;
	/**
	 * Update a masking session
	 * @method
	 * @param {string} sessionUuid - unique idenfier of a session
	 * @param {object} params - optional params to update a session
	 * @param {number} [params.sessionExpiry] - The duration in seconds for which the masking session will be active.
	 * @param {number} [params.callTimeLimit] - The maximum duration in seconds for each call in the masking session.
	 * @param {boolean} [params.record] - Indicates whether the calls in the masking session should be recorded.
	 * @param {string} [params.recordFileFormat] - The file format for the recorded calls.
	 * @param {string} [params.recordingCallbackUrl] - The URL to which the recording callback will be sent.
	 * @param {string} [params.callbackUrl] - The URL to which the callback for the masking session will be sent.
	 * @param {string} [params.callbackMethod] - The HTTP method for the callback request.
	 * @param {number} [params.ringTimeout] - The duration in seconds for which the call will ring before being canceled.
	 * @param {string} [params.firstPartyPlayUrl] - The URL to play audio to the first party when the call is established.
	 * @param {string} [params.secondPartyPlayUrl] - The URL to play audio to the second party when the call is established.
	 * @param {string} [params.recordingCallbackMethod] - The HTTP method for the recording callback request.
	 * @returns {Promise<PlivoGenericResponse>} - Resolves to a PlivoGenericResponse object
	 * @throws {Error} - Throws an error if the update masking session request fails
	 */
	updateMaskingSession(sessionUuid: string, params ? : {}): Promise < UpdateMaskingSessionResponse > ;
	/**
	 * List masking sessions with optional filters
	 * @method
	 * @param {object} filterParams - Optional filter parameters to list masking sessions
	 * @param {string} [filterParams.firstParty] - The phone number or SIP endpoint of the first party.
	 * @param {string} [filterParams.secondParty] - The phone number or SIP endpoint of the second party.
	 * @param {string} [filterParams.virtualNumber] - The virtual number associated with the masking session.
	 * @param {string} [filterParams.status] - The status of the masking session.
	 * @param {string} [filterParams.createdTimeEquals] - The specific created time to filter sessions.
	 * @param {string} [filterParams.createdTimeLessThan] - Filter sessions created before this time.
	 * @param {string} [filterParams.createdTimeGreaterThan] - Filter sessions created after this time.
	 * @param {string} [filterParams.createdTimeLessOrEqual] - Filter sessions created before or at this time.
	 * @param {string} [filterParams.createdTimeGreaterOrEqual] - Filter sessions created after or at this time.
	 * @param {string} [filterParams.expiryTimeEquals] - The specific expiry time to filter sessions.
	 * @param {string} [filterParams.expiryTimeLessThan] - Filter sessions expiring before this time.
	 * @param {string} [filterParams.expiryTimeGreaterThan] - Filter sessions expiring after this time.
	 * @param {string} [filterParams.expiryTimeLessOrEqual] - Filter sessions expiring before or at this time.
	 * @param {string} [filterParams.expiryTimeGreaterOrEqual] - Filter sessions expiring after or at this time.
	 * @param {number} [filterParams.durationEquals] - The duration in seconds to filter sessions.
	 * @param {number} [filterParams.durationLessThan] - Filter sessions with duration less than this value.
	 * @param {number} [filterParams.durationGreaterThan] - Filter sessions with duration greater than this value.
	 * @param {number} [filterParams.durationLessOrEqual] - Filter sessions with duration less than or equal to this value.
	 * @param {number} [filterParams.durationGreaterOrEqual] - Filter sessions with duration greater than or equal to this value.
	 * @param {number} [filterParams.limit] - The maximum number of sessions to retrieve.
	 * @param {number} [filterParams.offset] - The offset for paginated results.
	 * @returns {Promise<PlivoGenericResponse>} - Resolves to a PlivoGenericResponse object
	 * @throws {Error} - Throws an error if the list masking sessions request fails
	 */
	listMaskingSession(params ? : {}): Promise < ListMaskingSessionResponse > ;

	/**
     * Get a masking session
     * @method
	 * @param {string} sessionUuid - unique idenfier of a session
	 * @promise {object} returns PlivoGenericResponse Object
     * @fail {Error} returns Error
     */
	getMaskingSession(sessionUuid: string): Promise < GetMaskingSessionResponse > ;
	/**
     * Delete a masking session
     * @method
	 * @param {string} sessionUuid - unique idenfier of a session
	 * @promise {object} returns PlivoGenericResponse Object
     * @fail {Error} returns Error
     */
	deleteMaskingSession(sessionUuid: string): Promise < DeleteMaskingSessionResponse > ;
}
import {
  PlivoResource,
	PlivoResourceInterface
} from "../base";