@factset/sdk-factsetglobalprices/dist/model/Returns.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"));
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.8.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 Returns model module.
 * @module model/Returns
 */
class Returns {
  /**
   * Constructs a new <code>Returns</code>.
   * @alias module:model/Returns
   */
  constructor() {
    Returns.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>Returns</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/Returns} obj Optional instance to populate.
   * @return {module:model/Returns} The populated <code>Returns</code> instance.
   */
  static constructFromObject(data, obj) {
    if (data) {
      obj = obj || new Returns();
      if (data.hasOwnProperty('fsymId')) {
        obj['fsymId'] = _ApiClient.default.convertToType(data['fsymId'], 'String');
      }
      if (data.hasOwnProperty('totalReturn')) {
        obj['totalReturn'] = _ApiClient.default.convertToType(data['totalReturn'], 'Number');
      }
      if (data.hasOwnProperty('date')) {
        obj['date'] = _ApiClient.default.convertToType(data['date'], 'Date');
      }
      if (data.hasOwnProperty('currency')) {
        obj['currency'] = _ApiClient.default.convertToType(data['currency'], 'String');
      }
      if (data.hasOwnProperty('requestId')) {
        obj['requestId'] = _ApiClient.default.convertToType(data['requestId'], 'String');
      }
    }
    return obj;
  }
}

/**
 * FactSet Permanent Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R) or a -L Suffix (XXXXXX-L).
 * @member {String} fsymId
 */
Returns.prototype['fsymId'] = undefined;

/**
 * Returns the data for the given input parameters.
 * @member {Number} totalReturn
 */
Returns.prototype['totalReturn'] = undefined;

/**
 * End date of the return. Date in YYYY-MM-DD format. Depending on Frequency and Calendar settings, this could represent the entire return period requested.
 * @member {Date} date
 */
Returns.prototype['date'] = undefined;

/**
 * Currency ISO code. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
 * @member {String} currency
 */
Returns.prototype['currency'] = undefined;

/**
 * Identifier that was used for the request.
 * @member {String} requestId
 */
Returns.prototype['requestId'] = undefined;
var _default = exports.default = Returns;