@factset/sdk-factsetglobalprices
Version:
FactSet Global Prices client library for JavaScript
274 lines (249 loc) • 8.94 kB
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 Distribution model module.
* @module model/Distribution
*/
class Distribution {
/**
* Constructs a new <code>Distribution</code>.
* @alias module:model/Distribution
*/
constructor() {
Distribution.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>Distribution</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/Distribution} obj Optional instance to populate.
* @return {module:model/Distribution} The populated <code>Distribution</code> instance.
*/
static constructFromObject(data, obj) {
if (data) {
obj = obj || new Distribution();
if (data.hasOwnProperty('fsymId')) {
obj['fsymId'] = _ApiClient.default.convertToType(data['fsymId'], 'String');
}
if (data.hasOwnProperty('eventId')) {
obj['eventId'] = _ApiClient.default.convertToType(data['eventId'], 'String');
}
if (data.hasOwnProperty('eventTypeCode')) {
obj['eventTypeCode'] = _ApiClient.default.convertToType(data['eventTypeCode'], 'String');
}
if (data.hasOwnProperty('eventTypeDesc')) {
obj['eventTypeDesc'] = _ApiClient.default.convertToType(data['eventTypeDesc'], 'String');
}
if (data.hasOwnProperty('announcementDate')) {
obj['announcementDate'] = _ApiClient.default.convertToType(data['announcementDate'], 'String');
}
if (data.hasOwnProperty('recordDate')) {
obj['recordDate'] = _ApiClient.default.convertToType(data['recordDate'], 'String');
}
if (data.hasOwnProperty('payDate')) {
obj['payDate'] = _ApiClient.default.convertToType(data['payDate'], 'String');
}
if (data.hasOwnProperty('effectiveDate')) {
obj['effectiveDate'] = _ApiClient.default.convertToType(data['effectiveDate'], 'String');
}
if (data.hasOwnProperty('adjFactor')) {
obj['adjFactor'] = _ApiClient.default.convertToType(data['adjFactor'], 'Number');
}
if (data.hasOwnProperty('adjFactorCombined')) {
obj['adjFactorCombined'] = _ApiClient.default.convertToType(data['adjFactorCombined'], 'Number');
}
if (data.hasOwnProperty('amtDefTradingAdj')) {
obj['amtDefTradingAdj'] = _ApiClient.default.convertToType(data['amtDefTradingAdj'], 'Number');
}
if (data.hasOwnProperty('amtDefTradingUnadj')) {
obj['amtDefTradingUnadj'] = _ApiClient.default.convertToType(data['amtDefTradingUnadj'], 'Number');
}
if (data.hasOwnProperty('currency')) {
obj['currency'] = _ApiClient.default.convertToType(data['currency'], 'String');
}
if (data.hasOwnProperty('distPct')) {
obj['distPct'] = _ApiClient.default.convertToType(data['distPct'], 'Number');
}
if (data.hasOwnProperty('distOldTerm')) {
obj['distOldTerm'] = _ApiClient.default.convertToType(data['distOldTerm'], 'Number');
}
if (data.hasOwnProperty('distNewTerm')) {
obj['distNewTerm'] = _ApiClient.default.convertToType(data['distNewTerm'], 'Number');
}
if (data.hasOwnProperty('rightsIssuePrice')) {
obj['rightsIssuePrice'] = _ApiClient.default.convertToType(data['rightsIssuePrice'], 'Number');
}
if (data.hasOwnProperty('rightsIssueCurrency')) {
obj['rightsIssueCurrency'] = _ApiClient.default.convertToType(data['rightsIssueCurrency'], 'String');
}
if (data.hasOwnProperty('shortDesc')) {
obj['shortDesc'] = _ApiClient.default.convertToType(data['shortDesc'], 'String');
}
if (data.hasOwnProperty('requestId')) {
obj['requestId'] = _ApiClient.default.convertToType(data['requestId'], 'String');
}
}
return obj;
}
}
/**
* Factset Regional Security Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R). Identifies the security's best regional security data series per currency. For equities, all primary listings per region and currency are allocated a regional-level permanent identifier. The regional-level permanent identifier will be available once a SEDOL representing the region/currency has been allocated and the identifiers are on FactSet.
* @member {String} fsymId
*/
Distribution.prototype['fsymId'] = undefined;
/**
* FactSet identifier that uniquely identifies the Event.
* @member {String} eventId
*/
Distribution.prototype['eventId'] = undefined;
/**
* Corporate Actions Event type code.
* @member {module:model/Distribution.EventTypeCodeEnum} eventTypeCode
*/
Distribution.prototype['eventTypeCode'] = undefined;
/**
* Corporate Actions Event type description.
* @member {String} eventTypeDesc
*/
Distribution.prototype['eventTypeDesc'] = undefined;
/**
* Date Event was announced in YYYY-MM-DD format.
* @member {String} announcementDate
*/
Distribution.prototype['announcementDate'] = undefined;
/**
* Date of Record for distribution in YYYY-MM-DD format.
* @member {String} recordDate
*/
Distribution.prototype['recordDate'] = undefined;
/**
* Date of Payment for distribution in YYYY-MM-DD format.
* @member {String} payDate
*/
Distribution.prototype['payDate'] = undefined;
/**
* Effective Date or Ex-Date of distribution in YYYY-MM-DD format.
* @member {String} effectiveDate
*/
Distribution.prototype['effectiveDate'] = undefined;
/**
* Factor for adjusting price and shares. A 2-for-1 split returns .50, the number you would multiply the stock price by to adjust for the split.
* @member {Number} adjFactor
*/
Distribution.prototype['adjFactor'] = undefined;
/**
* Combined adjustment factor for all distribution events on that day.
* @member {Number} adjFactorCombined
*/
Distribution.prototype['adjFactorCombined'] = undefined;
/**
* Default Amount - Trading Currency, Split Adjusted
* @member {Number} amtDefTradingAdj
*/
Distribution.prototype['amtDefTradingAdj'] = undefined;
/**
* Default Amount - Trading Currency, Unadjusted
* @member {Number} amtDefTradingUnadj
*/
Distribution.prototype['amtDefTradingUnadj'] = undefined;
/**
* Currency ISO code. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
* @member {String} currency
*/
Distribution.prototype['currency'] = undefined;
/**
* Distribution percentage of the event (i.e. 10%). Typical for stock distributions.
* @member {Number} distPct
*/
Distribution.prototype['distPct'] = undefined;
/**
* Component of distribution ratio - Number of shares held.
* @member {Number} distOldTerm
*/
Distribution.prototype['distOldTerm'] = undefined;
/**
* Component of distribution ratio - Number of shares received.
* @member {Number} distNewTerm
*/
Distribution.prototype['distNewTerm'] = undefined;
/**
* Description
* @member {Number} rightsIssuePrice
*/
Distribution.prototype['rightsIssuePrice'] = undefined;
/**
* Description
* @member {String} rightsIssueCurrency
*/
Distribution.prototype['rightsIssueCurrency'] = undefined;
/**
* Textual description identifying the event.
* @member {String} shortDesc
*/
Distribution.prototype['shortDesc'] = undefined;
/**
* Identifier that was used for the request.
* @member {String} requestId
*/
Distribution.prototype['requestId'] = undefined;
/**
* Allowed values for the <code>eventTypeCode</code> property.
* @enum {String}
* @readonly
*/
Distribution['EventTypeCodeEnum'] = {
/**
* value: "DVS"
* @const
*/
"DVS": "DVS",
/**
* value: "DVSS"
* @const
*/
"DVSS": "DVSS",
/**
* value: "BNS"
* @const
*/
"BNS": "BNS",
/**
* value: "BNSS"
* @const
*/
"BNSS": "BNSS",
/**
* value: "SPO"
* @const
*/
"SPO": "SPO",
/**
* value: "DSR"
* @const
*/
"DSR": "DSR"
};
var _default = exports.default = Distribution;