@factset/sdk-securityexplanation/dist/model/SecurityExplanationRequestParameters.js

Security Explanation client library for JavaScript

"use strict";

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.1.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 SecurityExplanationRequestParameters model module.
 * @module model/SecurityExplanationRequestParameters
 */
class SecurityExplanationRequestParameters {
  /**
   * Constructs a new <code>SecurityExplanationRequestParameters</code>.
   * Parameters for the security explanation request
   * @alias module:model/SecurityExplanationRequestParameters
   * @param id {String} Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids.
   * @param startDate {Date} Start date of the explain request in YYYY-MM-DD format
   * @param endDate {Date} End date of the explain request in YYYY-MM-DD format
   */
  constructor(id, startDate, endDate) {
    SecurityExplanationRequestParameters.initialize(this, id, startDate, endDate);
  }

  /**
   * 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, id, startDate, endDate) {
    obj['id'] = id;
    obj['startDate'] = startDate;
    obj['endDate'] = endDate;
  }

  /**
   * Constructs a <code>SecurityExplanationRequestParameters</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/SecurityExplanationRequestParameters} obj Optional instance to populate.
   * @return {module:model/SecurityExplanationRequestParameters} The populated <code>SecurityExplanationRequestParameters</code> instance.
   */
  static constructFromObject(data, obj) {
    if (data) {
      obj = obj || new SecurityExplanationRequestParameters();
      if (data.hasOwnProperty('id')) {
        obj['id'] = _ApiClient.default.convertToType(data['id'], 'String');
      }
      if (data.hasOwnProperty('startDate')) {
        obj['startDate'] = _ApiClient.default.convertToType(data['startDate'], 'Date');
      }
      if (data.hasOwnProperty('endDate')) {
        obj['endDate'] = _ApiClient.default.convertToType(data['endDate'], 'Date');
      }
      if (data.hasOwnProperty('enableLinks')) {
        obj['enableLinks'] = _ApiClient.default.convertToType(data['enableLinks'], 'Boolean');
      }
      if (data.hasOwnProperty('explanationStyle')) {
        obj['explanationStyle'] = _ApiClient.default.convertToType(data['explanationStyle'], 'String');
      }
      if (data.hasOwnProperty('includePerformance')) {
        obj['includePerformance'] = _ApiClient.default.convertToType(data['includePerformance'], 'Boolean');
      }
      if (data.hasOwnProperty('internalInvestmentRationale')) {
        obj['internalInvestmentRationale'] = _ApiClient.default.convertToType(data['internalInvestmentRationale'], 'String');
      }
      if (data.hasOwnProperty('includeCompanyDescription')) {
        obj['includeCompanyDescription'] = _ApiClient.default.convertToType(data['includeCompanyDescription'], 'Boolean');
      }
    }
    return obj;
  }
}

/**
 * Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids.
 * @member {String} id
 */
SecurityExplanationRequestParameters.prototype['id'] = undefined;

/**
 * Start date of the explain request in YYYY-MM-DD format
 * @member {Date} startDate
 */
SecurityExplanationRequestParameters.prototype['startDate'] = undefined;

/**
 * End date of the explain request in YYYY-MM-DD format
 * @member {Date} endDate
 */
SecurityExplanationRequestParameters.prototype['endDate'] = undefined;

/**
 * If true, explain response will have link to the related news articles
 * @member {Boolean} enableLinks
 * @default false
 */
SecurityExplanationRequestParameters.prototype['enableLinks'] = false;

/**
 * Determines the style of the Explanation
 * @member {module:model/SecurityExplanationRequestParameters.ExplanationStyleEnum} explanationStyle
 * @default 'short'
 */
SecurityExplanationRequestParameters.prototype['explanationStyle'] = 'short';

/**
 * If true, includes the performance statement in the explanation
 * @member {Boolean} includePerformance
 * @default false
 */
SecurityExplanationRequestParameters.prototype['includePerformance'] = false;

/**
 * Include summarized IRN notes on the company, or just the footnote, or none. Only available for IRN users
 * @member {module:model/SecurityExplanationRequestParameters.InternalInvestmentRationaleEnum} internalInvestmentRationale
 * @default 'none'
 */
SecurityExplanationRequestParameters.prototype['internalInvestmentRationale'] = 'none';

/**
 * If true, includes the company description in the explanation.In order to include 'Company Business Description', 'includePerformance' must be set to True. Even if 'includeCompanyDescription' is set to True, if 'includePerformance' is false, it will be omitted
 * @member {Boolean} includeCompanyDescription
 * @default false
 */
SecurityExplanationRequestParameters.prototype['includeCompanyDescription'] = false;

/**
 * Allowed values for the <code>explanationStyle</code> property.
 * @enum {String}
 * @readonly
 */
SecurityExplanationRequestParameters['ExplanationStyleEnum'] = {
  /**
   * value: "short"
   * @const
   */
  "short": "short",
  /**
   * value: "long"
   * @const
   */
  "long": "long"
};

/**
 * Allowed values for the <code>internalInvestmentRationale</code> property.
 * @enum {String}
 * @readonly
 */
SecurityExplanationRequestParameters['InternalInvestmentRationaleEnum'] = {
  /**
   * value: "none"
   * @const
   */
  "none": "none",
  /**
   * value: "summary"
   * @const
   */
  "summary": "summary",
  /**
   * value: "footnote"
   * @const
   */
  "footnote": "footnote"
};
var _default = exports.default = SecurityExplanationRequestParameters;