@factset/sdk-symbology
Version:
Symbology client library for JavaScript
128 lines (119 loc) • 5.7 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
var _GetHistoricalInputSymbolType = _interopRequireDefault(require("./GetHistoricalInputSymbolType"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/**
* FactSet Symbology API
* The FactSet Symbology API provides symbol resolution services, allowing clients to translate market identifiers into various symbology types such as, FactSet Permanent Identifiers, CUSIP, ISIN, SEDOL, Tickers, and LEIs. <p>Factset's Symbology API sits at the center of its hub-and-spoke data model, enabling you to quickly harmonize the expanding catalog of Content APIs.</p><p>This API is rate-limited to 10 requests per second and 10 concurrent requests per user.</p>
*
* The version of the OpenAPI document: 3.4.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 IdentifierResolutionHistoricalRequestBody model module.
* @module model/IdentifierResolutionHistoricalRequestBody
*/
class IdentifierResolutionHistoricalRequestBody {
/**
* Constructs a new <code>IdentifierResolutionHistoricalRequestBody</code>.
* Request object for Historical Identifier Resolution endpoint.
* @alias module:model/IdentifierResolutionHistoricalRequestBody
* @param ids {Array.<String>} Requested market securities or entities. All requested identifiers must be of the same type. Accepted identifiers include all FactSet Permanent Identifiers types, CUSIP, SEDOL, ISIN, and Tickers. This request value is sent back in the response as, `requestId'.
* @param inputSymbolType {module:model/GetHistoricalInputSymbolType}
* @param outputSymbolTypes {Array.<module:model/IdentifierResolutionHistoricalRequestBody.OutputSymbolTypesEnum>} Requested identifiers to be returned. Multiple identifier types can be requested with each request.
*/
constructor(ids, inputSymbolType, outputSymbolTypes) {
IdentifierResolutionHistoricalRequestBody.initialize(this, ids, inputSymbolType, outputSymbolTypes);
}
/**
* 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, ids, inputSymbolType, outputSymbolTypes) {
obj['ids'] = ids;
obj['inputSymbolType'] = inputSymbolType;
obj['outputSymbolTypes'] = outputSymbolTypes;
}
/**
* Constructs a <code>IdentifierResolutionHistoricalRequestBody</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/IdentifierResolutionHistoricalRequestBody} obj Optional instance to populate.
* @return {module:model/IdentifierResolutionHistoricalRequestBody} The populated <code>IdentifierResolutionHistoricalRequestBody</code> instance.
*/
static constructFromObject(data, obj) {
if (data) {
obj = obj || new IdentifierResolutionHistoricalRequestBody();
if (data.hasOwnProperty('ids')) {
obj['ids'] = _ApiClient.default.convertToType(data['ids'], ['String']);
}
if (data.hasOwnProperty('inputSymbolType')) {
obj['inputSymbolType'] = _GetHistoricalInputSymbolType.default.constructFromObject(data['inputSymbolType']);
}
if (data.hasOwnProperty('outputSymbolTypes')) {
obj['outputSymbolTypes'] = _ApiClient.default.convertToType(data['outputSymbolTypes'], ['String']);
}
if (data.hasOwnProperty('asOfDate')) {
obj['asOfDate'] = _ApiClient.default.convertToType(data['asOfDate'], 'Date');
}
}
return obj;
}
}
/**
* Requested market securities or entities. All requested identifiers must be of the same type. Accepted identifiers include all FactSet Permanent Identifiers types, CUSIP, SEDOL, ISIN, and Tickers. This request value is sent back in the response as, `requestId'.
* @member {Array.<String>} ids
*/
IdentifierResolutionHistoricalRequestBody.prototype['ids'] = undefined;
/**
* @member {module:model/GetHistoricalInputSymbolType} inputSymbolType
*/
IdentifierResolutionHistoricalRequestBody.prototype['inputSymbolType'] = undefined;
/**
* Requested identifiers to be returned. Multiple identifier types can be requested with each request.
* @member {Array.<module:model/IdentifierResolutionHistoricalRequestBody.OutputSymbolTypesEnum>} outputSymbolTypes
*/
IdentifierResolutionHistoricalRequestBody.prototype['outputSymbolTypes'] = undefined;
/**
* As of date for historical symbol request in YYYY-MM-DD format. If no `asOfDate` is requested, the response will include the full history of the identifier.
* @member {Date} asOfDate
*/
IdentifierResolutionHistoricalRequestBody.prototype['asOfDate'] = undefined;
/**
* Allowed values for the <code>outputSymbolTypes</code> property.
* @enum {String}
* @readonly
*/
IdentifierResolutionHistoricalRequestBody['OutputSymbolTypesEnum'] = {
/**
* value: "SEDOL"
* @const
*/
"SEDOL": "SEDOL",
/**
* value: "CUSIP"
* @const
*/
"CUSIP": "CUSIP",
/**
* value: "ISIN"
* @const
*/
"ISIN": "ISIN",
/**
* value: "tickerRegion"
* @const
*/
"tickerRegion": "tickerRegion"
};
var _default = exports.default = IdentifierResolutionHistoricalRequestBody;