genesys-workspace-client-js
Version:
Workspace application API used by Workspace Web Edition
217 lines (185 loc) • 7.18 kB
JavaScript
/**
* Workspace API
* Agent API
*
* OpenAPI spec version: 9.0.000.97.4639
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
*
* Swagger Codegen version: 2.4.5
*
* Do not edit the class manually.
*
*/
(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['ApiClient', 'model/CallParticipants', 'model/Kvpair'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./CallParticipants'), require('./Kvpair'));
} else {
// Browser globals (root is window)
if (!root.WorkspaceApi) {
root.WorkspaceApi = {};
}
root.WorkspaceApi.Call = factory(root.WorkspaceApi.ApiClient, root.WorkspaceApi.CallParticipants, root.WorkspaceApi.Kvpair);
}
}(this, function(ApiClient, CallParticipants, Kvpair) {
'use strict';
/**
* The Call model module.
* @module model/Call
* @version 9.0.000.97.4639
*/
/**
* Constructs a new <code>Call</code>.
* @alias module:model/Call
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>Call</code> from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
* @param {module:model/Call} obj Optional instance to populate.
* @return {module:model/Call} The populated <code>Call</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('type')) {
obj['type'] = ApiClient.convertToType(data['type'], 'String');
}
if (data.hasOwnProperty('id')) {
obj['id'] = ApiClient.convertToType(data['id'], 'String');
}
if (data.hasOwnProperty('previousConnId')) {
obj['previousConnId'] = ApiClient.convertToType(data['previousConnId'], 'String');
}
if (data.hasOwnProperty('parentConnId')) {
obj['parentConnId'] = ApiClient.convertToType(data['parentConnId'], 'String');
}
if (data.hasOwnProperty('phoneNumber')) {
obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String');
}
if (data.hasOwnProperty('connId')) {
obj['connId'] = ApiClient.convertToType(data['connId'], 'String');
}
if (data.hasOwnProperty('callUuid')) {
obj['callUuid'] = ApiClient.convertToType(data['callUuid'], 'String');
}
if (data.hasOwnProperty('callType')) {
obj['callType'] = ApiClient.convertToType(data['callType'], 'String');
}
if (data.hasOwnProperty('state')) {
obj['state'] = ApiClient.convertToType(data['state'], 'String');
}
if (data.hasOwnProperty('capabilities')) {
obj['capabilities'] = ApiClient.convertToType(data['capabilities'], ['String']);
}
if (data.hasOwnProperty('participants')) {
obj['participants'] = ApiClient.convertToType(data['participants'], [CallParticipants]);
}
if (data.hasOwnProperty('dnis')) {
obj['dnis'] = ApiClient.convertToType(data['dnis'], 'String');
}
if (data.hasOwnProperty('ani')) {
obj['ani'] = ApiClient.convertToType(data['ani'], 'String');
}
if (data.hasOwnProperty('recordingState')) {
obj['recordingState'] = ApiClient.convertToType(data['recordingState'], 'String');
}
if (data.hasOwnProperty('userData')) {
obj['userData'] = ApiClient.convertToType(data['userData'], [Kvpair]);
}
if (data.hasOwnProperty('extensions')) {
obj['extensions'] = ApiClient.convertToType(data['extensions'], [Kvpair]);
}
}
return obj;
}
/**
* @member {String} type
*/
exports.prototype['type'] = undefined;
/**
* The unique identifier for the call.
* @member {String} id
*/
exports.prototype['id'] = undefined;
/**
* The previous connection ID is present if the ID has changed, as would be the case if an agent is the target of a two-step conference or transfer.
* @member {String} previousConnId
*/
exports.prototype['previousConnId'] = undefined;
/**
* The parent connection ID is present on consult calls and identifies the call from which the conference or transfer was initiated.
* @member {String} parentConnId
*/
exports.prototype['parentConnId'] = undefined;
/**
* The agent's phone number.
* @member {String} phoneNumber
*/
exports.prototype['phoneNumber'] = undefined;
/**
* The connection ID for the call. This value comes from the Tlib event.
* @member {String} connId
*/
exports.prototype['connId'] = undefined;
/**
* The universally unique identifier associated with the call. This is a separate identifier that is specifically required by some requests.
* @member {String} callUuid
*/
exports.prototype['callUuid'] = undefined;
/**
* The type of call, such as Internal, Inbound, Outbound, Consult.
* @member {String} callType
*/
exports.prototype['callType'] = undefined;
/**
* The state of the call, such asRinging, Dialing, Established, Held, Released, or Completed. Unless specifically configured, calls are automatically completed upon release.
* @member {String} state
*/
exports.prototype['state'] = undefined;
/**
* A list of capabilities for the current state. For example, if the current state is Dialing, the list might be [\"HangUp\", \"Hold\"].
* @member {Array.<String>} capabilities
*/
exports.prototype['capabilities'] = undefined;
/**
* A list of call participants—the phone numbers of those currently on the call.
* @member {Array.<module:model/CallParticipants>} participants
*/
exports.prototype['participants'] = undefined;
/**
* The Dialed Number Identification Service from the call.
* @member {String} dnis
*/
exports.prototype['dnis'] = undefined;
/**
* The Automatic Number Identification from the call.
* @member {String} ani
*/
exports.prototype['ani'] = undefined;
/**
* The call recording state, one of Stopped, Recording, Paused. If the recording was never started for a call this property is absent.
* @member {String} recordingState
*/
exports.prototype['recordingState'] = undefined;
/**
* A key/value pairs list of a data associated with the call.
* @member {Array.<module:model/Kvpair>} userData
*/
exports.prototype['userData'] = undefined;
/**
* Media device/hardware reason codes and similar information. For details about extensions, refer to the [*Genesys Events and Models Reference Manual*](https://docs.genesys.com/Documentation/System/Current/GenEM/Extensions).
* @member {Array.<module:model/Kvpair>} extensions
*/
exports.prototype['extensions'] = undefined;
return exports;
}));