@factset/sdk-factsetglobalprices/dist/model/RightsIssue.js

FactSet Global Prices client library for JavaScript

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
var _ErrorObjectResponse = _interopRequireDefault(require("./ErrorObjectResponse"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/**
 * FactSet Global Prices API
 * The FactSet Global Prices API provides end of day market pricing content using cloud and microservices technology, encompassing both pricing as well as corporate actions and events data.</p> 
 *
 * The version of the OpenAPI document: 1.11.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 RightsIssue model module.
 * @module model/RightsIssue
 */
class RightsIssue {
  /**
   * Constructs a new <code>RightsIssue</code>.
   * @alias module:model/RightsIssue
   */
  constructor() {
    RightsIssue.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>RightsIssue</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/RightsIssue} obj Optional instance to populate.
   * @return {module:model/RightsIssue} The populated <code>RightsIssue</code> instance.
   */
  static constructFromObject(data, obj) {
    if (data) {
      obj = obj || new RightsIssue();
      if (data.hasOwnProperty('eventId') && obj['eventId'] === undefined) {
        obj['eventId'] = _ApiClient.default.convertToType(data['eventId'], 'String');
      }
      if (data.hasOwnProperty('fsymId') && obj['fsymId'] === undefined) {
        obj['fsymId'] = _ApiClient.default.convertToType(data['fsymId'], 'String');
      }
      if (data.hasOwnProperty('requestId') && obj['requestId'] === undefined) {
        obj['requestId'] = _ApiClient.default.convertToType(data['requestId'], 'String');
      }
      if (data.hasOwnProperty('identifier') && obj['identifier'] === undefined) {
        obj['identifier'] = _ApiClient.default.convertToType(data['identifier'], 'String');
      }
      if (data.hasOwnProperty('companyName') && obj['companyName'] === undefined) {
        obj['companyName'] = _ApiClient.default.convertToType(data['companyName'], 'String');
      }
      if (data.hasOwnProperty('exchangeCode') && obj['exchangeCode'] === undefined) {
        obj['exchangeCode'] = _ApiClient.default.convertToType(data['exchangeCode'], 'String');
      }
      if (data.hasOwnProperty('exchangeName') && obj['exchangeName'] === undefined) {
        obj['exchangeName'] = _ApiClient.default.convertToType(data['exchangeName'], 'String');
      }
      if (data.hasOwnProperty('country') && obj['country'] === undefined) {
        obj['country'] = _ApiClient.default.convertToType(data['country'], 'String');
      }
      if (data.hasOwnProperty('eventType') && obj['eventType'] === undefined) {
        obj['eventType'] = _ApiClient.default.convertToType(data['eventType'], 'String');
      }
      if (data.hasOwnProperty('announcementDate') && obj['announcementDate'] === undefined) {
        obj['announcementDate'] = _ApiClient.default.convertToType(data['announcementDate'], 'Date');
      }
      if (data.hasOwnProperty('recordDate') && obj['recordDate'] === undefined) {
        obj['recordDate'] = _ApiClient.default.convertToType(data['recordDate'], 'Date');
      }
      if (data.hasOwnProperty('payDate') && obj['payDate'] === undefined) {
        obj['payDate'] = _ApiClient.default.convertToType(data['payDate'], 'Date');
      }
      if (data.hasOwnProperty('effectiveDate') && obj['effectiveDate'] === undefined) {
        obj['effectiveDate'] = _ApiClient.default.convertToType(data['effectiveDate'], 'Date');
      }
      if (data.hasOwnProperty('rightsIssuePrice') && obj['rightsIssuePrice'] === undefined) {
        obj['rightsIssuePrice'] = _ApiClient.default.convertToType(data['rightsIssuePrice'], 'Number');
      }
      if (data.hasOwnProperty('rightsIssueCurrency') && obj['rightsIssueCurrency'] === undefined) {
        obj['rightsIssueCurrency'] = _ApiClient.default.convertToType(data['rightsIssueCurrency'], 'String');
      }
      if (data.hasOwnProperty('priceAdjFactor') && obj['priceAdjFactor'] === undefined) {
        obj['priceAdjFactor'] = _ApiClient.default.convertToType(data['priceAdjFactor'], 'Number');
      }
      if (data.hasOwnProperty('eventDescription') && obj['eventDescription'] === undefined) {
        obj['eventDescription'] = _ApiClient.default.convertToType(data['eventDescription'], 'String');
      }
      if (data.hasOwnProperty('distIdentifier') && obj['distIdentifier'] === undefined) {
        obj['distIdentifier'] = _ApiClient.default.convertToType(data['distIdentifier'], 'String');
      }
      if (data.hasOwnProperty('error') && obj['error'] === undefined) {
        obj['error'] = _ErrorObjectResponse.default.constructFromObject(data['error']);
      }
    }
    return obj;
  }
}

/**
 * FactSet Event Identifier. This is a unique identifier for each event.
 * @member {String} eventId
 */
RightsIssue.prototype['eventId'] = undefined;

/**
 * FactSet Permanent Identifier for the company/security associated with the event.
 * @member {String} fsymId
 */
RightsIssue.prototype['fsymId'] = undefined;

/**
 * The identifier for the company or security will only be returned when IDs are included in the request. Acceptable identifiers include Tickers, SEDOLs, ISINs, CUSIPs, or FactSet Permanent IDs.
 * @member {String} requestId
 */
RightsIssue.prototype['requestId'] = undefined;

/**
 * The ticker-region of the company or security. This field is returned regardless of any of the IDs provided.
 * @member {String} identifier
 */
RightsIssue.prototype['identifier'] = undefined;

/**
 * Name of the company/security that declared the rights issue.
 * @member {String} companyName
 */
RightsIssue.prototype['companyName'] = undefined;

/**
 * The exchange code where the event occurred. For a list of valid exchange codes, refer to the `/meta/exchanges` endpoint.
 * @member {String} exchangeCode
 */
RightsIssue.prototype['exchangeCode'] = undefined;

/**
 * Exchange where the security/company associated with the event is traded.
 * @member {String} exchangeName
 */
RightsIssue.prototype['exchangeName'] = undefined;

/**
 * The ISO Alpha-2 code of the country where the event occurred.
 * @member {String} country
 */
RightsIssue.prototype['country'] = undefined;

/**
 * A brief description of the corporate action type.
 * @member {String} eventType
 */
RightsIssue.prototype['eventType'] = undefined;

/**
 * Date Event was announced in YYYY-MM-DD format.
 * @member {Date} announcementDate
 */
RightsIssue.prototype['announcementDate'] = undefined;

/**
 * Date of Record for distribution in YYYY-MM-DD format.
 * @member {Date} recordDate
 */
RightsIssue.prototype['recordDate'] = undefined;

/**
 * Date of Payment for distribution in YYYY-MM-DD format.
 * @member {Date} payDate
 */
RightsIssue.prototype['payDate'] = undefined;

/**
 * Effective Date or Ex-Date of distribution in YYYY-MM-DD format.
 * @member {Date} effectiveDate
 */
RightsIssue.prototype['effectiveDate'] = undefined;

/**
 * Price at which the rights are issued.
 * @member {Number} rightsIssuePrice
 */
RightsIssue.prototype['rightsIssuePrice'] = undefined;

/**
 * Currency ISO code in which the rights are issued.
 * @member {String} rightsIssueCurrency
 */
RightsIssue.prototype['rightsIssueCurrency'] = undefined;

/**
 * The price adjustment factor associated with the rights issue.
 * @member {Number} priceAdjFactor
 */
RightsIssue.prototype['priceAdjFactor'] = undefined;

/**
 * Textual description identifying the event.
 * @member {String} eventDescription
 */
RightsIssue.prototype['eventDescription'] = undefined;

/**
 * The identifier of the distributed company associated with the event.
 * @member {String} distIdentifier
 */
RightsIssue.prototype['distIdentifier'] = undefined;

/**
 * @member {module:model/ErrorObjectResponse} error
 */
RightsIssue.prototype['error'] = undefined;
var _default = exports.default = RightsIssue;