@factset/sdk-securityexplanation
Version:
Security Explanation client library for JavaScript
107 lines (99 loc) • 2.96 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/**
* Security Explanation API
* Allow clients to use Security Explanation through APIs.
*
* The version of the OpenAPI document: 1.4.0
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*
*/
/**
* The ExplanationStatus model module.
* @module model/ExplanationStatus
*/
class ExplanationStatus {
/**
* Constructs a new <code>ExplanationStatus</code>.
* Details of the explanation.
* @alias module:model/ExplanationStatus
*/
constructor() {
ExplanationStatus.initialize(this);
}
/**
* Initializes the fields of this object.
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
* Only for internal use.
*/
static initialize(obj) {}
/**
* Constructs a <code>ExplanationStatus</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/ExplanationStatus} obj Optional instance to populate.
* @return {module:model/ExplanationStatus} The populated <code>ExplanationStatus</code> instance.
*/
static constructFromObject(data, obj) {
if (data) {
obj = obj || new ExplanationStatus();
if (data.hasOwnProperty('result')) {
obj['result'] = _ApiClient.default.convertToType(data['result'], 'String');
}
if (data.hasOwnProperty('id')) {
obj['id'] = _ApiClient.default.convertToType(data['id'], 'String');
}
if (data.hasOwnProperty('status')) {
obj['status'] = _ApiClient.default.convertToType(data['status'], 'String');
}
}
return obj;
}
}
/**
* The result URL of the explanation
* @member {String} result
*/
ExplanationStatus.prototype['result'] = undefined;
/**
* Explanation identifier
* @member {String} id
*/
ExplanationStatus.prototype['id'] = undefined;
/**
* Explanation status
* @member {module:model/ExplanationStatus.StatusEnum} status
*/
ExplanationStatus.prototype['status'] = undefined;
/**
* Allowed values for the <code>status</code> property.
* @enum {String}
* @readonly
*/
ExplanationStatus['StatusEnum'] = {
/**
* value: "queued"
* @const
*/
"queued": "queued",
/**
* value: "executing"
* @const
*/
"executing": "executing",
/**
* value: "completed"
* @const
*/
"completed": "completed"
};
var _default = exports.default = ExplanationStatus;