@factset/sdk-factsetglobalprices
Version:
FactSet Global Prices client library for JavaScript
403 lines (363 loc) • 13.4 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 Dividend model module.
* @module model/Dividend
*/
class Dividend {
/**
* Constructs a new <code>Dividend</code>.
* @alias module:model/Dividend
*/
constructor() {
Dividend.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>Dividend</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/Dividend} obj Optional instance to populate.
* @return {module:model/Dividend} The populated <code>Dividend</code> instance.
*/
static constructFromObject(data, obj) {
if (data) {
obj = obj || new Dividend();
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('divTypeCode')) {
obj['divTypeCode'] = _ApiClient.default.convertToType(data['divTypeCode'], '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('currency')) {
obj['currency'] = _ApiClient.default.convertToType(data['currency'], 'String');
}
if (data.hasOwnProperty('amtDefNetGrossIndicator')) {
obj['amtDefNetGrossIndicator'] = _ApiClient.default.convertToType(data['amtDefNetGrossIndicator'], 'String');
}
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('amtGrossTradingAdj')) {
obj['amtGrossTradingAdj'] = _ApiClient.default.convertToType(data['amtGrossTradingAdj'], 'Number');
}
if (data.hasOwnProperty('amtGrossTradingUnadj')) {
obj['amtGrossTradingUnadj'] = _ApiClient.default.convertToType(data['amtGrossTradingUnadj'], 'Number');
}
if (data.hasOwnProperty('amtNetTradingAdj')) {
obj['amtNetTradingAdj'] = _ApiClient.default.convertToType(data['amtNetTradingAdj'], 'Number');
}
if (data.hasOwnProperty('amtNetTradingUnadj')) {
obj['amtNetTradingUnadj'] = _ApiClient.default.convertToType(data['amtNetTradingUnadj'], 'Number');
}
if (data.hasOwnProperty('declaredCurrency')) {
obj['declaredCurrency'] = _ApiClient.default.convertToType(data['declaredCurrency'], 'String');
}
if (data.hasOwnProperty('amtDefDecAdj')) {
obj['amtDefDecAdj'] = _ApiClient.default.convertToType(data['amtDefDecAdj'], 'Number');
}
if (data.hasOwnProperty('amtDefDecUnadj')) {
obj['amtDefDecUnadj'] = _ApiClient.default.convertToType(data['amtDefDecUnadj'], 'Number');
}
if (data.hasOwnProperty('amtGrossDecAdj')) {
obj['amtGrossDecAdj'] = _ApiClient.default.convertToType(data['amtGrossDecAdj'], 'Number');
}
if (data.hasOwnProperty('amtGrossDecUnadj')) {
obj['amtGrossDecUnadj'] = _ApiClient.default.convertToType(data['amtGrossDecUnadj'], 'Number');
}
if (data.hasOwnProperty('amtNetDecAdj')) {
obj['amtNetDecAdj'] = _ApiClient.default.convertToType(data['amtNetDecAdj'], 'Number');
}
if (data.hasOwnProperty('amtNetDecUnadj')) {
obj['amtNetDecUnadj'] = _ApiClient.default.convertToType(data['amtNetDecUnadj'], 'Number');
}
if (data.hasOwnProperty('dividendStatus')) {
obj['dividendStatus'] = _ApiClient.default.convertToType(data['dividendStatus'], 'Number');
}
if (data.hasOwnProperty('dividendActiveFlag')) {
obj['dividendActiveFlag'] = _ApiClient.default.convertToType(data['dividendActiveFlag'], 'Number');
}
if (data.hasOwnProperty('dividendsSpecFlag')) {
obj['dividendsSpecFlag'] = _ApiClient.default.convertToType(data['dividendsSpecFlag'], 'Number');
}
if (data.hasOwnProperty('frankDefTradingAdj')) {
obj['frankDefTradingAdj'] = _ApiClient.default.convertToType(data['frankDefTradingAdj'], 'Number');
}
if (data.hasOwnProperty('frankDefTradingUnadj')) {
obj['frankDefTradingUnadj'] = _ApiClient.default.convertToType(data['frankDefTradingUnadj'], 'Number');
}
if (data.hasOwnProperty('frankDefDecAdj')) {
obj['frankDefDecAdj'] = _ApiClient.default.convertToType(data['frankDefDecAdj'], 'Number');
}
if (data.hasOwnProperty('frankDefDecUnadj')) {
obj['frankDefDecUnadj'] = _ApiClient.default.convertToType(data['frankDefDecUnadj'], 'Number');
}
if (data.hasOwnProperty('frankPct')) {
obj['frankPct'] = _ApiClient.default.convertToType(data['frankPct'], 'Number');
}
if (data.hasOwnProperty('taxRate')) {
obj['taxRate'] = _ApiClient.default.convertToType(data['taxRate'], 'Number');
}
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
*/
Dividend.prototype['fsymId'] = undefined;
/**
* FactSet identifier that uniquely identifies the Event.
* @member {String} eventId
*/
Dividend.prototype['eventId'] = undefined;
/**
* Corporate Actions Event type code.
* @member {module:model/Dividend.EventTypeCodeEnum} eventTypeCode
*/
Dividend.prototype['eventTypeCode'] = undefined;
/**
* Corporate Actions Event type description.
* @member {String} eventTypeDesc
*/
Dividend.prototype['eventTypeDesc'] = undefined;
/**
* Dividend Type Code. For code descriptions, visit [Online Assistant Page #8764] (https://oa.apps.factset.com/pages/8764).
* @member {String} divTypeCode
*/
Dividend.prototype['divTypeCode'] = undefined;
/**
* Date Event was announced in YYYY-MM-DD format.
* @member {String} announcementDate
*/
Dividend.prototype['announcementDate'] = undefined;
/**
* Date of Record for distribution in YYYY-MM-DD format.
* @member {String} recordDate
*/
Dividend.prototype['recordDate'] = undefined;
/**
* Date of Payment for distribution in YYYY-MM-DD format.
* @member {String} payDate
*/
Dividend.prototype['payDate'] = undefined;
/**
* Effective Date or Ex-Date of distribution in YYYY-MM-DD format.
* @member {String} effectiveDate
*/
Dividend.prototype['effectiveDate'] = undefined;
/**
* Currency ISO code. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
* @member {String} currency
*/
Dividend.prototype['currency'] = undefined;
/**
* Net/Gross Marker Code. For details describing Net vs. Gross dividends, visit [Online Assistant Page #11512](https://oa.apps.factset.com/pages/11512).
* @member {module:model/Dividend.AmtDefNetGrossIndicatorEnum} amtDefNetGrossIndicator
*/
Dividend.prototype['amtDefNetGrossIndicator'] = undefined;
/**
* Default Amount - Trading Currency, Split Adjusted
* @member {Number} amtDefTradingAdj
*/
Dividend.prototype['amtDefTradingAdj'] = undefined;
/**
* Default Amount - Trading Currency, Unadjusted
* @member {Number} amtDefTradingUnadj
*/
Dividend.prototype['amtDefTradingUnadj'] = undefined;
/**
* Gross Amount - Trading Currency, Split Adjusted
* @member {Number} amtGrossTradingAdj
*/
Dividend.prototype['amtGrossTradingAdj'] = undefined;
/**
* Gross Amount - Trading Currency, Unadjusted
* @member {Number} amtGrossTradingUnadj
*/
Dividend.prototype['amtGrossTradingUnadj'] = undefined;
/**
* Net Amount - Trading Currency, Split Adjusted
* @member {Number} amtNetTradingAdj
*/
Dividend.prototype['amtNetTradingAdj'] = undefined;
/**
* Net Amount - Trading Currency, Unadjusted
* @member {Number} amtNetTradingUnadj
*/
Dividend.prototype['amtNetTradingUnadj'] = undefined;
/**
* Currency code for declared dividend.
* @member {String} declaredCurrency
*/
Dividend.prototype['declaredCurrency'] = undefined;
/**
* Default Amount - Declared Currency, Split Adjusted
* @member {Number} amtDefDecAdj
*/
Dividend.prototype['amtDefDecAdj'] = undefined;
/**
* Default Amount - Declared Currency, Unadjusted
* @member {Number} amtDefDecUnadj
*/
Dividend.prototype['amtDefDecUnadj'] = undefined;
/**
* Gross Amount - Declared Currency, Split Adjusted
* @member {Number} amtGrossDecAdj
*/
Dividend.prototype['amtGrossDecAdj'] = undefined;
/**
* Gross Amount - Declared Currency, Unadjusted
* @member {Number} amtGrossDecUnadj
*/
Dividend.prototype['amtGrossDecUnadj'] = undefined;
/**
* Net Amount - Declared Currency, Split Adjusted
* @member {Number} amtNetDecAdj
*/
Dividend.prototype['amtNetDecAdj'] = undefined;
/**
* Net Amount - Declared Currency, Unadjusted
* @member {Number} amtNetDecUnadj
*/
Dividend.prototype['amtNetDecUnadj'] = undefined;
/**
* Dividend Status Flag - 1=Yes, 0=No
* @member {Number} dividendStatus
*/
Dividend.prototype['dividendStatus'] = undefined;
/**
* Dividend active Flag - 1=Yes, 0=No
* @member {Number} dividendActiveFlag
*/
Dividend.prototype['dividendActiveFlag'] = undefined;
/**
* Special Dividend Flag - 1=Yes, 0=No
* @member {Number} dividendsSpecFlag
*/
Dividend.prototype['dividendsSpecFlag'] = undefined;
/**
* Default Frank - Trading Currency, Split Adjusted
* @member {Number} frankDefTradingAdj
*/
Dividend.prototype['frankDefTradingAdj'] = undefined;
/**
* Default Frank - Trading Currency, Unadjusted
* @member {Number} frankDefTradingUnadj
*/
Dividend.prototype['frankDefTradingUnadj'] = undefined;
/**
* Default Frank - Declared Currency, Split Adjusted
* @member {Number} frankDefDecAdj
*/
Dividend.prototype['frankDefDecAdj'] = undefined;
/**
* Default Frank - Declared Currency, Unadjusted
* @member {Number} frankDefDecUnadj
*/
Dividend.prototype['frankDefDecUnadj'] = undefined;
/**
* Default Amount - Declared Currency, Unadjusted
* @member {Number} frankPct
*/
Dividend.prototype['frankPct'] = undefined;
/**
* Tax Rate for on gross dividend for net dividend.
* @member {Number} taxRate
*/
Dividend.prototype['taxRate'] = undefined;
/**
* Identifier that was used for the request.
* @member {String} requestId
*/
Dividend.prototype['requestId'] = undefined;
/**
* Allowed values for the <code>eventTypeCode</code> property.
* @enum {String}
* @readonly
*/
Dividend['EventTypeCodeEnum'] = {
/**
* value: "DVC"
* @const
*/
"DVC": "DVC",
/**
* value: "DVCD"
* @const
*/
"DVCD": "DVCD",
/**
* value: "DRP"
* @const
*/
"DRP": "DRP"
};
/**
* Allowed values for the <code>amtDefNetGrossIndicator</code> property.
* @enum {String}
* @readonly
*/
Dividend['AmtDefNetGrossIndicatorEnum'] = {
/**
* value: "N"
* @const
*/
"N": "N",
/**
* value: "G"
* @const
*/
"G": "G"
};
var _default = exports.default = Dividend;