@factset/sdk-factsetglobalprices
Version:
FactSet Global Prices client library for JavaScript
562 lines (530 loc) • 22.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
var _AnnualizedDividendsObject = _interopRequireDefault(require("./AnnualizedDividendsObject"));
var _CorporateAction = _interopRequireDefault(require("./CorporateAction"));
var _MarketValueResponseObject = _interopRequireDefault(require("./MarketValueResponseObject"));
var _Price = _interopRequireDefault(require("./Price"));
var _Returns = _interopRequireDefault(require("./Returns"));
var _SharesOutstandingResponseObject = _interopRequireDefault(require("./SharesOutstandingResponseObject"));
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 BatchResult model module.
* @module model/BatchResult
*/
class BatchResult {
/**
* Constructs a new <code>BatchResult</code>.
* @alias module:model/BatchResult
* @implements module:model/Price
* @implements module:model/Returns
* @implements module:model/CorporateAction
* @implements module:model/AnnualizedDividendsObject
* @implements module:model/SharesOutstandingResponseObject
* @implements module:model/MarketValueResponseObject
*/
constructor() {
_Price.default.initialize(this);
_Returns.default.initialize(this);
_CorporateAction.default.initialize(this);
_AnnualizedDividendsObject.default.initialize(this);
_SharesOutstandingResponseObject.default.initialize(this);
_MarketValueResponseObject.default.initialize(this);
BatchResult.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>BatchResult</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/BatchResult} obj Optional instance to populate.
* @return {module:model/BatchResult} The populated <code>BatchResult</code> instance.
*/
static constructFromObject(data, obj) {
if (data) {
obj = obj || new BatchResult();
try {
obj = _Price.default.constructFromObject(data, obj);
} catch (error) {}
try {
obj = _Returns.default.constructFromObject(data, obj);
} catch (error) {}
try {
obj = _CorporateAction.default.constructFromObject(data, obj);
} catch (error) {}
try {
obj = _AnnualizedDividendsObject.default.constructFromObject(data, obj);
} catch (error) {}
try {
obj = _SharesOutstandingResponseObject.default.constructFromObject(data, obj);
} catch (error) {}
try {
obj = _MarketValueResponseObject.default.constructFromObject(data, obj);
} catch (error) {}
if (data.hasOwnProperty('fsymId') && obj['fsymId'] === undefined) {
obj['fsymId'] = _ApiClient.default.convertToType(data['fsymId'], 'String');
}
if (data.hasOwnProperty('date') && obj['date'] === undefined) {
obj['date'] = _ApiClient.default.convertToType(data['date'], 'Date');
}
if (data.hasOwnProperty('currency') && obj['currency'] === undefined) {
obj['currency'] = _ApiClient.default.convertToType(data['currency'], 'String');
}
if (data.hasOwnProperty('requestId') && obj['requestId'] === undefined) {
obj['requestId'] = _ApiClient.default.convertToType(data['requestId'], 'String');
}
if (data.hasOwnProperty('totalReturn') && obj['totalReturn'] === undefined) {
obj['totalReturn'] = _ApiClient.default.convertToType(data['totalReturn'], 'Number');
}
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('divTypeCode') && obj['divTypeCode'] === undefined) {
obj['divTypeCode'] = _ApiClient.default.convertToType(data['divTypeCode'], '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('iadDefTradingAdj') && obj['iadDefTradingAdj'] === undefined) {
obj['iadDefTradingAdj'] = _ApiClient.default.convertToType(data['iadDefTradingAdj'], 'Number');
}
if (data.hasOwnProperty('documentId') && obj['documentId'] === undefined) {
obj['documentId'] = _ApiClient.default.convertToType(data['documentId'], 'String');
}
if (data.hasOwnProperty('reportDate') && obj['reportDate'] === undefined) {
obj['reportDate'] = _ApiClient.default.convertToType(data['reportDate'], 'Date');
}
if (data.hasOwnProperty('publicationDate') && obj['publicationDate'] === undefined) {
obj['publicationDate'] = _ApiClient.default.convertToType(data['publicationDate'], 'Date');
}
if (data.hasOwnProperty('fiscalYear') && obj['fiscalYear'] === undefined) {
obj['fiscalYear'] = _ApiClient.default.convertToType(data['fiscalYear'], 'Number');
}
if (data.hasOwnProperty('reportingPeriodDescription') && obj['reportingPeriodDescription'] === undefined) {
obj['reportingPeriodDescription'] = _ApiClient.default.convertToType(data['reportingPeriodDescription'], 'String');
}
if (data.hasOwnProperty('reportingPeriod') && obj['reportingPeriod'] === undefined) {
obj['reportingPeriod'] = _ApiClient.default.convertToType(data['reportingPeriod'], 'Number');
}
if (data.hasOwnProperty('description') && obj['description'] === undefined) {
obj['description'] = _ApiClient.default.convertToType(data['description'], 'String');
}
if (data.hasOwnProperty('adrDescription') && obj['adrDescription'] === undefined) {
obj['adrDescription'] = _ApiClient.default.convertToType(data['adrDescription'], 'String');
}
if (data.hasOwnProperty('adrRatio') && obj['adrRatio'] === undefined) {
obj['adrRatio'] = _ApiClient.default.convertToType(data['adrRatio'], 'Number');
}
if (data.hasOwnProperty('adrFsymId') && obj['adrFsymId'] === undefined) {
obj['adrFsymId'] = _ApiClient.default.convertToType(data['adrFsymId'], 'String');
}
if (data.hasOwnProperty('totalOutstanding') && obj['totalOutstanding'] === undefined) {
obj['totalOutstanding'] = _ApiClient.default.convertToType(data['totalOutstanding'], 'Number');
}
if (data.hasOwnProperty('adrTotalOutstanding') && obj['adrTotalOutstanding'] === undefined) {
obj['adrTotalOutstanding'] = _ApiClient.default.convertToType(data['adrTotalOutstanding'], 'Number');
}
if (data.hasOwnProperty('currentMarketValue') && obj['currentMarketValue'] === undefined) {
obj['currentMarketValue'] = _ApiClient.default.convertToType(data['currentMarketValue'], 'Number');
}
}
return obj;
}
}
/**
* Security-level FactSet Permanent Identifier associated with the identifier.
* @member {String} fsymId
*/
BatchResult.prototype['fsymId'] = undefined;
/**
* Current Market Value Date
* @member {Date} date
*/
BatchResult.prototype['date'] = undefined;
/**
* Currency ISO code associated with the annualized dividends. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
* @member {String} currency
*/
BatchResult.prototype['currency'] = undefined;
/**
* FactSet Security Permanent Identifier that was used for the request.
* @member {String} requestId
*/
BatchResult.prototype['requestId'] = undefined;
/**
* Returns the data for the given input parameters.
* @member {Number} totalReturn
*/
BatchResult.prototype['totalReturn'] = undefined;
/**
* FactSet identifier that uniquely identifies the Event.
* @member {String} eventId
*/
BatchResult.prototype['eventId'] = undefined;
/**
* Corporate Actions Event type code, possible values: [ DVC, DVCD, DRP, DVS, DVSS, BNS, BNSS, SPO, DSR, FSP, RSP, SPL ]
* @member {String} eventTypeCode
*/
BatchResult.prototype['eventTypeCode'] = undefined;
/**
* Corporate Actions Event type description.
* @member {String} eventTypeDesc
*/
BatchResult.prototype['eventTypeDesc'] = undefined;
/**
* Dividend Type Code. For code descriptions, visit [Online Assistant Page #8764] (https://oa.apps.factset.com/pages/8764).
* @member {String} divTypeCode
*/
BatchResult.prototype['divTypeCode'] = undefined;
/**
* Date Event was announced in YYYY-MM-DD format.
* @member {String} announcementDate
*/
BatchResult.prototype['announcementDate'] = undefined;
/**
* Date of Record for distribution in YYYY-MM-DD format.
* @member {String} recordDate
*/
BatchResult.prototype['recordDate'] = undefined;
/**
* Date of Payment for distribution in YYYY-MM-DD format.
* @member {String} payDate
*/
BatchResult.prototype['payDate'] = undefined;
/**
* Effective Date or Ex-Date of Annualized Dividend in YYYY-MM-DD format.
* @member {String} effectiveDate
*/
BatchResult.prototype['effectiveDate'] = undefined;
/**
* Annualized Dividend value in the trading currency. The value is adjusted for splits
* @member {Number} iadDefTradingAdj
*/
BatchResult.prototype['iadDefTradingAdj'] = undefined;
/**
* Unique Identifier for each document or filing which contains the outstanding shares position.
* @member {String} documentId
*/
BatchResult.prototype['documentId'] = undefined;
/**
* Reporting date of the position.
* @member {Date} reportDate
*/
BatchResult.prototype['reportDate'] = undefined;
/**
* Exact date that results have been communicated to the market.
* @member {Date} publicationDate
*/
BatchResult.prototype['publicationDate'] = undefined;
/**
* The company's fiscal year corresponding to the report.
* @member {Number} fiscalYear
*/
BatchResult.prototype['fiscalYear'] = undefined;
/**
* Textual description of the reporting period.
* @member {String} reportingPeriodDescription
*/
BatchResult.prototype['reportingPeriodDescription'] = undefined;
/**
* Code representing the unique reporting period. Options are as follows: - 1 - 1st Quarter - 2 - 2nd Quarter - 3 - 3rd Quarter - 4 - 4th Quarter - 6 - Mid-Year
* @member {Number} reportingPeriod
*/
BatchResult.prototype['reportingPeriod'] = undefined;
/**
* Different stock types based on the rights and benefits from ownership.
* @member {String} description
*/
BatchResult.prototype['description'] = undefined;
/**
* Different stock types based on the rights and benefits from ownership for the ADR.
* @member {String} adrDescription
*/
BatchResult.prototype['adrDescription'] = undefined;
/**
* Number of common or ordinary shares that are equivalent to one American Depositary Receipt (ADR).
* @member {Number} adrRatio
*/
BatchResult.prototype['adrRatio'] = undefined;
/**
* Unique FactSet generated identifier assigned to a security, representing the ADR security.
* @member {String} adrFsymId
*/
BatchResult.prototype['adrFsymId'] = undefined;
/**
* Number of shares outstanding as of `date`.
* @member {Number} totalOutstanding
*/
BatchResult.prototype['totalOutstanding'] = undefined;
/**
* Number of shares outstanding for the ADR as of `date`.
* @member {Number} adrTotalOutstanding
*/
BatchResult.prototype['adrTotalOutstanding'] = undefined;
/**
* Market Value for a specified security. (Current Only)
* @member {Number} currentMarketValue
*/
BatchResult.prototype['currentMarketValue'] = undefined;
// Implement Price interface:
/**
* FactSet Permanent Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R) or a -L Suffix (XXXXXX-L).
* @member {String} fsymId
*/
_Price.default.prototype['fsymId'] = undefined;
/**
* Ending date for the period expressed in YYYY-MM-DD format.
* @member {Date} date
*/
_Price.default.prototype['date'] = undefined;
/**
* Currency ISO code. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
* @member {String} currency
*/
_Price.default.prototype['currency'] = undefined;
/**
* Identifier that was used for the request.
* @member {String} requestId
*/
_Price.default.prototype['requestId'] = undefined;
// Implement Returns interface:
/**
* 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.default.prototype['fsymId'] = undefined;
/**
* Returns the data for the given input parameters.
* @member {Number} totalReturn
*/
_Returns.default.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.default.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.default.prototype['currency'] = undefined;
/**
* Identifier that was used for the request.
* @member {String} requestId
*/
_Returns.default.prototype['requestId'] = undefined;
// Implement CorporateAction interface:
/**
* 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
*/
_CorporateAction.default.prototype['fsymId'] = undefined;
/**
* FactSet identifier that uniquely identifies the Event.
* @member {String} eventId
*/
_CorporateAction.default.prototype['eventId'] = undefined;
/**
* Corporate Actions Event type code, possible values: [ DVC, DVCD, DRP, DVS, DVSS, BNS, BNSS, SPO, DSR, FSP, RSP, SPL ]
* @member {String} eventTypeCode
*/
_CorporateAction.default.prototype['eventTypeCode'] = undefined;
/**
* Corporate Actions Event type description.
* @member {String} eventTypeDesc
*/
_CorporateAction.default.prototype['eventTypeDesc'] = undefined;
/**
* Dividend Type Code. For code descriptions, visit [Online Assistant Page #8764] (https://oa.apps.factset.com/pages/8764).
* @member {String} divTypeCode
*/
_CorporateAction.default.prototype['divTypeCode'] = undefined;
/**
* Date Event was announced in YYYY-MM-DD format.
* @member {String} announcementDate
*/
_CorporateAction.default.prototype['announcementDate'] = undefined;
/**
* Date of Record for distribution in YYYY-MM-DD format.
* @member {String} recordDate
*/
_CorporateAction.default.prototype['recordDate'] = undefined;
/**
* Date of Payment for distribution in YYYY-MM-DD format.
* @member {String} payDate
*/
_CorporateAction.default.prototype['payDate'] = undefined;
/**
* Effective Date or Ex-Date of distribution in YYYY-MM-DD format.
* @member {String} effectiveDate
*/
_CorporateAction.default.prototype['effectiveDate'] = undefined;
/**
* Identifier that was used for the request.
* @member {String} requestId
*/
_CorporateAction.default.prototype['requestId'] = undefined;
// Implement AnnualizedDividendsObject interface:
/**
* 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
*/
_AnnualizedDividendsObject.default.prototype['fsymId'] = undefined;
/**
* FactSet identifier that uniquely identifies the Event.
* @member {String} eventId
*/
_AnnualizedDividendsObject.default.prototype['eventId'] = undefined;
/**
* Effective Date or Ex-Date of Annualized Dividend in YYYY-MM-DD format.
* @member {String} effectiveDate
*/
_AnnualizedDividendsObject.default.prototype['effectiveDate'] = undefined;
/**
* Annualized Dividend value in the trading currency. The value is adjusted for splits
* @member {Number} iadDefTradingAdj
*/
_AnnualizedDividendsObject.default.prototype['iadDefTradingAdj'] = undefined;
/**
* Currency ISO code associated with the annualized dividends. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
* @member {String} currency
*/
_AnnualizedDividendsObject.default.prototype['currency'] = undefined;
/**
* Identifier that was used for the request.
* @member {String} requestId
*/
_AnnualizedDividendsObject.default.prototype['requestId'] = undefined;
// Implement SharesOutstandingResponseObject interface:
/**
* Security-level FactSet Permanent Identifier associated with the identifier.
* @member {String} fsymId
*/
_SharesOutstandingResponseObject.default.prototype['fsymId'] = undefined;
/**
* Date of the record in YYYY-MM-DD format.
* @member {Date} date
*/
_SharesOutstandingResponseObject.default.prototype['date'] = undefined;
/**
* Unique Identifier for each document or filing which contains the outstanding shares position.
* @member {String} documentId
*/
_SharesOutstandingResponseObject.default.prototype['documentId'] = undefined;
/**
* FactSet Security Permanent Identifier that was used for the request.
* @member {String} requestId
*/
_SharesOutstandingResponseObject.default.prototype['requestId'] = undefined;
/**
* Reporting date of the position.
* @member {Date} reportDate
*/
_SharesOutstandingResponseObject.default.prototype['reportDate'] = undefined;
/**
* Exact date that results have been communicated to the market.
* @member {Date} publicationDate
*/
_SharesOutstandingResponseObject.default.prototype['publicationDate'] = undefined;
/**
* The company's fiscal year corresponding to the report.
* @member {Number} fiscalYear
*/
_SharesOutstandingResponseObject.default.prototype['fiscalYear'] = undefined;
/**
* Textual description of the reporting period.
* @member {String} reportingPeriodDescription
*/
_SharesOutstandingResponseObject.default.prototype['reportingPeriodDescription'] = undefined;
/**
* Code representing the unique reporting period. Options are as follows: - 1 - 1st Quarter - 2 - 2nd Quarter - 3 - 3rd Quarter - 4 - 4th Quarter - 6 - Mid-Year
* @member {Number} reportingPeriod
*/
_SharesOutstandingResponseObject.default.prototype['reportingPeriod'] = undefined;
/**
* Different stock types based on the rights and benefits from ownership.
* @member {String} description
*/
_SharesOutstandingResponseObject.default.prototype['description'] = undefined;
/**
* Different stock types based on the rights and benefits from ownership for the ADR.
* @member {String} adrDescription
*/
_SharesOutstandingResponseObject.default.prototype['adrDescription'] = undefined;
/**
* Number of common or ordinary shares that are equivalent to one American Depositary Receipt (ADR).
* @member {Number} adrRatio
*/
_SharesOutstandingResponseObject.default.prototype['adrRatio'] = undefined;
/**
* Unique FactSet generated identifier assigned to a security, representing the ADR security.
* @member {String} adrFsymId
*/
_SharesOutstandingResponseObject.default.prototype['adrFsymId'] = undefined;
/**
* Number of shares outstanding as of `date`.
* @member {Number} totalOutstanding
*/
_SharesOutstandingResponseObject.default.prototype['totalOutstanding'] = undefined;
/**
* Number of shares outstanding for the ADR as of `date`.
* @member {Number} adrTotalOutstanding
*/
_SharesOutstandingResponseObject.default.prototype['adrTotalOutstanding'] = undefined;
// Implement MarketValueResponseObject interface:
/**
* Security-level FactSet Permanent Identifier associated with the identifier.
* @member {String} fsymId
*/
_MarketValueResponseObject.default.prototype['fsymId'] = undefined;
/**
* FactSet Security Permanent Identifier that was used for the request.
* @member {String} requestId
*/
_MarketValueResponseObject.default.prototype['requestId'] = undefined;
/**
* Market Value for a specified security. (Current Only)
* @member {Number} currentMarketValue
*/
_MarketValueResponseObject.default.prototype['currentMarketValue'] = undefined;
/**
* Current Market Value Date
* @member {Date} date
*/
_MarketValueResponseObject.default.prototype['date'] = undefined;
var _default = exports.default = BatchResult;