@signalwire/compatibility-api
Version:
SignalWire Compatibility API
616 lines (553 loc) • 19 kB
JavaScript
'use strict';
/* jshint ignore:start */
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
/* jshint ignore:end */
var Q = require('q'); /* jshint ignore:line */
var _ = require('lodash'); /* jshint ignore:line */
var util = require('util'); /* jshint ignore:line */
var Page = require('../../../../base/Page'); /* jshint ignore:line */
var deserialize = require(
'../../../../base/deserialize'); /* jshint ignore:line */
var values = require('../../../../base/values'); /* jshint ignore:line */
var ParticipantList;
var ParticipantPage;
var ParticipantInstance;
var ParticipantContext;
/* jshint ignore:start */
/**
* Initialize the ParticipantList
*
* PLEASE NOTE that this class contains beta products that are subject to change.
* Use them with caution.
*
* @constructor Twilio.Insights.V1.RoomContext.ParticipantList
*
* @param {Twilio.Insights.V1} version - Version of the resource
* @param {string} roomSid - Unique identifier for the room.
*/
/* jshint ignore:end */
ParticipantList = function ParticipantList(version, roomSid) {
/* jshint ignore:start */
/**
* @function participants
* @memberof Twilio.Insights.V1.RoomContext#
*
* @param {string} sid - sid of instance
*
* @returns {Twilio.Insights.V1.RoomContext.ParticipantContext}
*/
/* jshint ignore:end */
function ParticipantListInstance(sid) {
return ParticipantListInstance.get(sid);
}
ParticipantListInstance._version = version;
// Path Solution
ParticipantListInstance._solution = {roomSid: roomSid};
ParticipantListInstance._uri = `/Video/Rooms/${roomSid}/Participants`;
/* jshint ignore:start */
/**
* 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.
*
* @function each
* @memberof Twilio.Insights.V1.RoomContext.ParticipantList#
*
* @param {object} [opts] - Options for request
* @param {number} [opts.limit] -
* Upper limit for the number of records to return.
* each() guarantees never to return more than limit.
* Default is no limit
* @param {number} [opts.pageSize] -
* Number of records to fetch per request,
* when not set will use the default value of 50 records.
* If no pageSize is defined but a limit is defined,
* each() will attempt to read the limit with the most efficient
* page size, i.e. min(limit, 1000)
* @param {Function} [opts.callback] -
* Function to process each record. If this and a positional
* callback are passed, this one will be used
* @param {Function} [opts.done] -
* Function to be called upon completion of streaming
* @param {Function} [callback] - Function to process each record
*/
/* jshint ignore:end */
ParticipantListInstance.each = function each(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
if (opts.callback) {
callback = opts.callback;
}
if (_.isUndefined(callback)) {
throw new Error('Callback function must be provided');
}
var done = false;
var currentPage = 1;
var currentResource = 0;
var limits = this._version.readLimits({
limit: opts.limit,
pageSize: opts.pageSize
});
function onComplete(error) {
done = true;
if (_.isFunction(opts.done)) {
opts.done(error);
}
}
function fetchNextPage(fn) {
var promise = fn();
if (_.isUndefined(promise)) {
onComplete();
return;
}
promise.then(function(page) {
_.each(page.instances, function(instance) {
if (done || (!_.isUndefined(opts.limit) && currentResource >= opts.limit)) {
done = true;
return false;
}
currentResource++;
callback(instance, onComplete);
});
if (!done) {
currentPage++;
fetchNextPage(_.bind(page.nextPage, page));
} else {
onComplete();
}
});
promise.catch(onComplete);
}
fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
};
/* jshint ignore:start */
/**
* 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.
*
* @function list
* @memberof Twilio.Insights.V1.RoomContext.ParticipantList#
*
* @param {object} [opts] - Options for request
* @param {number} [opts.limit] -
* Upper limit for the number of records to return.
* list() guarantees never to return more than limit.
* Default is no limit
* @param {number} [opts.pageSize] -
* Number of records to fetch per request,
* when not set will use the default value of 50 records.
* If no page_size is defined but a limit is defined,
* list() will attempt to read the limit with the most
* efficient page size, i.e. min(limit, 1000)
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
ParticipantListInstance.list = function list(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var allResources = [];
opts.callback = function(resource, done) {
allResources.push(resource);
if (!_.isUndefined(opts.limit) && allResources.length === opts.limit) {
done();
}
};
opts.done = function(error) {
if (_.isUndefined(error)) {
deferred.resolve(allResources);
} else {
deferred.reject(error);
}
};
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
this.each(opts);
return deferred.promise;
};
/* jshint ignore:start */
/**
* 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.
*
* @function page
* @memberof Twilio.Insights.V1.RoomContext.ParticipantList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.pageToken] - PageToken provided by the API
* @param {number} [opts.pageNumber] -
* Page Number, this value is simply for client state
* @param {number} [opts.pageSize] - Number of records to return, defaults to 50
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
ParticipantListInstance.page = function page(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'PageToken': opts.pageToken,
'Page': opts.pageNumber,
'PageSize': opts.pageSize
});
var promise = this._version.page({uri: this._uri, method: 'GET', params: data});
promise = promise.then(function(payload) {
deferred.resolve(new ParticipantPage(this._version, payload, this._solution));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Retrieve a single target 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.
*
* @function getPage
* @memberof Twilio.Insights.V1.RoomContext.ParticipantList#
*
* @param {string} [targetUrl] - API-generated URL for the requested results page
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
ParticipantListInstance.getPage = function getPage(targetUrl, callback) {
var deferred = Q.defer();
var promise = this._version._domain.twilio.request({method: 'GET', uri: targetUrl});
promise = promise.then(function(payload) {
deferred.resolve(new ParticipantPage(this._version, payload, this._solution));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Constructs a participant
*
* @function get
* @memberof Twilio.Insights.V1.RoomContext.ParticipantList#
*
* @param {string} participantSid - The SID of the Participant resource.
*
* @returns {Twilio.Insights.V1.RoomContext.ParticipantContext}
*/
/* jshint ignore:end */
ParticipantListInstance.get = function get(participantSid) {
return new ParticipantContext(this._version, this._solution.roomSid, participantSid);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Insights.V1.RoomContext.ParticipantList#
*
* @returns Object
*/
/* jshint ignore:end */
ParticipantListInstance.toJSON = function toJSON() {
return this._solution;
};
ParticipantListInstance[util.inspect.custom] = function inspect(depth, options)
{
return util.inspect(this.toJSON(), options);
};
return ParticipantListInstance;
};
/* jshint ignore:start */
/**
* Initialize the ParticipantPage
*
* PLEASE NOTE that this class contains beta products that are subject to change.
* Use them with caution.
*
* @constructor Twilio.Insights.V1.RoomContext.ParticipantPage
*
* @param {V1} version - Version of the resource
* @param {Response<string>} response - Response from the API
* @param {ParticipantSolution} solution - Path solution
*
* @returns ParticipantPage
*/
/* jshint ignore:end */
ParticipantPage = function ParticipantPage(version, response, solution) {
// Path Solution
this._solution = solution;
Page.prototype.constructor.call(this, version, response, this._solution);
};
_.extend(ParticipantPage.prototype, Page.prototype);
ParticipantPage.prototype.constructor = ParticipantPage;
/* jshint ignore:start */
/**
* Build an instance of ParticipantInstance
*
* @function getInstance
* @memberof Twilio.Insights.V1.RoomContext.ParticipantPage#
*
* @param {ParticipantPayload} payload - Payload response from the API
*
* @returns ParticipantInstance
*/
/* jshint ignore:end */
ParticipantPage.prototype.getInstance = function getInstance(payload) {
return new ParticipantInstance(this._version, payload, this._solution.roomSid);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Insights.V1.RoomContext.ParticipantPage#
*
* @returns Object
*/
/* jshint ignore:end */
ParticipantPage.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
ParticipantPage.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the ParticipantContext
*
* PLEASE NOTE that this class contains beta products that are subject to change.
* Use them with caution.
*
* @constructor Twilio.Insights.V1.RoomContext.ParticipantInstance
*
* @property {string} participantSid - Unique identifier for the participant.
* @property {string} participantIdentity -
* The application-defined string that uniquely identifies the participant within a Room.
* @property {Date} joinTime - When the participant joined the room.
* @property {Date} leaveTime - When the participant left the room
* @property {number} durationSec -
* Amount of time in seconds the participant was in the room.
* @property {string} accountSid - Account SID associated with the room.
* @property {string} roomSid - Unique identifier for the room.
* @property {participant.room_status} status - Status of the room.
* @property {participant.codec} codecs - Codecs detected from the participant.
* @property {string} endReason - Reason the participant left the room.
* @property {number} errorCode - Errors encountered by the participant.
* @property {string} errorCodeUrl - Twilio error code dictionary link.
* @property {participant.twilio_realm} mediaRegion -
* Twilio media region the participant connected to.
* @property {object} properties -
* Object containing information about the participant's data from the room.
* @property {participant.edge_location} edgeLocation -
* Name of the edge location the participant connected to.
* @property {object} publisherInfo -
* Object containing information about the SDK name and version.
* @property {string} url - URL of the participant resource.
*
* @param {V1} version - Version of the resource
* @param {ParticipantPayload} payload - The instance payload
* @param {sid} roomSid - Unique identifier for the room.
* @param {sid_like} participantSid - The SID of the Participant resource.
*/
/* jshint ignore:end */
ParticipantInstance = function ParticipantInstance(version, payload, roomSid,
participantSid) {
this._version = version;
// Marshaled Properties
this.participantSid = payload.participant_sid; // jshint ignore:line
this.participantIdentity = payload.participant_identity; // jshint ignore:line
this.joinTime = deserialize.iso8601DateTime(payload.join_time); // jshint ignore:line
this.leaveTime = deserialize.iso8601DateTime(payload.leave_time); // jshint ignore:line
this.durationSec = deserialize.integer(payload.duration_sec); // jshint ignore:line
this.accountSid = payload.account_sid; // jshint ignore:line
this.roomSid = payload.room_sid; // jshint ignore:line
this.status = payload.status; // jshint ignore:line
this.codecs = payload.codecs; // jshint ignore:line
this.endReason = payload.end_reason; // jshint ignore:line
this.errorCode = deserialize.integer(payload.error_code); // jshint ignore:line
this.errorCodeUrl = payload.error_code_url; // jshint ignore:line
this.mediaRegion = payload.media_region; // jshint ignore:line
this.properties = payload.properties; // jshint ignore:line
this.edgeLocation = payload.edge_location; // jshint ignore:line
this.publisherInfo = payload.publisher_info; // jshint ignore:line
this.url = payload.url; // jshint ignore:line
// Context
this._context = undefined;
this._solution = {roomSid: roomSid, participantSid: participantSid || this.participantSid, };
};
Object.defineProperty(ParticipantInstance.prototype,
'_proxy', {
get: function() {
if (!this._context) {
this._context = new ParticipantContext(
this._version,
this._solution.roomSid,
this._solution.participantSid
);
}
return this._context;
}
});
/* jshint ignore:start */
/**
* fetch a ParticipantInstance
*
* @function fetch
* @memberof Twilio.Insights.V1.RoomContext.ParticipantInstance#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed ParticipantInstance
*/
/* jshint ignore:end */
ParticipantInstance.prototype.fetch = function fetch(callback) {
return this._proxy.fetch(callback);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Insights.V1.RoomContext.ParticipantInstance#
*
* @returns Object
*/
/* jshint ignore:end */
ParticipantInstance.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
ParticipantInstance.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the ParticipantContext
*
* PLEASE NOTE that this class contains beta products that are subject to change.
* Use them with caution.
*
* @constructor Twilio.Insights.V1.RoomContext.ParticipantContext
*
* @param {V1} version - Version of the resource
* @param {sid_like} roomSid - The SID of the Room resource.
* @param {sid_like} participantSid - The SID of the Participant resource.
*/
/* jshint ignore:end */
ParticipantContext = function ParticipantContext(version, roomSid,
participantSid) {
this._version = version;
// Path Solution
this._solution = {roomSid: roomSid, participantSid: participantSid, };
this._uri = `/Video/Rooms/${roomSid}/Participants/${participantSid}`;
};
/* jshint ignore:start */
/**
* fetch a ParticipantInstance
*
* @function fetch
* @memberof Twilio.Insights.V1.RoomContext.ParticipantContext#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed ParticipantInstance
*/
/* jshint ignore:end */
ParticipantContext.prototype.fetch = function fetch(callback) {
var deferred = Q.defer();
var promise = this._version.fetch({uri: this._uri, method: 'GET'});
promise = promise.then(function(payload) {
deferred.resolve(new ParticipantInstance(
this._version,
payload,
this._solution.roomSid,
this._solution.participantSid
));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Insights.V1.RoomContext.ParticipantContext#
*
* @returns Object
*/
/* jshint ignore:end */
ParticipantContext.prototype.toJSON = function toJSON() {
return this._solution;
};
ParticipantContext.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
module.exports = {
ParticipantList: ParticipantList,
ParticipantPage: ParticipantPage,
ParticipantInstance: ParticipantInstance,
ParticipantContext: ParticipantContext
};