twilio 4.0.1 → 4.0.2

package/lib/rest/insights/v1/conference.js

@@ -0,0 +1,248 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Insights
+ * This is the public Twilio REST API.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConferencePage = exports.ConferenceListInstance = exports.ConferenceInstance = exports.ConferenceContextImpl = void 0;
+const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../base/Page"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+const conferenceParticipant_1 = require("./conference/conferenceParticipant");
+class ConferenceContextImpl {
+    constructor(_version, conferenceSid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(conferenceSid)) {
+            throw new Error("Parameter 'conferenceSid' is not valid.");
+        }
+        this._solution = { conferenceSid };
+        this._uri = `/Conferences/${conferenceSid}`;
+    }
+    get conferenceParticipants() {
+        this._conferenceParticipants =
+            this._conferenceParticipants ||
+                (0, conferenceParticipant_1.ConferenceParticipantListInstance)(this._version, this._solution.conferenceSid);
+        return this._conferenceParticipants;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new ConferenceInstance(operationVersion, payload, instance._solution.conferenceSid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return this._solution;
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ConferenceContextImpl = ConferenceContextImpl;
+class ConferenceInstance {
+    constructor(_version, payload, conferenceSid) {
+        this._version = _version;
+        this.conferenceSid = payload.conference_sid;
+        this.accountSid = payload.account_sid;
+        this.friendlyName = payload.friendly_name;
+        this.createTime = deserialize.iso8601DateTime(payload.create_time);
+        this.startTime = deserialize.iso8601DateTime(payload.start_time);
+        this.endTime = deserialize.iso8601DateTime(payload.end_time);
+        this.durationSeconds = deserialize.integer(payload.duration_seconds);
+        this.connectDurationSeconds = deserialize.integer(payload.connect_duration_seconds);
+        this.status = payload.status;
+        this.maxParticipants = deserialize.integer(payload.max_participants);
+        this.maxConcurrentParticipants = deserialize.integer(payload.max_concurrent_participants);
+        this.uniqueParticipants = deserialize.integer(payload.unique_participants);
+        this.endReason = payload.end_reason;
+        this.endedBy = payload.ended_by;
+        this.mixerRegion = payload.mixer_region;
+        this.mixerRegionRequested = payload.mixer_region_requested;
+        this.recordingEnabled = payload.recording_enabled;
+        this.detectedIssues = payload.detected_issues;
+        this.tags = payload.tags;
+        this.tagInfo = payload.tag_info;
+        this.processingState = payload.processing_state;
+        this.url = payload.url;
+        this.links = payload.links;
+        this._solution = { conferenceSid: conferenceSid || this.conferenceSid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new ConferenceContextImpl(this._version, this._solution.conferenceSid);
+        return this._context;
+    }
+    /**
+     * Fetch a ConferenceInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ConferenceInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Access the conferenceParticipants.
+     */
+    conferenceParticipants() {
+        return this._proxy.conferenceParticipants;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            conferenceSid: this.conferenceSid,
+            accountSid: this.accountSid,
+            friendlyName: this.friendlyName,
+            createTime: this.createTime,
+            startTime: this.startTime,
+            endTime: this.endTime,
+            durationSeconds: this.durationSeconds,
+            connectDurationSeconds: this.connectDurationSeconds,
+            status: this.status,
+            maxParticipants: this.maxParticipants,
+            maxConcurrentParticipants: this.maxConcurrentParticipants,
+            uniqueParticipants: this.uniqueParticipants,
+            endReason: this.endReason,
+            endedBy: this.endedBy,
+            mixerRegion: this.mixerRegion,
+            mixerRegionRequested: this.mixerRegionRequested,
+            recordingEnabled: this.recordingEnabled,
+            detectedIssues: this.detectedIssues,
+            tags: this.tags,
+            tagInfo: this.tagInfo,
+            processingState: this.processingState,
+            url: this.url,
+            links: this.links,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ConferenceInstance = ConferenceInstance;
+function ConferenceListInstance(version) {
+    const instance = ((conferenceSid) => instance.get(conferenceSid));
+    instance.get = function get(conferenceSid) {
+        return new ConferenceContextImpl(version, conferenceSid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Conferences`;
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["conferenceSid"] !== undefined)
+            data["ConferenceSid"] = params["conferenceSid"];
+        if (params["friendlyName"] !== undefined)
+            data["FriendlyName"] = params["friendlyName"];
+        if (params["status"] !== undefined)
+            data["Status"] = params["status"];
+        if (params["createdAfter"] !== undefined)
+            data["CreatedAfter"] = params["createdAfter"];
+        if (params["createdBefore"] !== undefined)
+            data["CreatedBefore"] = params["createdBefore"];
+        if (params["mixerRegion"] !== undefined)
+            data["MixerRegion"] = params["mixerRegion"];
+        if (params["tags"] !== undefined)
+            data["Tags"] = params["tags"];
+        if (params["subaccount"] !== undefined)
+            data["Subaccount"] = params["subaccount"];
+        if (params["detectedIssues"] !== undefined)
+            data["DetectedIssues"] = params["detectedIssues"];
+        if (params["endReason"] !== undefined)
+            data["EndReason"] = params["endReason"];
+        if (params["pageSize"] !== undefined)
+            data["PageSize"] = params["pageSize"];
+        if (params.pageNumber !== undefined)
+            data["Page"] = params.pageNumber;
+        if (params.pageToken !== undefined)
+            data["PageToken"] = params.pageToken;
+        const headers = {};
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new ConferencePage(operationVersion, payload, instance._solution));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.list = instance._version.list;
+    instance.getPage = function getPage(targetUrl, callback) {
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((payload) => new ConferencePage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    instance.toJSON = function toJSON() {
+        return instance._solution;
+    };
+    instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
+        return (0, util_1.inspect)(instance.toJSON(), options);
+    };
+    return instance;
+}
+exports.ConferenceListInstance = ConferenceListInstance;
+class ConferencePage extends Page_1.default {
+    /**
+     * Initialize the ConferencePage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version, response, solution) {
+        super(version, response, solution);
+    }
+    /**
+     * Build an instance of ConferenceInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new ConferenceInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ConferencePage = ConferencePage;

package/lib/rest/insights/v1/room/participant.d.ts

@@ -0,0 +1,280 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import V1 from "../../V1";
+type VideoParticipantSummaryCodec = "VP8" | "H264" | "VP9";
+type VideoParticipantSummaryEdgeLocation = "ashburn" | "dublin" | "frankfurt" | "singapore" | "sydney" | "sao_paulo" | "roaming" | "umatilla" | "tokyo";
+type VideoParticipantSummaryRoomStatus = "in_progress" | "completed";
+type VideoParticipantSummaryTwilioRealm = "us1" | "us2" | "au1" | "br1" | "ie1" | "jp1" | "sg1" | "in1" | "de1" | "gll";
+/**
+ * Options to pass to each
+ */
+export interface ParticipantListInstanceEachOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: ParticipantInstance, done: (err?: Error) => void) => void;
+    /** Function to be called upon completion of streaming */
+    done?: Function;
+    /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to list
+ */
+export interface ParticipantListInstanceOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to page
+ */
+export interface ParticipantListInstancePageOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
+export interface ParticipantContext {
+    /**
+     * Fetch a ParticipantInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ParticipantInstance
+     */
+    fetch(callback?: (error: Error | null, item?: ParticipantInstance) => any): Promise<ParticipantInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface ParticipantContextSolution {
+    roomSid: string;
+    participantSid: string;
+}
+export declare class ParticipantContextImpl implements ParticipantContext {
+    protected _version: V1;
+    protected _solution: ParticipantContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, roomSid: string, participantSid: string);
+    fetch(callback?: (error: Error | null, item?: ParticipantInstance) => any): Promise<ParticipantInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): ParticipantContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface ParticipantPayload extends TwilioResponsePayload {
+    participants: ParticipantResource[];
+}
+interface ParticipantResource {
+    participant_sid: string;
+    participant_identity: string;
+    join_time: Date;
+    leave_time: Date;
+    duration_sec: number;
+    account_sid: string;
+    room_sid: string;
+    status: VideoParticipantSummaryRoomStatus;
+    codecs: Array<VideoParticipantSummaryCodec>;
+    end_reason: string;
+    error_code: number;
+    error_code_url: string;
+    media_region: VideoParticipantSummaryTwilioRealm;
+    properties: any;
+    edge_location: VideoParticipantSummaryEdgeLocation;
+    publisher_info: any;
+    url: string;
+}
+export declare class ParticipantInstance {
+    protected _version: V1;
+    protected _solution: ParticipantContextSolution;
+    protected _context?: ParticipantContext;
+    constructor(_version: V1, payload: ParticipantResource, roomSid: string, participantSid?: string);
+    /**
+     * Unique identifier for the participant.
+     */
+    participantSid: string;
+    /**
+     * The application-defined string that uniquely identifies the participant within a Room.
+     */
+    participantIdentity: string;
+    /**
+     * When the participant joined the room.
+     */
+    joinTime: Date;
+    /**
+     * When the participant left the room.
+     */
+    leaveTime: Date;
+    /**
+     * Amount of time in seconds the participant was in the room.
+     */
+    durationSec: number;
+    /**
+     * Account SID associated with the room.
+     */
+    accountSid: string;
+    /**
+     * Unique identifier for the room.
+     */
+    roomSid: string;
+    status: VideoParticipantSummaryRoomStatus;
+    /**
+     * Codecs detected from the participant. Can be `VP8`, `H264`, or `VP9`.
+     */
+    codecs: Array<VideoParticipantSummaryCodec>;
+    /**
+     * Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#end_reason).
+     */
+    endReason: string;
+    /**
+     * Errors encountered by the participant.
+     */
+    errorCode: number;
+    /**
+     * Twilio error code dictionary link.
+     */
+    errorCodeUrl: string;
+    mediaRegion: VideoParticipantSummaryTwilioRealm;
+    /**
+     * Object containing information about the participant\'s data from the room. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#properties) for more information.
+     */
+    properties: any;
+    edgeLocation: VideoParticipantSummaryEdgeLocation;
+    /**
+     * Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#publisher_info) for more information.
+     */
+    publisherInfo: any;
+    /**
+     * URL of the participant resource.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Fetch a ParticipantInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ParticipantInstance
+     */
+    fetch(callback?: (error: Error | null, item?: ParticipantInstance) => any): Promise<ParticipantInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        participantSid: string;
+        participantIdentity: string;
+        joinTime: Date;
+        leaveTime: Date;
+        durationSec: number;
+        accountSid: string;
+        roomSid: string;
+        status: VideoParticipantSummaryRoomStatus;
+        codecs: VideoParticipantSummaryCodec[];
+        endReason: string;
+        errorCode: number;
+        errorCodeUrl: string;
+        mediaRegion: VideoParticipantSummaryTwilioRealm;
+        properties: any;
+        edgeLocation: VideoParticipantSummaryEdgeLocation;
+        publisherInfo: any;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface ParticipantSolution {
+    roomSid: string;
+}
+export interface ParticipantListInstance {
+    _version: V1;
+    _solution: ParticipantSolution;
+    _uri: string;
+    (participantSid: string): ParticipantContext;
+    get(participantSid: string): ParticipantContext;
+    /**
+     * Streams ParticipantInstance records from the API.
+     *
+     * This operation lazily loads records as efficiently as possible until the limit
+     * is reached.
+     *
+     * The results are passed into the callback function, so this operation is memory
+     * efficient.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { ParticipantListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: ParticipantInstance, done: (err?: Error) => void) => void): void;
+    each(params: ParticipantListInstanceEachOptions, callback?: (item: ParticipantInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of ParticipantInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * @param { string } [targetUrl] - API-generated URL for the requested results page
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    getPage(targetUrl: string, callback?: (error: Error | null, items: ParticipantPage) => any): Promise<ParticipantPage>;
+    /**
+     * Lists ParticipantInstance records from the API as a list.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { ParticipantListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: ParticipantInstance[]) => any): Promise<ParticipantInstance[]>;
+    list(params: ParticipantListInstanceOptions, callback?: (error: Error | null, items: ParticipantInstance[]) => any): Promise<ParticipantInstance[]>;
+    /**
+     * Retrieve a single page of ParticipantInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { ParticipantListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: ParticipantPage) => any): Promise<ParticipantPage>;
+    page(params: ParticipantListInstancePageOptions, callback?: (error: Error | null, items: ParticipantPage) => any): Promise<ParticipantPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function ParticipantListInstance(version: V1, roomSid: string): ParticipantListInstance;
+export declare class ParticipantPage extends Page<V1, ParticipantPayload, ParticipantResource, ParticipantInstance> {
+    /**
+     * Initialize the ParticipantPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: ParticipantSolution);
+    /**
+     * Build an instance of ParticipantInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: ParticipantResource): ParticipantInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};