@factset/sdk-factsetglobalprices
Version:
FactSet Global Prices client library for JavaScript
232 lines (210 loc) • 8.65 kB
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 SplitCalendar model module.
* @module model/SplitCalendar
*/
class SplitCalendar {
/**
* Constructs a new <code>SplitCalendar</code>.
* @alias module:model/SplitCalendar
*/
constructor() {
SplitCalendar.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>SplitCalendar</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/SplitCalendar} obj Optional instance to populate.
* @return {module:model/SplitCalendar} The populated <code>SplitCalendar</code> instance.
*/
static constructFromObject(data, obj) {
if (data) {
obj = obj || new SplitCalendar();
if (data.hasOwnProperty('fsymId') && obj['fsymId'] === undefined) {
obj['fsymId'] = _ApiClient.default.convertToType(data['fsymId'], 'String');
}
if (data.hasOwnProperty('eventId') && obj['eventId'] === undefined) {
obj['eventId'] = _ApiClient.default.convertToType(data['eventId'], 'String');
}
if (data.hasOwnProperty('eventTypeCode') && obj['eventTypeCode'] === undefined) {
obj['eventTypeCode'] = _ApiClient.default.convertToType(data['eventTypeCode'], 'String');
}
if (data.hasOwnProperty('eventTypeDesc') && obj['eventTypeDesc'] === undefined) {
obj['eventTypeDesc'] = _ApiClient.default.convertToType(data['eventTypeDesc'], 'String');
}
if (data.hasOwnProperty('announcementDate') && obj['announcementDate'] === undefined) {
obj['announcementDate'] = _ApiClient.default.convertToType(data['announcementDate'], 'String');
}
if (data.hasOwnProperty('recordDate') && obj['recordDate'] === undefined) {
obj['recordDate'] = _ApiClient.default.convertToType(data['recordDate'], 'String');
}
if (data.hasOwnProperty('payDate') && obj['payDate'] === undefined) {
obj['payDate'] = _ApiClient.default.convertToType(data['payDate'], 'String');
}
if (data.hasOwnProperty('effectiveDate') && obj['effectiveDate'] === undefined) {
obj['effectiveDate'] = _ApiClient.default.convertToType(data['effectiveDate'], 'String');
}
if (data.hasOwnProperty('adjFactor') && obj['adjFactor'] === undefined) {
obj['adjFactor'] = _ApiClient.default.convertToType(data['adjFactor'], 'Number');
}
if (data.hasOwnProperty('adjFactorCombined') && obj['adjFactorCombined'] === undefined) {
obj['adjFactorCombined'] = _ApiClient.default.convertToType(data['adjFactorCombined'], 'Number');
}
if (data.hasOwnProperty('distOldTerm') && obj['distOldTerm'] === undefined) {
obj['distOldTerm'] = _ApiClient.default.convertToType(data['distOldTerm'], 'Number');
}
if (data.hasOwnProperty('distNewTerm') && obj['distNewTerm'] === undefined) {
obj['distNewTerm'] = _ApiClient.default.convertToType(data['distNewTerm'], 'Number');
}
if (data.hasOwnProperty('distInstFsymId') && obj['distInstFsymId'] === undefined) {
obj['distInstFsymId'] = _ApiClient.default.convertToType(data['distInstFsymId'], 'String');
}
if (data.hasOwnProperty('shortDesc') && obj['shortDesc'] === undefined) {
obj['shortDesc'] = _ApiClient.default.convertToType(data['shortDesc'], '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('error') && obj['error'] === undefined) {
obj['error'] = _ErrorObjectResponse.default.constructFromObject(data['error']);
}
}
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
*/
SplitCalendar.prototype['fsymId'] = undefined;
/**
* FactSet identifier that uniquely identifies the Event.
* @member {String} eventId
*/
SplitCalendar.prototype['eventId'] = undefined;
/**
* Character code that denotes the type of Event.
* @member {module:model/SplitCalendar.EventTypeCodeEnum} eventTypeCode
*/
SplitCalendar.prototype['eventTypeCode'] = undefined;
/**
* Corporate Actions Event type description.
* @member {String} eventTypeDesc
*/
SplitCalendar.prototype['eventTypeDesc'] = undefined;
/**
* Date Event was announced in YYYY-MM-DD format.
* @member {String} announcementDate
*/
SplitCalendar.prototype['announcementDate'] = undefined;
/**
* Date of Record for distribution in YYYY-MM-DD format.
* @member {String} recordDate
*/
SplitCalendar.prototype['recordDate'] = undefined;
/**
* Date of Payment for distribution in YYYY-MM-DD format.
* @member {String} payDate
*/
SplitCalendar.prototype['payDate'] = undefined;
/**
* Effective Date or Ex-Date of distribution in YYYY-MM-DD format.
* @member {String} effectiveDate
*/
SplitCalendar.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
*/
SplitCalendar.prototype['adjFactor'] = undefined;
/**
* Combined adjustment factor for all distribution events on that day.
* @member {Number} adjFactorCombined
*/
SplitCalendar.prototype['adjFactorCombined'] = undefined;
/**
* Component of distribution ratio - Number of shares held.
* @member {Number} distOldTerm
*/
SplitCalendar.prototype['distOldTerm'] = undefined;
/**
* Component of distribution ratio - Number of shares received.
* @member {Number} distNewTerm
*/
SplitCalendar.prototype['distNewTerm'] = undefined;
/**
* Parent Spin-Off for a company
* @member {String} distInstFsymId
*/
SplitCalendar.prototype['distInstFsymId'] = undefined;
/**
* Textual description identifying the event.
* @member {String} shortDesc
*/
SplitCalendar.prototype['shortDesc'] = 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
*/
SplitCalendar.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
*/
SplitCalendar.prototype['identifier'] = undefined;
/**
* @member {module:model/ErrorObjectResponse} error
*/
SplitCalendar.prototype['error'] = undefined;
/**
* Allowed values for the <code>eventTypeCode</code> property.
* @enum {String}
* @readonly
*/
SplitCalendar['EventTypeCodeEnum'] = {
/**
* value: "FSP"
* @const
*/
"FSP": "FSP",
/**
* value: "RSP"
* @const
*/
"RSP": "RSP",
/**
* value: "SPL"
* @const
*/
"SPL": "SPL"
};
var _default = exports.default = SplitCalendar;