twilio
Version:
A Twilio helper library
285 lines (255 loc) • 9.65 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 Page = require('../../../../../base/Page'); /* jshint ignore:line */
var deserialize = require(
'../../../../../base/deserialize'); /* jshint ignore:line */
var values = require('../../../../../base/values'); /* jshint ignore:line */
var TaskQueueRealTimeStatisticsList;
var TaskQueueRealTimeStatisticsPage;
var TaskQueueRealTimeStatisticsInstance;
var TaskQueueRealTimeStatisticsContext;
/* jshint ignore:start */
/**
* @constructor Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsList
* @description Initialize the TaskQueueRealTimeStatisticsList
*
* @param {Twilio.Taskrouter.V1} version - Version of the resource
* @param {string} workspaceSid - The workspace_sid
* @param {string} taskQueueSid - The task_queue_sid
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsList = function
TaskQueueRealTimeStatisticsList(version, workspaceSid, taskQueueSid) {
/* jshint ignore:start */
/**
* @function realTimeStatistics
* @memberof Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext
* @instance
*
* @param {string} sid - sid of instance
*
* @returns {Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsContext}
*/
/* jshint ignore:end */
function TaskQueueRealTimeStatisticsListInstance(sid) {
return TaskQueueRealTimeStatisticsListInstance.get(sid);
}
TaskQueueRealTimeStatisticsListInstance._version = version;
// Path Solution
TaskQueueRealTimeStatisticsListInstance._solution = {
workspaceSid: workspaceSid,
taskQueueSid: taskQueueSid
};
/* jshint ignore:start */
/**
* Constructs a task_queue_real_time_statistics
*
* @function get
* @memberof Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsList
* @instance
*
* @returns {Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsContext}
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsListInstance.get = function get() {
return new TaskQueueRealTimeStatisticsContext(
this._version,
this._solution.workspaceSid,
this._solution.taskQueueSid
);
};
return TaskQueueRealTimeStatisticsListInstance;
};
/* jshint ignore:start */
/**
* @constructor Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsPage
* @augments Page
* @description Initialize the TaskQueueRealTimeStatisticsPage
*
* @param {Twilio.Taskrouter.V1} version - Version of the resource
* @param {object} response - Response from the API
* @param {object} solution - Path solution
*
* @returns TaskQueueRealTimeStatisticsPage
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsPage = function
TaskQueueRealTimeStatisticsPage(version, response, solution) {
// Path Solution
this._solution = solution;
Page.prototype.constructor.call(this, version, response, this._solution);
};
_.extend(TaskQueueRealTimeStatisticsPage.prototype, Page.prototype);
TaskQueueRealTimeStatisticsPage.prototype.constructor = TaskQueueRealTimeStatisticsPage;
/* jshint ignore:start */
/**
* Build an instance of TaskQueueRealTimeStatisticsInstance
*
* @function getInstance
* @memberof Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsPage
* @instance
*
* @param {object} payload - Payload response from the API
*
* @returns TaskQueueRealTimeStatisticsInstance
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsPage.prototype.getInstance = function
getInstance(payload) {
return new TaskQueueRealTimeStatisticsInstance(
this._version,
payload,
this._solution.workspaceSid,
this._solution.taskQueueSid
);
};
/* jshint ignore:start */
/**
* @constructor Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsInstance
* @description Initialize the TaskQueueRealTimeStatisticsContext
*
* @property {string} accountSid - The account_sid
* @property {string} activityStatistics - The activity_statistics
* @property {number} longestTaskWaitingAge - The longest_task_waiting_age
* @property {string} taskQueueSid - The task_queue_sid
* @property {string} tasksByPriority - The tasks_by_priority
* @property {string} tasksByStatus - The tasks_by_status
* @property {number} totalAvailableWorkers - The total_available_workers
* @property {number} totalEligibleWorkers - The total_eligible_workers
* @property {number} totalTasks - The total_tasks
* @property {string} workspaceSid - The workspace_sid
* @property {string} url - The url
*
* @param {Twilio.Taskrouter.V1} version - Version of the resource
* @param {object} payload - The instance payload
* @param {sid} workspaceSid - The workspace_sid
* @param {sid} taskQueueSid - The task_queue_sid
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsInstance = function
TaskQueueRealTimeStatisticsInstance(version, payload, workspaceSid,
taskQueueSid) {
this._version = version;
// Marshaled Properties
this.accountSid = payload.account_sid; // jshint ignore:line
this.activityStatistics = payload.activity_statistics; // jshint ignore:line
this.longestTaskWaitingAge = deserialize.integer(payload.longest_task_waiting_age); // jshint ignore:line
this.taskQueueSid = payload.task_queue_sid; // jshint ignore:line
this.tasksByPriority = payload.tasks_by_priority; // jshint ignore:line
this.tasksByStatus = payload.tasks_by_status; // jshint ignore:line
this.totalAvailableWorkers = deserialize.integer(payload.total_available_workers); // jshint ignore:line
this.totalEligibleWorkers = deserialize.integer(payload.total_eligible_workers); // jshint ignore:line
this.totalTasks = deserialize.integer(payload.total_tasks); // jshint ignore:line
this.workspaceSid = payload.workspace_sid; // jshint ignore:line
this.url = payload.url; // jshint ignore:line
// Context
this._context = undefined;
this._solution = {workspaceSid: workspaceSid, taskQueueSid: taskQueueSid,};
};
Object.defineProperty(TaskQueueRealTimeStatisticsInstance.prototype,
'_proxy', {
get: function() {
if (!this._context) {
this._context = new TaskQueueRealTimeStatisticsContext(
this._version,
this._solution.workspaceSid,
this._solution.taskQueueSid
);
}
return this._context;
}
});
/* jshint ignore:start */
/**
* fetch a TaskQueueRealTimeStatisticsInstance
*
* @function fetch
* @memberof Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsInstance
* @instance
*
* @param {object|function} opts - ...
* @param {string} [opts.taskChannel] - The task_channel
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed TaskQueueRealTimeStatisticsInstance
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsInstance.prototype.fetch = function fetch(opts,
callback) {
return this._proxy.fetch(opts, callback);
};
/* jshint ignore:start */
/**
* @constructor Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsContext
* @description Initialize the TaskQueueRealTimeStatisticsContext
*
* @param {Twilio.Taskrouter.V1} version - Version of the resource
* @param {sid} workspaceSid - The workspace_sid
* @param {sid} taskQueueSid - The task_queue_sid
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsContext = function
TaskQueueRealTimeStatisticsContext(version, workspaceSid, taskQueueSid) {
this._version = version;
// Path Solution
this._solution = {workspaceSid: workspaceSid, taskQueueSid: taskQueueSid,};
this._uri = _.template(
'/Workspaces/<%= workspaceSid %>/TaskQueues/<%= taskQueueSid %>/RealTimeStatistics' // jshint ignore:line
)(this._solution);
};
/* jshint ignore:start */
/**
* fetch a TaskQueueRealTimeStatisticsInstance
*
* @function fetch
* @memberof Twilio.Taskrouter.V1.WorkspaceContext.TaskQueueContext.TaskQueueRealTimeStatisticsContext
* @instance
*
* @param {object|function} opts - ...
* @param {string} [opts.taskChannel] - The task_channel
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed TaskQueueRealTimeStatisticsInstance
*/
/* jshint ignore:end */
TaskQueueRealTimeStatisticsContext.prototype.fetch = function fetch(opts,
callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({'TaskChannel': _.get(opts, 'taskChannel')});
var promise = this._version.fetch({uri: this._uri, method: 'GET', params: data});
promise = promise.then(function(payload) {
deferred.resolve(new TaskQueueRealTimeStatisticsInstance(
this._version,
payload,
this._solution.workspaceSid,
this._solution.taskQueueSid
));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
module.exports = {
TaskQueueRealTimeStatisticsList: TaskQueueRealTimeStatisticsList,
TaskQueueRealTimeStatisticsPage: TaskQueueRealTimeStatisticsPage,
TaskQueueRealTimeStatisticsInstance: TaskQueueRealTimeStatisticsInstance,
TaskQueueRealTimeStatisticsContext: TaskQueueRealTimeStatisticsContext
};