diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..93f13619 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +npm-debug.log diff --git a/git_push.sh b/git_push.sh new file mode 100644 index 00000000..afa2a9d3 --- /dev/null +++ b/git_push.sh @@ -0,0 +1,52 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 + +if [ "$git_user_id" = "" ]; then + git_user_id="intrinio" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="javascript-sdk" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="No release notes for this build" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=`git remote` +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the Git credential in your environment." + git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' + diff --git a/package.json b/package.json index 44eb0007..22e158e6 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "version": "0.0.1", "description": "Access the Intrinio API", "license": "GPLv3", - "main": "src/invoker/index.js", + "main": "src/index.js", "scripts": { "test": "./node_modules/mocha/bin/mocha --recursive" }, diff --git a/src/ApiClient.js b/src/ApiClient.js index b57fe1e4..b7c89a57 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -31,7 +31,7 @@ 'use strict'; /** - * @module invoker/ApiClient + * @module ApiClient * @version 0.0.1 */ @@ -39,7 +39,7 @@ * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an * application to use this class directly - the *Api and model classes provide the public API for the service. The * contents of this file should be regarded as internal but are documented for completeness. - * @alias module:invoker/ApiClient + * @alias module:ApiClient * @class */ var exports = function() { @@ -261,7 +261,7 @@ /** * Builds a string representation of an array-type actual parameter, according to the given collection format. * @param {Array} param An array parameter. - * @param {module:invoker/ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy. + * @param {module:ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy. * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns * param as is if collectionFormat is multi. */ @@ -578,7 +578,7 @@ /** * The default API client implementation. - * @type {module:invoker/ApiClient} + * @type {module:ApiClient} */ exports.instance = new exports(); diff --git a/src/invoker/api/CompanyApi.js b/src/api/CompanyApi.js similarity index 90% rename from src/invoker/api/CompanyApi.js rename to src/api/CompanyApi.js index f6a7e5c8..471310d9 100644 --- a/src/invoker/api/CompanyApi.js +++ b/src/api/CompanyApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/Company', 'invoker/model/CompanyNews', 'invoker/model/CompanySummary', 'invoker/model/DataPointNumber', 'invoker/model/DataPointText', 'invoker/model/FilingSummary', 'invoker/model/Fundamental', 'invoker/model/HistoricalData'], factory); + define(['ApiClient', 'model/Company', 'model/CompanyNews', 'model/CompanySummary', 'model/DataPointNumber', 'model/DataPointText', 'model/FilingSummary', 'model/Fundamental', 'model/HistoricalData'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/Company'), require('../model/CompanyNews'), require('../model/CompanySummary'), require('../model/DataPointNumber'), require('../model/DataPointText'), require('../model/FilingSummary'), require('../model/Fundamental'), require('../model/HistoricalData')); @@ -32,16 +32,16 @@ /** * Company service. - * @module invoker/api/CompanyApi + * @module api/CompanyApi * @version 0.0.1 */ /** * Constructs a new CompanyApi. - * @alias module:invoker/api/CompanyApi + * @alias module:api/CompanyApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -59,7 +59,7 @@ * @param {String} opts.industryCategory Industry category * @param {String} opts.industryGroup Industry group * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.filterCompaniesWithHttpInfo = function(opts) { opts = opts || {}; @@ -107,7 +107,7 @@ * @param {String} opts.industryCategory Industry category * @param {String} opts.industryGroup Industry group * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.filterCompanies = function(opts) { return this.filterCompaniesWithHttpInfo(opts) @@ -126,12 +126,12 @@ * @param {Date} opts.filedBefore Filed on or before this date * @param {Boolean} opts.reportedOnly Only as-reported fundamentals * @param {Number} opts.fiscalYear Only for the given fiscal year - * @param {module:invoker/model/String} opts.statementCode Only of the given statement code - * @param {module:invoker/model/String} opts.type Only of the given type + * @param {module:model/String} opts.statementCode Only of the given statement code + * @param {module:model/String} opts.type Only of the given type * @param {Date} opts.startDate Only on or after the given date * @param {Date} opts.endDate Only on or after the given date * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.filterCompanyFundamentalsWithHttpInfo = function(identifier, opts) { opts = opts || {}; @@ -185,12 +185,12 @@ * @param {Date} opts.filedBefore Filed on or before this date * @param {Boolean} opts.reportedOnly Only as-reported fundamentals * @param {Number} opts.fiscalYear Only for the given fiscal year - * @param {module:invoker/model/String} opts.statementCode Only of the given statement code - * @param {module:invoker/model/String} opts.type Only of the given type + * @param {module:model/String} opts.statementCode Only of the given statement code + * @param {module:model/String} opts.type Only of the given type * @param {Date} opts.startDate Only on or after the given date * @param {Date} opts.endDate Only on or after the given date * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.filterCompanyFundamentals = function(identifier, opts) { return this.filterCompanyFundamentalsWithHttpInfo(identifier, opts) @@ -204,7 +204,7 @@ * Get All Companies * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllCompaniesWithHttpInfo = function(opts) { opts = opts || {}; @@ -239,7 +239,7 @@ * Get All Companies * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllCompanies = function(opts) { return this.getAllCompaniesWithHttpInfo(opts) @@ -255,7 +255,7 @@ * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllCompanyFilingsWithHttpInfo = function(identifier, opts) { opts = opts || {}; @@ -298,7 +298,7 @@ * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllCompanyFilings = function(identifier, opts) { return this.getAllCompanyFilingsWithHttpInfo(identifier, opts) @@ -314,7 +314,7 @@ * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllCompanyFundamentalsWithHttpInfo = function(identifier, opts) { opts = opts || {}; @@ -357,7 +357,7 @@ * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllCompanyFundamentals = function(identifier, opts) { return this.getAllCompanyFundamentalsWithHttpInfo(identifier, opts) @@ -370,7 +370,7 @@ /** * Get a Company by ID * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/Company} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Company} and HTTP response */ this.getCompanyWithHttpInfo = function(identifier) { var postBody = null; @@ -408,7 +408,7 @@ /** * Get a Company by ID * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/Company} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Company} */ this.getCompany = function(identifier) { return this.getCompanyWithHttpInfo(identifier) @@ -423,7 +423,7 @@ * Returns a numeric value for the given `item` for the Company with the given `identifier` * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointNumber} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointNumber} and HTTP response */ this.getCompanyDataPointNumberWithHttpInfo = function(identifier, item) { var postBody = null; @@ -469,7 +469,7 @@ * Returns a numeric value for the given `item` for the Company with the given `identifier` * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointNumber} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointNumber} */ this.getCompanyDataPointNumber = function(identifier, item) { return this.getCompanyDataPointNumberWithHttpInfo(identifier, item) @@ -484,7 +484,7 @@ * Returns a text value for the given `item` for the Company with the given `identifier` * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointText} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointText} and HTTP response */ this.getCompanyDataPointTextWithHttpInfo = function(identifier, item) { var postBody = null; @@ -530,7 +530,7 @@ * Returns a text value for the given `item` for the Company with the given `identifier` * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointText} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointText} */ this.getCompanyDataPointText = function(identifier, item) { return this.getCompanyDataPointTextWithHttpInfo(identifier, item) @@ -549,9 +549,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getCompanyHistoricalDataWithHttpInfo = function(identifier, item, opts) { opts = opts || {}; @@ -607,9 +607,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getCompanyHistoricalData = function(identifier, item, opts) { return this.getCompanyHistoricalDataWithHttpInfo(identifier, item, opts) @@ -625,7 +625,7 @@ * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getNewsWithHttpInfo = function(identifier, opts) { opts = opts || {}; @@ -668,7 +668,7 @@ * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getNews = function(identifier, opts) { return this.getNewsWithHttpInfo(identifier, opts) @@ -682,10 +682,10 @@ * Lookup a Fundamental for a Company * Returns the Fundamental for the Company with the given `identifier` and with the given parameters * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) - * @param {module:invoker/model/String} statementCode The statement code - * @param {module:invoker/model/String} fiscalPeriod The fiscal period + * @param {module:model/String} statementCode The statement code + * @param {module:model/String} fiscalPeriod The fiscal period * @param {Number} fiscalYear The fiscal year - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.lookupCompanyFundamentalWithHttpInfo = function(identifier, statementCode, fiscalPeriod, fiscalYear) { var postBody = null; @@ -742,10 +742,10 @@ * Lookup a Fundamental for a Company * Returns the Fundamental for the Company with the given `identifier` and with the given parameters * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) - * @param {module:invoker/model/String} statementCode The statement code - * @param {module:invoker/model/String} fiscalPeriod The fiscal period + * @param {module:model/String} statementCode The statement code + * @param {module:model/String} fiscalPeriod The fiscal period * @param {Number} fiscalYear The fiscal year - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.lookupCompanyFundamental = function(identifier, statementCode, fiscalPeriod, fiscalYear) { return this.lookupCompanyFundamentalWithHttpInfo(identifier, statementCode, fiscalPeriod, fiscalYear) @@ -761,7 +761,7 @@ * @param {String} query Search parameters * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.searchCompaniesWithHttpInfo = function(query, opts) { opts = opts || {}; @@ -804,7 +804,7 @@ * @param {String} query Search parameters * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.searchCompanies = function(query, opts) { return this.searchCompaniesWithHttpInfo(query, opts) diff --git a/src/invoker/api/DataPointApi.js b/src/api/DataPointApi.js similarity index 90% rename from src/invoker/api/DataPointApi.js rename to src/api/DataPointApi.js index 5e4f0b1d..8932bf9e 100644 --- a/src/invoker/api/DataPointApi.js +++ b/src/api/DataPointApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/DataPointNumber', 'invoker/model/DataPointText'], factory); + define(['ApiClient', 'model/DataPointNumber', 'model/DataPointText'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/DataPointNumber'), require('../model/DataPointText')); @@ -32,16 +32,16 @@ /** * DataPoint service. - * @module invoker/api/DataPointApi + * @module api/DataPointApi * @version 0.0.1 */ /** * Constructs a new DataPointApi. - * @alias module:invoker/api/DataPointApi + * @alias module:api/DataPointApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -53,7 +53,7 @@ * Returns a numeric value for the given `item` and the entity with the given `identifier` * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointNumber} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointNumber} and HTTP response */ this.getDataPointNumberWithHttpInfo = function(identifier, item) { var postBody = null; @@ -99,7 +99,7 @@ * Returns a numeric value for the given `item` and the entity with the given `identifier` * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointNumber} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointNumber} */ this.getDataPointNumber = function(identifier, item) { return this.getDataPointNumberWithHttpInfo(identifier, item) @@ -114,7 +114,7 @@ * Returns a text value for the given `item` and the entity with the given `identifier` * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointText} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointText} and HTTP response */ this.getDataPointTextWithHttpInfo = function(identifier, item) { var postBody = null; @@ -160,7 +160,7 @@ * Returns a text value for the given `item` and the entity with the given `identifier` * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointText} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointText} */ this.getDataPointText = function(identifier, item) { return this.getDataPointTextWithHttpInfo(identifier, item) diff --git a/src/invoker/api/FilingApi.js b/src/api/FilingApi.js similarity index 90% rename from src/invoker/api/FilingApi.js rename to src/api/FilingApi.js index 688456a9..c1b371c8 100644 --- a/src/invoker/api/FilingApi.js +++ b/src/api/FilingApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/Filing'], factory); + define(['ApiClient', 'model/Filing'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/Filing')); @@ -32,16 +32,16 @@ /** * Filing service. - * @module invoker/api/FilingApi + * @module api/FilingApi * @version 0.0.1 */ /** * Constructs a new FilingApi. - * @alias module:invoker/api/FilingApi + * @alias module:api/FilingApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -56,7 +56,7 @@ * @param {Date} opts.startDate Filed on or after the given date * @param {Date} opts.endDate Filed before or after the given date * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.filterFilingsWithHttpInfo = function(company, opts) { opts = opts || {}; @@ -104,7 +104,7 @@ * @param {Date} opts.startDate Filed on or after the given date * @param {Date} opts.endDate Filed before or after the given date * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.filterFilings = function(company, opts) { return this.filterFilingsWithHttpInfo(company, opts) @@ -118,7 +118,7 @@ * Get All Filings * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllFilingsWithHttpInfo = function(opts) { opts = opts || {}; @@ -153,7 +153,7 @@ * Get All Filings * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllFilings = function(opts) { return this.getAllFilingsWithHttpInfo(opts) @@ -166,7 +166,7 @@ /** * Get a Filing by ID * @param {String} id The Intrinio ID of the Filing - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/Filing} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Filing} and HTTP response */ this.getFilingByIdWithHttpInfo = function(id) { var postBody = null; @@ -204,7 +204,7 @@ /** * Get a Filing by ID * @param {String} id The Intrinio ID of the Filing - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/Filing} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Filing} */ this.getFilingById = function(id) { return this.getFilingByIdWithHttpInfo(id) diff --git a/src/invoker/api/FundamentalsApi.js b/src/api/FundamentalsApi.js similarity index 89% rename from src/invoker/api/FundamentalsApi.js rename to src/api/FundamentalsApi.js index 3807fbe2..8cb8d7e7 100644 --- a/src/invoker/api/FundamentalsApi.js +++ b/src/api/FundamentalsApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/Fundamental', 'invoker/model/ReportedFinancial', 'invoker/model/StandardizedFinancial'], factory); + define(['ApiClient', 'model/Fundamental', 'model/ReportedFinancial', 'model/StandardizedFinancial'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/Fundamental'), require('../model/ReportedFinancial'), require('../model/StandardizedFinancial')); @@ -32,16 +32,16 @@ /** * Fundamentals service. - * @module invoker/api/FundamentalsApi + * @module api/FundamentalsApi * @version 0.0.1 */ /** * Constructs a new FundamentalsApi. - * @alias module:invoker/api/FundamentalsApi + * @alias module:api/FundamentalsApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -52,7 +52,7 @@ * Get a Fundamental by ID * Retrieves detailed fundamental data for the given `fundamental_id`. * @param {String} id The Intrinio ID for the Fundamental - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/Fundamental} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Fundamental} and HTTP response */ this.getFundamentalByIdWithHttpInfo = function(id) { var postBody = null; @@ -91,7 +91,7 @@ * Get a Fundamental by ID * Retrieves detailed fundamental data for the given `fundamental_id`. * @param {String} id The Intrinio ID for the Fundamental - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/Fundamental} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Fundamental} */ this.getFundamentalById = function(id) { return this.getFundamentalByIdWithHttpInfo(id) @@ -105,7 +105,7 @@ * Get Reported Financials for a Fundamental * Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company * @param {String} id The Intrinio ID for the Fundamental - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getFundamentalReportedFinancialsWithHttpInfo = function(id) { var postBody = null; @@ -144,7 +144,7 @@ * Get Reported Financials for a Fundamental * Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company * @param {String} id The Intrinio ID for the Fundamental - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getFundamentalReportedFinancials = function(id) { return this.getFundamentalReportedFinancialsWithHttpInfo(id) @@ -158,7 +158,7 @@ * Get Standardized Financials for a Fundamental * Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards. * @param {String} id The Intrinio ID for the Fundamental - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getFundamentalStandardizedFinancialsWithHttpInfo = function(id) { var postBody = null; @@ -197,7 +197,7 @@ * Get Standardized Financials for a Fundamental * Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards. * @param {String} id The Intrinio ID for the Fundamental - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getFundamentalStandardizedFinancials = function(id) { return this.getFundamentalStandardizedFinancialsWithHttpInfo(id) @@ -211,10 +211,10 @@ * Lookup a Fundamental * Returns the Fundamental for the Company with the given `identifier` and with the given parameters * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) - * @param {module:invoker/model/String} statementCode The statement code - * @param {module:invoker/model/String} fiscalPeriod The fiscal period + * @param {module:model/String} statementCode The statement code + * @param {module:model/String} fiscalPeriod The fiscal period * @param {Number} fiscalYear The fiscal year - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.lookupFundamentalWithHttpInfo = function(identifier, statementCode, fiscalPeriod, fiscalYear) { var postBody = null; @@ -271,10 +271,10 @@ * Lookup a Fundamental * Returns the Fundamental for the Company with the given `identifier` and with the given parameters * @param {String} identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID) - * @param {module:invoker/model/String} statementCode The statement code - * @param {module:invoker/model/String} fiscalPeriod The fiscal period + * @param {module:model/String} statementCode The statement code + * @param {module:model/String} fiscalPeriod The fiscal period * @param {Number} fiscalYear The fiscal year - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.lookupFundamental = function(identifier, statementCode, fiscalPeriod, fiscalYear) { return this.lookupFundamentalWithHttpInfo(identifier, statementCode, fiscalPeriod, fiscalYear) diff --git a/src/invoker/api/HistoricalDataApi.js b/src/api/HistoricalDataApi.js similarity index 87% rename from src/invoker/api/HistoricalDataApi.js rename to src/api/HistoricalDataApi.js index 2fb42082..748261ff 100644 --- a/src/invoker/api/HistoricalDataApi.js +++ b/src/api/HistoricalDataApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/HistoricalData'], factory); + define(['ApiClient', 'model/HistoricalData'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/HistoricalData')); @@ -32,16 +32,16 @@ /** * HistoricalData service. - * @module invoker/api/HistoricalDataApi + * @module api/HistoricalDataApi * @version 0.0.1 */ /** * Constructs a new HistoricalDataApi. - * @alias module:invoker/api/HistoricalDataApi + * @alias module:api/HistoricalDataApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -57,9 +57,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical date on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getHistoricalDataWithHttpInfo = function(identifier, item, opts) { opts = opts || {}; @@ -115,9 +115,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical date on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getHistoricalData = function(identifier, item, opts) { return this.getHistoricalDataWithHttpInfo(identifier, item, opts) diff --git a/src/invoker/api/IndexApi.js b/src/api/IndexApi.js similarity index 90% rename from src/invoker/api/IndexApi.js rename to src/api/IndexApi.js index 66102b91..b8c19154 100644 --- a/src/invoker/api/IndexApi.js +++ b/src/api/IndexApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/DataPointNumber', 'invoker/model/DataPointText', 'invoker/model/EconomicIndex', 'invoker/model/EconomicIndexSummary', 'invoker/model/HistoricalData', 'invoker/model/SICIndex', 'invoker/model/StockMarketIndex', 'invoker/model/StockMarketIndexSummary'], factory); + define(['ApiClient', 'model/DataPointNumber', 'model/DataPointText', 'model/EconomicIndex', 'model/EconomicIndexSummary', 'model/HistoricalData', 'model/SICIndex', 'model/StockMarketIndex', 'model/StockMarketIndexSummary'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/DataPointNumber'), require('../model/DataPointText'), require('../model/EconomicIndex'), require('../model/EconomicIndexSummary'), require('../model/HistoricalData'), require('../model/SICIndex'), require('../model/StockMarketIndex'), require('../model/StockMarketIndexSummary')); @@ -32,16 +32,16 @@ /** * Index service. - * @module invoker/api/IndexApi + * @module api/IndexApi * @version 0.0.1 */ /** * Constructs a new IndexApi. - * @alias module:invoker/api/IndexApi + * @alias module:api/IndexApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -52,7 +52,7 @@ * Get ALl Economic Indices * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllEconomicIndicesWithHttpInfo = function(opts) { opts = opts || {}; @@ -87,7 +87,7 @@ * Get ALl Economic Indices * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllEconomicIndices = function(opts) { return this.getAllEconomicIndicesWithHttpInfo(opts) @@ -101,7 +101,7 @@ * Get All SIC Indices * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllSicIndicesWithHttpInfo = function(opts) { opts = opts || {}; @@ -136,7 +136,7 @@ * Get All SIC Indices * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllSicIndices = function(opts) { return this.getAllSicIndicesWithHttpInfo(opts) @@ -150,7 +150,7 @@ * Get All Stock Market Indices * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllStockMarketIndicesWithHttpInfo = function(opts) { opts = opts || {}; @@ -185,7 +185,7 @@ * Get All Stock Market Indices * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllStockMarketIndices = function(opts) { return this.getAllStockMarketIndicesWithHttpInfo(opts) @@ -198,7 +198,7 @@ /** * Get an Economic Index by ID * @param {String} identifier An Index Identifier (symbol, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/EconomicIndex} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EconomicIndex} and HTTP response */ this.getEconomicIndexByIdWithHttpInfo = function(identifier) { var postBody = null; @@ -236,7 +236,7 @@ /** * Get an Economic Index by ID * @param {String} identifier An Index Identifier (symbol, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/EconomicIndex} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EconomicIndex} */ this.getEconomicIndexById = function(identifier) { return this.getEconomicIndexByIdWithHttpInfo(identifier) @@ -251,7 +251,7 @@ * Returns a numeric value for the given `item` for the Economic Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointNumber} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointNumber} and HTTP response */ this.getEconomicIndexDataPointNumberWithHttpInfo = function(identifier, item) { var postBody = null; @@ -297,7 +297,7 @@ * Returns a numeric value for the given `item` for the Economic Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointNumber} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointNumber} */ this.getEconomicIndexDataPointNumber = function(identifier, item) { return this.getEconomicIndexDataPointNumberWithHttpInfo(identifier, item) @@ -312,7 +312,7 @@ * Returns a text value for the given `item` for the Economic Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointText} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointText} and HTTP response */ this.getEconomicIndexDataPointTextWithHttpInfo = function(identifier, item) { var postBody = null; @@ -358,7 +358,7 @@ * Returns a text value for the given `item` for the Economic Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointText} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointText} */ this.getEconomicIndexDataPointText = function(identifier, item) { return this.getEconomicIndexDataPointTextWithHttpInfo(identifier, item) @@ -377,9 +377,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {Number} opts.pageSize (default to 100) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getEconomicIndexHistoricalDataWithHttpInfo = function(identifier, item, opts) { opts = opts || {}; @@ -435,9 +435,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {Number} opts.pageSize (default to 100) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getEconomicIndexHistoricalData = function(identifier, item, opts) { return this.getEconomicIndexHistoricalDataWithHttpInfo(identifier, item, opts) @@ -450,7 +450,7 @@ /** * Get an SIC Index by ID * @param {String} identifier An Index Identifier (symbol, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/SICIndex} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SICIndex} and HTTP response */ this.getSicIndexByIdWithHttpInfo = function(identifier) { var postBody = null; @@ -488,7 +488,7 @@ /** * Get an SIC Index by ID * @param {String} identifier An Index Identifier (symbol, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/SICIndex} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SICIndex} */ this.getSicIndexById = function(identifier) { return this.getSicIndexByIdWithHttpInfo(identifier) @@ -503,7 +503,7 @@ * Returns a numeric value for the given `item` for the SIC Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointNumber} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointNumber} and HTTP response */ this.getSicIndexDataPointNumberWithHttpInfo = function(identifier, item) { var postBody = null; @@ -549,7 +549,7 @@ * Returns a numeric value for the given `item` for the SIC Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointNumber} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointNumber} */ this.getSicIndexDataPointNumber = function(identifier, item) { return this.getSicIndexDataPointNumberWithHttpInfo(identifier, item) @@ -564,7 +564,7 @@ * Returns a text value for the given `item` for the SIC Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointText} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointText} and HTTP response */ this.getSicIndexDataPointTextWithHttpInfo = function(identifier, item) { var postBody = null; @@ -610,7 +610,7 @@ * Returns a text value for the given `item` for the SIC Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointText} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointText} */ this.getSicIndexDataPointText = function(identifier, item) { return this.getSicIndexDataPointTextWithHttpInfo(identifier, item) @@ -629,9 +629,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {Number} opts.pageSize (default to 100) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getSicIndexHistoricalDataWithHttpInfo = function(identifier, item, opts) { opts = opts || {}; @@ -687,9 +687,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {Number} opts.pageSize (default to 100) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getSicIndexHistoricalData = function(identifier, item, opts) { return this.getSicIndexHistoricalDataWithHttpInfo(identifier, item, opts) @@ -702,7 +702,7 @@ /** * Get a Stock Market Index by ID * @param {String} identifier An Index Identifier (symbol, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/StockMarketIndex} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/StockMarketIndex} and HTTP response */ this.getStockMarketIndexByIdWithHttpInfo = function(identifier) { var postBody = null; @@ -740,7 +740,7 @@ /** * Get a Stock Market Index by ID * @param {String} identifier An Index Identifier (symbol, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/StockMarketIndex} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/StockMarketIndex} */ this.getStockMarketIndexById = function(identifier) { return this.getStockMarketIndexByIdWithHttpInfo(identifier) @@ -755,7 +755,7 @@ * Returns a numeric value for the given `item` for the Stock Market Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointNumber} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointNumber} and HTTP response */ this.getStockMarketIndexDataPointNumberWithHttpInfo = function(identifier, item) { var postBody = null; @@ -801,7 +801,7 @@ * Returns a numeric value for the given `item` for the Stock Market Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointNumber} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointNumber} */ this.getStockMarketIndexDataPointNumber = function(identifier, item) { return this.getStockMarketIndexDataPointNumberWithHttpInfo(identifier, item) @@ -816,7 +816,7 @@ * Returns a text value for the given `item` for the Stock Market Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointText} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointText} and HTTP response */ this.getStockMarketIndexDataPointTextWithHttpInfo = function(identifier, item) { var postBody = null; @@ -862,7 +862,7 @@ * Returns a text value for the given `item` for the Stock Market Index with the given `identifier` * @param {String} identifier An Index Identifier (symbol, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointText} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointText} */ this.getStockMarketIndexDataPointText = function(identifier, item) { return this.getStockMarketIndexDataPointTextWithHttpInfo(identifier, item) @@ -881,9 +881,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {Number} opts.pageSize (default to 100) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getStockMarketIndexHistoricalDataWithHttpInfo = function(identifier, item, opts) { opts = opts || {}; @@ -939,9 +939,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical data on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {Number} opts.pageSize (default to 100) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getStockMarketIndexHistoricalData = function(identifier, item, opts) { return this.getStockMarketIndexHistoricalDataWithHttpInfo(identifier, item, opts) @@ -957,7 +957,7 @@ * @param {String} query Search query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.searchEconomicIndicesWithHttpInfo = function(query, opts) { opts = opts || {}; @@ -1000,7 +1000,7 @@ * @param {String} query Search query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.searchEconomicIndices = function(query, opts) { return this.searchEconomicIndicesWithHttpInfo(query, opts) @@ -1016,7 +1016,7 @@ * @param {String} query Search query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.searchSicIndicesWithHttpInfo = function(query, opts) { opts = opts || {}; @@ -1059,7 +1059,7 @@ * @param {String} query Search query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.searchSicIndices = function(query, opts) { return this.searchSicIndicesWithHttpInfo(query, opts) @@ -1075,7 +1075,7 @@ * @param {String} query Search query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.searchStockMarketsIndicesWithHttpInfo = function(query, opts) { opts = opts || {}; @@ -1118,7 +1118,7 @@ * @param {String} query Search query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.searchStockMarketsIndices = function(query, opts) { return this.searchStockMarketsIndicesWithHttpInfo(query, opts) diff --git a/src/invoker/api/SecurityApi.js b/src/api/SecurityApi.js similarity index 87% rename from src/invoker/api/SecurityApi.js rename to src/api/SecurityApi.js index 60cb22d1..c0c22694 100644 --- a/src/invoker/api/SecurityApi.js +++ b/src/api/SecurityApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/DataPointNumber', 'invoker/model/DataPointText', 'invoker/model/HistoricalData', 'invoker/model/Security', 'invoker/model/SecurityScreenGroup', 'invoker/model/SecurityScreenResult', 'invoker/model/SecuritySummary', 'invoker/model/StockPriceSummary'], factory); + define(['ApiClient', 'model/DataPointNumber', 'model/DataPointText', 'model/HistoricalData', 'model/Security', 'model/SecurityScreenGroup', 'model/SecurityScreenResult', 'model/SecuritySummary', 'model/StockPriceSummary'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/DataPointNumber'), require('../model/DataPointText'), require('../model/HistoricalData'), require('../model/Security'), require('../model/SecurityScreenGroup'), require('../model/SecurityScreenResult'), require('../model/SecuritySummary'), require('../model/StockPriceSummary')); @@ -32,16 +32,16 @@ /** * Security service. - * @module invoker/api/SecurityApi + * @module api/SecurityApi * @version 0.0.1 */ /** * Constructs a new SecurityApi. - * @alias module:invoker/api/SecurityApi + * @alias module:api/SecurityApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -52,7 +52,7 @@ * Get All Securiites * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllSecuritiesWithHttpInfo = function(opts) { opts = opts || {}; @@ -87,7 +87,7 @@ * Get All Securiites * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllSecurities = function(opts) { return this.getAllSecuritiesWithHttpInfo(opts) @@ -100,7 +100,7 @@ /** * Get a Security by ID * @param {String} identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/Security} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Security} and HTTP response */ this.getSecurityByIdWithHttpInfo = function(identifier) { var postBody = null; @@ -138,7 +138,7 @@ /** * Get a Security by ID * @param {String} identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/Security} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Security} */ this.getSecurityById = function(identifier) { return this.getSecurityByIdWithHttpInfo(identifier) @@ -153,7 +153,7 @@ * Returns a numeric value for the given `item` for the Security with the given `identifier` * @param {String} identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointNumber} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointNumber} and HTTP response */ this.getSecurityDataPointNumberWithHttpInfo = function(identifier, item) { var postBody = null; @@ -199,7 +199,7 @@ * Returns a numeric value for the given `item` for the Security with the given `identifier` * @param {String} identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointNumber} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointNumber} */ this.getSecurityDataPointNumber = function(identifier, item) { return this.getSecurityDataPointNumberWithHttpInfo(identifier, item) @@ -214,7 +214,7 @@ * Returns a text value for the given `item` for the Security with the given `identifier` * @param {String} identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointText} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointText} and HTTP response */ this.getSecurityDataPointTextWithHttpInfo = function(identifier, item) { var postBody = null; @@ -260,7 +260,7 @@ * Returns a text value for the given `item` for the Security with the given `identifier` * @param {String} identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) * @param {String} item An Intrinio data tag or other item - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointText} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointText} */ this.getSecurityDataPointText = function(identifier, item) { return this.getSecurityDataPointTextWithHttpInfo(identifier, item) @@ -279,9 +279,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical date on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getSecurityHistoricalDataWithHttpInfo = function(identifier, item, opts) { opts = opts || {}; @@ -337,9 +337,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical date on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getSecurityHistoricalData = function(identifier, item, opts) { return this.getSecurityHistoricalDataWithHttpInfo(identifier, item, opts) @@ -356,9 +356,9 @@ * @param {Object} opts Optional parameters * @param {Date} opts.startDate Return prices on or after the date * @param {Date} opts.endDate Return prices on or beore the date - * @param {module:invoker/model/String} opts.frequency Return stock prices in the given frequency (default to daily) + * @param {module:model/String} opts.frequency Return stock prices in the given frequency (default to daily) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getSecurityStockPricesWithHttpInfo = function(identifier, opts) { opts = opts || {}; @@ -405,9 +405,9 @@ * @param {Object} opts Optional parameters * @param {Date} opts.startDate Return prices on or after the date * @param {Date} opts.endDate Return prices on or beore the date - * @param {module:invoker/model/String} opts.frequency Return stock prices in the given frequency (default to daily) + * @param {module:model/String} opts.frequency Return stock prices in the given frequency (default to daily) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getSecurityStockPrices = function(identifier, opts) { return this.getSecurityStockPricesWithHttpInfo(identifier, opts) @@ -421,12 +421,12 @@ * Screen Securities * Screen securities using complex logic * @param {Object} opts Optional parameters - * @param {module:invoker/model/SecurityScreenGroup} opts.logic The logic to screen with, consisting of operators, clauses, and nested groups + * @param {module:model/SecurityScreenGroup} opts.logic The logic to screen with, consisting of operators, clauses, and nested groups * @param {String} opts.orderColumn Results returned sorted by this column - * @param {module:invoker/model/String} opts.orderDirection Sort order to use with the order_column (default to asc) + * @param {module:model/String} opts.orderDirection Sort order to use with the order_column (default to asc) * @param {Boolean} opts.primaryOnly Return only primary securities (default to false) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.screenSecuritiesWithHttpInfo = function(opts) { opts = opts || {}; @@ -464,12 +464,12 @@ * Screen Securities * Screen securities using complex logic * @param {Object} opts Optional parameters - * @param {module:invoker/model/SecurityScreenGroup} opts.logic The logic to screen with, consisting of operators, clauses, and nested groups + * @param {module:model/SecurityScreenGroup} opts.logic The logic to screen with, consisting of operators, clauses, and nested groups * @param {String} opts.orderColumn Results returned sorted by this column - * @param {module:invoker/model/String} opts.orderDirection Sort order to use with the order_column (default to asc) + * @param {module:model/String} opts.orderDirection Sort order to use with the order_column (default to asc) * @param {Boolean} opts.primaryOnly Return only primary securities (default to false) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.screenSecurities = function(opts) { return this.screenSecuritiesWithHttpInfo(opts) @@ -485,7 +485,7 @@ * @param {String} query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.searchSecuritiesWithHttpInfo = function(query, opts) { opts = opts || {}; @@ -528,7 +528,7 @@ * @param {String} query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.searchSecurities = function(query, opts) { return this.searchSecuritiesWithHttpInfo(query, opts) diff --git a/src/invoker/api/StandardizedTagApi.js b/src/api/StandardizedTagApi.js similarity index 89% rename from src/invoker/api/StandardizedTagApi.js rename to src/api/StandardizedTagApi.js index 4a92cebb..0d3c5b7a 100644 --- a/src/invoker/api/StandardizedTagApi.js +++ b/src/api/StandardizedTagApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/DataPointNumber', 'invoker/model/DataPointText', 'invoker/model/HistoricalData', 'invoker/model/StandardizedTag'], factory); + define(['ApiClient', 'model/DataPointNumber', 'model/DataPointText', 'model/HistoricalData', 'model/StandardizedTag'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/DataPointNumber'), require('../model/DataPointText'), require('../model/HistoricalData'), require('../model/StandardizedTag')); @@ -32,16 +32,16 @@ /** * StandardizedTag service. - * @module invoker/api/StandardizedTagApi + * @module api/StandardizedTagApi * @version 0.0.1 */ /** * Constructs a new StandardizedTagApi. - * @alias module:invoker/api/StandardizedTagApi + * @alias module:api/StandardizedTagApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -55,10 +55,10 @@ * @param {String} opts.tag Tag * @param {String} opts.type Type * @param {String} opts.parent ID of tag parent - * @param {module:invoker/model/String} opts.statementCode Statement Code - * @param {module:invoker/model/String} opts.fsTemplate Template (default to industrial) + * @param {module:model/String} opts.statementCode Statement Code + * @param {module:model/String} opts.fsTemplate Template (default to industrial) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.filterStandardizedTagsWithHttpInfo = function(opts) { opts = opts || {}; @@ -101,10 +101,10 @@ * @param {String} opts.tag Tag * @param {String} opts.type Type * @param {String} opts.parent ID of tag parent - * @param {module:invoker/model/String} opts.statementCode Statement Code - * @param {module:invoker/model/String} opts.fsTemplate Template (default to industrial) + * @param {module:model/String} opts.statementCode Statement Code + * @param {module:model/String} opts.fsTemplate Template (default to industrial) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.filterStandardizedTags = function(opts) { return this.filterStandardizedTagsWithHttpInfo(opts) @@ -118,7 +118,7 @@ * Get All Standardized Tags * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllStandardizedTagsWithHttpInfo = function(opts) { opts = opts || {}; @@ -153,7 +153,7 @@ * Get All Standardized Tags * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllStandardizedTags = function(opts) { return this.getAllStandardizedTagsWithHttpInfo(opts) @@ -166,7 +166,7 @@ /** * Get a Standardized Tag by ID * @param {String} tagId The Intrinio ID for the tag - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/StandardizedTag} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/StandardizedTag} and HTTP response */ this.getStandardizedTagByIdWithHttpInfo = function(tagId) { var postBody = null; @@ -204,7 +204,7 @@ /** * Get a Standardized Tag by ID * @param {String} tagId The Intrinio ID for the tag - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/StandardizedTag} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/StandardizedTag} */ this.getStandardizedTagById = function(tagId) { return this.getStandardizedTagByIdWithHttpInfo(tagId) @@ -219,7 +219,7 @@ * Returns a numeric data point for the Standardized Tag and entity `identifier` * @param {String} id The Intrinio Standardized Tag ID or its tag * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointNumber} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointNumber} and HTTP response */ this.getStandardizedTagDataPointNumberWithHttpInfo = function(id, identifier) { var postBody = null; @@ -265,7 +265,7 @@ * Returns a numeric data point for the Standardized Tag and entity `identifier` * @param {String} id The Intrinio Standardized Tag ID or its tag * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointNumber} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointNumber} */ this.getStandardizedTagDataPointNumber = function(id, identifier) { return this.getStandardizedTagDataPointNumberWithHttpInfo(id, identifier) @@ -280,7 +280,7 @@ * Returns a text data point for the Standardized Tag and entity `identifier` * @param {String} id The Intrinio Standardized Tag ID or its tag * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/DataPointText} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DataPointText} and HTTP response */ this.getStandardizedTagDataPointTextWithHttpInfo = function(id, identifier) { var postBody = null; @@ -326,7 +326,7 @@ * Returns a text data point for the Standardized Tag and entity `identifier` * @param {String} id The Intrinio Standardized Tag ID or its tag * @param {String} identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/DataPointText} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DataPointText} */ this.getStandardizedTagDataPointText = function(id, identifier) { return this.getStandardizedTagDataPointTextWithHttpInfo(id, identifier) @@ -345,9 +345,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical date on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getStandardizedTagHistoricalDataWithHttpInfo = function(id, identifier, opts) { opts = opts || {}; @@ -403,9 +403,9 @@ * @param {String} opts.type Filter by type, when applicable * @param {Date} opts.startDate Get historical data on or after this date * @param {Date} opts.endDate Get historical date on or before this date - * @param {module:invoker/model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) + * @param {module:model/String} opts.sortOrder Sort by date `asc` or `desc` (default to desc) * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getStandardizedTagHistoricalData = function(id, identifier, opts) { return this.getStandardizedTagHistoricalDataWithHttpInfo(id, identifier, opts) @@ -421,7 +421,7 @@ * @param {String} query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.searchStandardizedTagsWithHttpInfo = function(query, opts) { opts = opts || {}; @@ -464,7 +464,7 @@ * @param {String} query * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.searchStandardizedTags = function(query, opts) { return this.searchStandardizedTagsWithHttpInfo(query, opts) diff --git a/src/invoker/api/StockExchangeApi.js b/src/api/StockExchangeApi.js similarity index 91% rename from src/invoker/api/StockExchangeApi.js rename to src/api/StockExchangeApi.js index 3f844ef8..c04caf51 100644 --- a/src/invoker/api/StockExchangeApi.js +++ b/src/api/StockExchangeApi.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/Security', 'invoker/model/StockExchange', 'invoker/model/StockPrice'], factory); + define(['ApiClient', 'model/Security', 'model/StockExchange', 'model/StockPrice'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('../model/Security'), require('../model/StockExchange'), require('../model/StockPrice')); @@ -32,16 +32,16 @@ /** * StockExchange service. - * @module invoker/api/StockExchangeApi + * @module api/StockExchangeApi * @version 0.0.1 */ /** * Constructs a new StockExchangeApi. - * @alias module:invoker/api/StockExchangeApi + * @alias module:api/StockExchangeApi * @class - * @param {module:invoker/ApiClient} [apiClient] Optional API client implementation to use, - * default to {@link module:invoker/ApiClient#instance} if unspecified. + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. */ var exports = function(apiClient) { this.apiClient = apiClient || ApiClient.instance; @@ -55,7 +55,7 @@ * @param {String} opts.country Filter by country * @param {String} opts.countryCode Filter by ISO country code * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.filterStockExchangesWithHttpInfo = function(opts) { opts = opts || {}; @@ -96,7 +96,7 @@ * @param {String} opts.country Filter by country * @param {String} opts.countryCode Filter by ISO country code * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.filterStockExchanges = function(opts) { return this.filterStockExchangesWithHttpInfo(opts) @@ -110,7 +110,7 @@ * Get All Stock Exchanges * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getAllStockExchangesWithHttpInfo = function(opts) { opts = opts || {}; @@ -145,7 +145,7 @@ * Get All Stock Exchanges * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getAllStockExchanges = function(opts) { return this.getAllStockExchangesWithHttpInfo(opts) @@ -158,7 +158,7 @@ /** * Get Stock Exchange by ID * @param {String} identifier A Stock Exchange identifier (MIC or Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:invoker/model/StockExchange} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/StockExchange} and HTTP response */ this.getStockExchangeByIdWithHttpInfo = function(identifier) { var postBody = null; @@ -196,7 +196,7 @@ /** * Get Stock Exchange by ID * @param {String} identifier A Stock Exchange identifier (MIC or Intrinio ID) - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:invoker/model/StockExchange} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/StockExchange} */ this.getStockExchangeById = function(identifier) { return this.getStockExchangeByIdWithHttpInfo(identifier) @@ -213,7 +213,7 @@ * @param {Object} opts Optional parameters * @param {Date} opts._date The date for which to return prices * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getStockExchangePricesWithHttpInfo = function(identifier, opts) { opts = opts || {}; @@ -258,7 +258,7 @@ * @param {Object} opts Optional parameters * @param {Date} opts._date The date for which to return prices * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getStockExchangePrices = function(identifier, opts) { return this.getStockExchangePricesWithHttpInfo(identifier, opts) @@ -274,7 +274,7 @@ * @param {String} identifier A Stock Exchange identifier (MIC or Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.getStockExchangeSecuritiesWithHttpInfo = function(identifier, opts) { opts = opts || {}; @@ -317,7 +317,7 @@ * @param {String} identifier A Stock Exchange identifier (MIC or Intrinio ID) * @param {Object} opts Optional parameters * @param {String} opts.nextPage Gets the next page of data from a previous API call - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.getStockExchangeSecurities = function(identifier, opts) { return this.getStockExchangeSecuritiesWithHttpInfo(identifier, opts) diff --git a/src/index.js b/src/index.js index 53b3a649..46202761 100644 --- a/src/index.js +++ b/src/index.js @@ -16,7 +16,7 @@ (function(factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/Company', 'invoker/model/CompanyNews', 'invoker/model/CompanySummary', 'invoker/model/DataPointNumber', 'invoker/model/DataPointText', 'invoker/model/EconomicIndex', 'invoker/model/EconomicIndexSummary', 'invoker/model/Filing', 'invoker/model/FilingSummary', 'invoker/model/Fundamental', 'invoker/model/FundamentalSummary', 'invoker/model/HistoricalData', 'invoker/model/ReportedFinancial', 'invoker/model/ReportedTag', 'invoker/model/SICIndex', 'invoker/model/Security', 'invoker/model/SecurityScreenClause', 'invoker/model/SecurityScreenGroup', 'invoker/model/SecurityScreenResult', 'invoker/model/SecurityScreenResultData', 'invoker/model/SecuritySummary', 'invoker/model/StandardizedFinancial', 'invoker/model/StandardizedTag', 'invoker/model/StockExchange', 'invoker/model/StockMarketIndex', 'invoker/model/StockMarketIndexSummary', 'invoker/model/StockPrice', 'invoker/model/StockPriceSummary', 'invoker/api/CompanyApi', 'invoker/api/DataPointApi', 'invoker/api/FilingApi', 'invoker/api/FundamentalsApi', 'invoker/api/HistoricalDataApi', 'invoker/api/IndexApi', 'invoker/api/SecurityApi', 'invoker/api/StandardizedTagApi', 'invoker/api/StockExchangeApi'], factory); + define(['ApiClient', 'model/Company', 'model/CompanyNews', 'model/CompanySummary', 'model/DataPointNumber', 'model/DataPointText', 'model/EconomicIndex', 'model/EconomicIndexSummary', 'model/Filing', 'model/FilingSummary', 'model/Fundamental', 'model/FundamentalSummary', 'model/HistoricalData', 'model/ReportedFinancial', 'model/ReportedTag', 'model/SICIndex', 'model/Security', 'model/SecurityScreenClause', 'model/SecurityScreenGroup', 'model/SecurityScreenResult', 'model/SecurityScreenResultData', 'model/SecuritySummary', 'model/StandardizedFinancial', 'model/StandardizedTag', 'model/StockExchange', 'model/StockMarketIndex', 'model/StockMarketIndexSummary', 'model/StockPrice', 'model/StockPriceSummary', 'api/CompanyApi', 'api/DataPointApi', 'api/FilingApi', 'api/FundamentalsApi', 'api/HistoricalDataApi', 'api/IndexApi', 'api/SecurityApi', 'api/StandardizedTagApi', 'api/StockExchangeApi'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('./ApiClient'), require('./model/Company'), require('./model/CompanyNews'), require('./model/CompanySummary'), require('./model/DataPointNumber'), require('./model/DataPointText'), require('./model/EconomicIndex'), require('./model/EconomicIndexSummary'), require('./model/Filing'), require('./model/FilingSummary'), require('./model/Fundamental'), require('./model/FundamentalSummary'), require('./model/HistoricalData'), require('./model/ReportedFinancial'), require('./model/ReportedTag'), require('./model/SICIndex'), require('./model/Security'), require('./model/SecurityScreenClause'), require('./model/SecurityScreenGroup'), require('./model/SecurityScreenResult'), require('./model/SecurityScreenResultData'), require('./model/SecuritySummary'), require('./model/StandardizedFinancial'), require('./model/StandardizedTag'), require('./model/StockExchange'), require('./model/StockMarketIndex'), require('./model/StockMarketIndexSummary'), require('./model/StockPrice'), require('./model/StockPriceSummary'), require('./api/CompanyApi'), require('./api/DataPointApi'), require('./api/FilingApi'), require('./api/FundamentalsApi'), require('./api/HistoricalDataApi'), require('./api/IndexApi'), require('./api/SecurityApi'), require('./api/StandardizedTagApi'), require('./api/StockExchangeApi')); @@ -30,7 +30,7 @@ *

* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: *

-   * var intrinio = require('invoker/index'); // See note below*.
+   * var intrinio = require('index'); // See note below*.
    * var xxxSvc = new intrinio.XxxApi(); // Allocate the API class we're going to use.
    * var yyyModel = new intrinio.Yyy(); // Construct a model instance.
    * yyyModel.someProperty = 'someValue';
@@ -38,7 +38,7 @@
    * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
    * ...
    * 
- * *NOTE: For a top-level AMD script, use require(['invoker/index'], function(){...}) + * *NOTE: For a top-level AMD script, use require(['index'], function(){...}) * and put the application logic within the callback function. *

*

@@ -52,198 +52,198 @@ * ... * *

- * @module invoker/index + * @module index * @version 0.0.1 */ var exports = { /** * The ApiClient constructor. - * @property {module:invoker/ApiClient} + * @property {module:ApiClient} */ ApiClient: ApiClient, /** * The Company model constructor. - * @property {module:invoker/model/Company} + * @property {module:model/Company} */ Company: Company, /** * The CompanyNews model constructor. - * @property {module:invoker/model/CompanyNews} + * @property {module:model/CompanyNews} */ CompanyNews: CompanyNews, /** * The CompanySummary model constructor. - * @property {module:invoker/model/CompanySummary} + * @property {module:model/CompanySummary} */ CompanySummary: CompanySummary, /** * The DataPointNumber model constructor. - * @property {module:invoker/model/DataPointNumber} + * @property {module:model/DataPointNumber} */ DataPointNumber: DataPointNumber, /** * The DataPointText model constructor. - * @property {module:invoker/model/DataPointText} + * @property {module:model/DataPointText} */ DataPointText: DataPointText, /** * The EconomicIndex model constructor. - * @property {module:invoker/model/EconomicIndex} + * @property {module:model/EconomicIndex} */ EconomicIndex: EconomicIndex, /** * The EconomicIndexSummary model constructor. - * @property {module:invoker/model/EconomicIndexSummary} + * @property {module:model/EconomicIndexSummary} */ EconomicIndexSummary: EconomicIndexSummary, /** * The Filing model constructor. - * @property {module:invoker/model/Filing} + * @property {module:model/Filing} */ Filing: Filing, /** * The FilingSummary model constructor. - * @property {module:invoker/model/FilingSummary} + * @property {module:model/FilingSummary} */ FilingSummary: FilingSummary, /** * The Fundamental model constructor. - * @property {module:invoker/model/Fundamental} + * @property {module:model/Fundamental} */ Fundamental: Fundamental, /** * The FundamentalSummary model constructor. - * @property {module:invoker/model/FundamentalSummary} + * @property {module:model/FundamentalSummary} */ FundamentalSummary: FundamentalSummary, /** * The HistoricalData model constructor. - * @property {module:invoker/model/HistoricalData} + * @property {module:model/HistoricalData} */ HistoricalData: HistoricalData, /** * The ReportedFinancial model constructor. - * @property {module:invoker/model/ReportedFinancial} + * @property {module:model/ReportedFinancial} */ ReportedFinancial: ReportedFinancial, /** * The ReportedTag model constructor. - * @property {module:invoker/model/ReportedTag} + * @property {module:model/ReportedTag} */ ReportedTag: ReportedTag, /** * The SICIndex model constructor. - * @property {module:invoker/model/SICIndex} + * @property {module:model/SICIndex} */ SICIndex: SICIndex, /** * The Security model constructor. - * @property {module:invoker/model/Security} + * @property {module:model/Security} */ Security: Security, /** * The SecurityScreenClause model constructor. - * @property {module:invoker/model/SecurityScreenClause} + * @property {module:model/SecurityScreenClause} */ SecurityScreenClause: SecurityScreenClause, /** * The SecurityScreenGroup model constructor. - * @property {module:invoker/model/SecurityScreenGroup} + * @property {module:model/SecurityScreenGroup} */ SecurityScreenGroup: SecurityScreenGroup, /** * The SecurityScreenResult model constructor. - * @property {module:invoker/model/SecurityScreenResult} + * @property {module:model/SecurityScreenResult} */ SecurityScreenResult: SecurityScreenResult, /** * The SecurityScreenResultData model constructor. - * @property {module:invoker/model/SecurityScreenResultData} + * @property {module:model/SecurityScreenResultData} */ SecurityScreenResultData: SecurityScreenResultData, /** * The SecuritySummary model constructor. - * @property {module:invoker/model/SecuritySummary} + * @property {module:model/SecuritySummary} */ SecuritySummary: SecuritySummary, /** * The StandardizedFinancial model constructor. - * @property {module:invoker/model/StandardizedFinancial} + * @property {module:model/StandardizedFinancial} */ StandardizedFinancial: StandardizedFinancial, /** * The StandardizedTag model constructor. - * @property {module:invoker/model/StandardizedTag} + * @property {module:model/StandardizedTag} */ StandardizedTag: StandardizedTag, /** * The StockExchange model constructor. - * @property {module:invoker/model/StockExchange} + * @property {module:model/StockExchange} */ StockExchange: StockExchange, /** * The StockMarketIndex model constructor. - * @property {module:invoker/model/StockMarketIndex} + * @property {module:model/StockMarketIndex} */ StockMarketIndex: StockMarketIndex, /** * The StockMarketIndexSummary model constructor. - * @property {module:invoker/model/StockMarketIndexSummary} + * @property {module:model/StockMarketIndexSummary} */ StockMarketIndexSummary: StockMarketIndexSummary, /** * The StockPrice model constructor. - * @property {module:invoker/model/StockPrice} + * @property {module:model/StockPrice} */ StockPrice: StockPrice, /** * The StockPriceSummary model constructor. - * @property {module:invoker/model/StockPriceSummary} + * @property {module:model/StockPriceSummary} */ StockPriceSummary: StockPriceSummary, /** * The CompanyApi service constructor. - * @property {module:invoker/api/CompanyApi} + * @property {module:api/CompanyApi} */ CompanyApi: CompanyApi, /** * The DataPointApi service constructor. - * @property {module:invoker/api/DataPointApi} + * @property {module:api/DataPointApi} */ DataPointApi: DataPointApi, /** * The FilingApi service constructor. - * @property {module:invoker/api/FilingApi} + * @property {module:api/FilingApi} */ FilingApi: FilingApi, /** * The FundamentalsApi service constructor. - * @property {module:invoker/api/FundamentalsApi} + * @property {module:api/FundamentalsApi} */ FundamentalsApi: FundamentalsApi, /** * The HistoricalDataApi service constructor. - * @property {module:invoker/api/HistoricalDataApi} + * @property {module:api/HistoricalDataApi} */ HistoricalDataApi: HistoricalDataApi, /** * The IndexApi service constructor. - * @property {module:invoker/api/IndexApi} + * @property {module:api/IndexApi} */ IndexApi: IndexApi, /** * The SecurityApi service constructor. - * @property {module:invoker/api/SecurityApi} + * @property {module:api/SecurityApi} */ SecurityApi: SecurityApi, /** * The StandardizedTagApi service constructor. - * @property {module:invoker/api/StandardizedTagApi} + * @property {module:api/StandardizedTagApi} */ StandardizedTagApi: StandardizedTagApi, /** * The StockExchangeApi service constructor. - * @property {module:invoker/api/StockExchangeApi} + * @property {module:api/StockExchangeApi} */ StockExchangeApi: StockExchangeApi }; diff --git a/src/invoker/model/Company.js b/src/model/Company.js similarity index 97% rename from src/invoker/model/Company.js rename to src/model/Company.js index ab2616e8..fc02aa1b 100644 --- a/src/invoker/model/Company.js +++ b/src/model/Company.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The Company model module. - * @module invoker/model/Company + * @module model/Company * @version 0.0.1 */ /** * Constructs a new Company. * A company that submits filings to the SEC and has a security traded primarily on a US exchange - * @alias module:invoker/model/Company + * @alias module:model/Company * @class */ var exports = function() { @@ -86,8 +86,8 @@ * Constructs a Company from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/Company} obj Optional instance to populate. - * @return {module:invoker/model/Company} The populated Company instance. + * @param {module:model/Company} obj Optional instance to populate. + * @return {module:model/Company} The populated Company instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/CompanyNews.js b/src/model/CompanyNews.js similarity index 91% rename from src/invoker/model/CompanyNews.js rename to src/model/CompanyNews.js index 55a6ceb8..c26ec7e5 100644 --- a/src/invoker/model/CompanyNews.js +++ b/src/model/CompanyNews.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The CompanyNews model module. - * @module invoker/model/CompanyNews + * @module model/CompanyNews * @version 0.0.1 */ /** * Constructs a new CompanyNews. * A news article about a company - * @alias module:invoker/model/CompanyNews + * @alias module:model/CompanyNews * @class */ var exports = function() { @@ -58,8 +58,8 @@ * Constructs a CompanyNews from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/CompanyNews} obj Optional instance to populate. - * @return {module:invoker/model/CompanyNews} The populated CompanyNews instance. + * @param {module:model/CompanyNews} obj Optional instance to populate. + * @return {module:model/CompanyNews} The populated CompanyNews instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/CompanySummary.js b/src/model/CompanySummary.js similarity index 91% rename from src/invoker/model/CompanySummary.js rename to src/model/CompanySummary.js index e3ea716f..cb70419d 100644 --- a/src/invoker/model/CompanySummary.js +++ b/src/model/CompanySummary.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The CompanySummary model module. - * @module invoker/model/CompanySummary + * @module model/CompanySummary * @version 0.0.1 */ /** * Constructs a new CompanySummary. * The summary of a company that submits filings to the SEC and has a security traded primarily on a US exchange - * @alias module:invoker/model/CompanySummary + * @alias module:model/CompanySummary * @class */ var exports = function() { @@ -59,8 +59,8 @@ * Constructs a CompanySummary from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/CompanySummary} obj Optional instance to populate. - * @return {module:invoker/model/CompanySummary} The populated CompanySummary instance. + * @param {module:model/CompanySummary} obj Optional instance to populate. + * @return {module:model/CompanySummary} The populated CompanySummary instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/DataPointNumber.js b/src/model/DataPointNumber.js similarity index 87% rename from src/invoker/model/DataPointNumber.js rename to src/model/DataPointNumber.js index f1ee20dd..c1edddcb 100644 --- a/src/invoker/model/DataPointNumber.js +++ b/src/model/DataPointNumber.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The DataPointNumber model module. - * @module invoker/model/DataPointNumber + * @module model/DataPointNumber * @version 0.0.1 */ /** * Constructs a new DataPointNumber. * The latest numeric value for an identifier/item combination - * @alias module:invoker/model/DataPointNumber + * @alias module:model/DataPointNumber * @class */ var exports = function() { @@ -54,8 +54,8 @@ * Constructs a DataPointNumber from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/DataPointNumber} obj Optional instance to populate. - * @return {module:invoker/model/DataPointNumber} The populated DataPointNumber instance. + * @param {module:model/DataPointNumber} obj Optional instance to populate. + * @return {module:model/DataPointNumber} The populated DataPointNumber instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/DataPointText.js b/src/model/DataPointText.js similarity index 87% rename from src/invoker/model/DataPointText.js rename to src/model/DataPointText.js index feae87fd..2dad8ab4 100644 --- a/src/invoker/model/DataPointText.js +++ b/src/model/DataPointText.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The DataPointText model module. - * @module invoker/model/DataPointText + * @module model/DataPointText * @version 0.0.1 */ /** * Constructs a new DataPointText. * The latest text value for an identifier/item combination - * @alias module:invoker/model/DataPointText + * @alias module:model/DataPointText * @class */ var exports = function() { @@ -54,8 +54,8 @@ * Constructs a DataPointText from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/DataPointText} obj Optional instance to populate. - * @return {module:invoker/model/DataPointText} The populated DataPointText instance. + * @param {module:model/DataPointText} obj Optional instance to populate. + * @return {module:model/DataPointText} The populated DataPointText instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/EconomicIndex.js b/src/model/EconomicIndex.js similarity index 94% rename from src/invoker/model/EconomicIndex.js rename to src/model/EconomicIndex.js index 0bbeed75..0fbca732 100644 --- a/src/invoker/model/EconomicIndex.js +++ b/src/model/EconomicIndex.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The EconomicIndex model module. - * @module invoker/model/EconomicIndex + * @module model/EconomicIndex * @version 0.0.1 */ /** * Constructs a new EconomicIndex. * An economic index provided by the St. Lous Fed FRED API, such as GDP, Unemployment, Fed Funds Rate, and more. - * @alias module:invoker/model/EconomicIndex + * @alias module:model/EconomicIndex * @class */ var exports = function() { @@ -66,8 +66,8 @@ * Constructs a EconomicIndex from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/EconomicIndex} obj Optional instance to populate. - * @return {module:invoker/model/EconomicIndex} The populated EconomicIndex instance. + * @param {module:model/EconomicIndex} obj Optional instance to populate. + * @return {module:model/EconomicIndex} The populated EconomicIndex instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/EconomicIndexSummary.js b/src/model/EconomicIndexSummary.js similarity index 93% rename from src/invoker/model/EconomicIndexSummary.js rename to src/model/EconomicIndexSummary.js index 3d7a11a0..075b827c 100644 --- a/src/invoker/model/EconomicIndexSummary.js +++ b/src/model/EconomicIndexSummary.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The EconomicIndexSummary model module. - * @module invoker/model/EconomicIndexSummary + * @module model/EconomicIndexSummary * @version 0.0.1 */ /** * Constructs a new EconomicIndexSummary. * An economic index provided by the St. Lous Fed FRED API, such as GDP, Unemployment, Fed Funds Rate, and more. - * @alias module:invoker/model/EconomicIndexSummary + * @alias module:model/EconomicIndexSummary * @class */ var exports = function() { @@ -65,8 +65,8 @@ * Constructs a EconomicIndexSummary from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/EconomicIndexSummary} obj Optional instance to populate. - * @return {module:invoker/model/EconomicIndexSummary} The populated EconomicIndexSummary instance. + * @param {module:model/EconomicIndexSummary} obj Optional instance to populate. + * @return {module:model/EconomicIndexSummary} The populated EconomicIndexSummary instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/Filing.js b/src/model/Filing.js similarity index 93% rename from src/invoker/model/Filing.js rename to src/model/Filing.js index f8634d39..fab93a15 100644 --- a/src/invoker/model/Filing.js +++ b/src/model/Filing.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/CompanySummary'], factory); + define(['ApiClient', 'model/CompanySummary'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('./CompanySummary')); @@ -35,14 +35,14 @@ /** * The Filing model module. - * @module invoker/model/Filing + * @module model/Filing * @version 0.0.1 */ /** * Constructs a new Filing. * A filing submitted to the SEC by a company - * @alias module:invoker/model/Filing + * @alias module:model/Filing * @class */ var exports = function() { @@ -64,8 +64,8 @@ * Constructs a Filing from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/Filing} obj Optional instance to populate. - * @return {module:invoker/model/Filing} The populated Filing instance. + * @param {module:model/Filing} obj Optional instance to populate. + * @return {module:model/Filing} The populated Filing instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -111,7 +111,7 @@ */ exports.prototype['id'] = undefined; /** - * @member {module:invoker/model/CompanySummary} company + * @member {module:model/CompanySummary} company */ exports.prototype['company'] = undefined; /** diff --git a/src/invoker/model/FilingSummary.js b/src/model/FilingSummary.js similarity index 93% rename from src/invoker/model/FilingSummary.js rename to src/model/FilingSummary.js index 1b07135c..b5989bf1 100644 --- a/src/invoker/model/FilingSummary.js +++ b/src/model/FilingSummary.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The FilingSummary model module. - * @module invoker/model/FilingSummary + * @module model/FilingSummary * @version 0.0.1 */ /** * Constructs a new FilingSummary. * The summary of a filing submitted to the SEC by a company - * @alias module:invoker/model/FilingSummary + * @alias module:model/FilingSummary * @class */ var exports = function() { @@ -63,8 +63,8 @@ * Constructs a FilingSummary from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/FilingSummary} obj Optional instance to populate. - * @return {module:invoker/model/FilingSummary} The populated FilingSummary instance. + * @param {module:model/FilingSummary} obj Optional instance to populate. + * @return {module:model/FilingSummary} The populated FilingSummary instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/Fundamental.js b/src/model/Fundamental.js similarity index 91% rename from src/invoker/model/Fundamental.js rename to src/model/Fundamental.js index bdc6e67e..0bd7ed87 100644 --- a/src/invoker/model/Fundamental.js +++ b/src/model/Fundamental.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/CompanySummary'], factory); + define(['ApiClient', 'model/CompanySummary'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('./CompanySummary')); @@ -35,13 +35,13 @@ /** * The Fundamental model module. - * @module invoker/model/Fundamental + * @module model/Fundamental * @version 0.0.1 */ /** * Constructs a new Fundamental. - * @alias module:invoker/model/Fundamental + * @alias module:model/Fundamental * @class */ var exports = function() { @@ -63,8 +63,8 @@ * Constructs a Fundamental from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/Fundamental} obj Optional instance to populate. - * @return {module:invoker/model/Fundamental} The populated Fundamental instance. + * @param {module:model/Fundamental} obj Optional instance to populate. + * @return {module:model/Fundamental} The populated Fundamental instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -111,7 +111,7 @@ exports.prototype['id'] = undefined; /** * The Company that the Fundamental was belongs to - * @member {module:invoker/model/CompanySummary} company + * @member {module:model/CompanySummary} company */ exports.prototype['company'] = undefined; /** @@ -131,7 +131,7 @@ exports.prototype['fiscal_period'] = undefined; /** * The type of Fundamental - * @member {module:invoker/model/Fundamental.TypeEnum} type + * @member {module:model/Fundamental.TypeEnum} type */ exports.prototype['type'] = undefined; /** diff --git a/src/invoker/model/FundamentalSummary.js b/src/model/FundamentalSummary.js similarity index 92% rename from src/invoker/model/FundamentalSummary.js rename to src/model/FundamentalSummary.js index 93df4ac8..3b89d252 100644 --- a/src/invoker/model/FundamentalSummary.js +++ b/src/model/FundamentalSummary.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,13 +35,13 @@ /** * The FundamentalSummary model module. - * @module invoker/model/FundamentalSummary + * @module model/FundamentalSummary * @version 0.0.1 */ /** * Constructs a new FundamentalSummary. - * @alias module:invoker/model/FundamentalSummary + * @alias module:model/FundamentalSummary * @class */ var exports = function() { @@ -62,8 +62,8 @@ * Constructs a FundamentalSummary from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/FundamentalSummary} obj Optional instance to populate. - * @return {module:invoker/model/FundamentalSummary} The populated FundamentalSummary instance. + * @param {module:model/FundamentalSummary} obj Optional instance to populate. + * @return {module:model/FundamentalSummary} The populated FundamentalSummary instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -122,7 +122,7 @@ exports.prototype['fiscal_period'] = undefined; /** * The type of Fundamental - * @member {module:invoker/model/FundamentalSummary.TypeEnum} type + * @member {module:model/FundamentalSummary.TypeEnum} type */ exports.prototype['type'] = undefined; /** diff --git a/src/invoker/model/HistoricalData.js b/src/model/HistoricalData.js similarity index 89% rename from src/invoker/model/HistoricalData.js rename to src/model/HistoricalData.js index f8d2d3c2..ad8b59f4 100644 --- a/src/invoker/model/HistoricalData.js +++ b/src/model/HistoricalData.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The HistoricalData model module. - * @module invoker/model/HistoricalData + * @module model/HistoricalData * @version 0.0.1 */ /** * Constructs a new HistoricalData. * A historcial value for the identifier/item combination a specific date - * @alias module:invoker/model/HistoricalData + * @alias module:model/HistoricalData * @class */ var exports = function() { @@ -56,8 +56,8 @@ * Constructs a HistoricalData from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/HistoricalData} obj Optional instance to populate. - * @return {module:invoker/model/HistoricalData} The populated HistoricalData instance. + * @param {module:model/HistoricalData} obj Optional instance to populate. + * @return {module:model/HistoricalData} The populated HistoricalData instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/ReportedFinancial.js b/src/model/ReportedFinancial.js similarity index 87% rename from src/invoker/model/ReportedFinancial.js rename to src/model/ReportedFinancial.js index debb42db..edabdcae 100644 --- a/src/invoker/model/ReportedFinancial.js +++ b/src/model/ReportedFinancial.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/ReportedTag'], factory); + define(['ApiClient', 'model/ReportedTag'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('./ReportedTag')); @@ -35,14 +35,14 @@ /** * The ReportedFinancial model module. - * @module invoker/model/ReportedFinancial + * @module model/ReportedFinancial * @version 0.0.1 */ /** * Constructs a new ReportedFinancial. * A financial statement as-reported, directly from the financial statements of the XBRL filings from the company. - * @alias module:invoker/model/ReportedFinancial + * @alias module:model/ReportedFinancial * @class */ var exports = function() { @@ -56,8 +56,8 @@ * Constructs a ReportedFinancial from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/ReportedFinancial} obj Optional instance to populate. - * @return {module:invoker/model/ReportedFinancial} The populated ReportedFinancial instance. + * @param {module:model/ReportedFinancial} obj Optional instance to populate. + * @return {module:model/ReportedFinancial} The populated ReportedFinancial instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -74,7 +74,7 @@ } /** - * @member {module:invoker/model/ReportedTag} xbrl_tag + * @member {module:model/ReportedTag} xbrl_tag */ exports.prototype['xbrl_tag'] = undefined; /** diff --git a/src/invoker/model/ReportedTag.js b/src/model/ReportedTag.js similarity index 92% rename from src/invoker/model/ReportedTag.js rename to src/model/ReportedTag.js index b317b107..7c47918b 100644 --- a/src/invoker/model/ReportedTag.js +++ b/src/model/ReportedTag.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The ReportedTag model module. - * @module invoker/model/ReportedTag + * @module model/ReportedTag * @version 0.0.1 */ /** * Constructs a new ReportedTag. * An XBRL tag as-reported by the company on the as-reported financial statement - * @alias module:invoker/model/ReportedTag + * @alias module:model/ReportedTag * @class */ var exports = function() { @@ -61,8 +61,8 @@ * Constructs a ReportedTag from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/ReportedTag} obj Optional instance to populate. - * @return {module:invoker/model/ReportedTag} The populated ReportedTag instance. + * @param {module:model/ReportedTag} obj Optional instance to populate. + * @return {module:model/ReportedTag} The populated ReportedTag instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/SICIndex.js b/src/model/SICIndex.js similarity index 92% rename from src/invoker/model/SICIndex.js rename to src/model/SICIndex.js index 197ff16e..e8ac536f 100644 --- a/src/invoker/model/SICIndex.js +++ b/src/model/SICIndex.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The SICIndex model module. - * @module invoker/model/SICIndex + * @module model/SICIndex * @version 0.0.1 */ /** * Constructs a new SICIndex. * An Index representing a Standard Industrial Classification (SIC) code. - * @alias module:invoker/model/SICIndex + * @alias module:model/SICIndex * @class */ var exports = function() { @@ -59,8 +59,8 @@ * Constructs a SICIndex from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/SICIndex} obj Optional instance to populate. - * @return {module:invoker/model/SICIndex} The populated SICIndex instance. + * @param {module:model/SICIndex} obj Optional instance to populate. + * @return {module:model/SICIndex} The populated SICIndex instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/Security.js b/src/model/Security.js similarity index 97% rename from src/invoker/model/Security.js rename to src/model/Security.js index 94dc94f1..22e7cf32 100644 --- a/src/invoker/model/Security.js +++ b/src/model/Security.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The Security model module. - * @module invoker/model/Security + * @module model/Security * @version 0.0.1 */ /** * Constructs a new Security. * A financial instrument representing shares of ownership in a publicly-traded company - * @alias module:invoker/model/Security + * @alias module:model/Security * @class */ var exports = function() { @@ -82,8 +82,8 @@ * Constructs a Security from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/Security} obj Optional instance to populate. - * @return {module:invoker/model/Security} The populated Security instance. + * @param {module:model/Security} obj Optional instance to populate. + * @return {module:model/Security} The populated Security instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/SecurityScreenClause.js b/src/model/SecurityScreenClause.js similarity index 89% rename from src/invoker/model/SecurityScreenClause.js rename to src/model/SecurityScreenClause.js index 8d5a6170..95b60751 100644 --- a/src/invoker/model/SecurityScreenClause.js +++ b/src/model/SecurityScreenClause.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The SecurityScreenClause model module. - * @module invoker/model/SecurityScreenClause + * @module model/SecurityScreenClause * @version 0.0.1 */ /** * Constructs a new SecurityScreenClause. * A conditional clause used tp screen securities - * @alias module:invoker/model/SecurityScreenClause + * @alias module:model/SecurityScreenClause * @class */ var exports = function() { @@ -57,8 +57,8 @@ * Constructs a SecurityScreenClause from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/SecurityScreenClause} obj Optional instance to populate. - * @return {module:invoker/model/SecurityScreenClause} The populated SecurityScreenClause instance. + * @param {module:model/SecurityScreenClause} obj Optional instance to populate. + * @return {module:model/SecurityScreenClause} The populated SecurityScreenClause instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -84,7 +84,7 @@ exports.prototype['field'] = undefined; /** * The logic operator to use when screening - * @member {module:invoker/model/SecurityScreenClause.OperatorEnum} operator + * @member {module:model/SecurityScreenClause.OperatorEnum} operator */ exports.prototype['operator'] = undefined; /** diff --git a/src/invoker/model/SecurityScreenGroup.js b/src/model/SecurityScreenGroup.js similarity index 85% rename from src/invoker/model/SecurityScreenGroup.js rename to src/model/SecurityScreenGroup.js index 258ade74..c4b8e056 100644 --- a/src/invoker/model/SecurityScreenGroup.js +++ b/src/model/SecurityScreenGroup.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/SecurityScreenClause', 'invoker/model/SecurityScreenGroup'], factory); + define(['ApiClient', 'model/SecurityScreenClause', 'model/SecurityScreenGroup'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('./SecurityScreenClause'), require('./SecurityScreenGroup')); @@ -35,14 +35,14 @@ /** * The SecurityScreenGroup model module. - * @module invoker/model/SecurityScreenGroup + * @module model/SecurityScreenGroup * @version 0.0.1 */ /** * Constructs a new SecurityScreenGroup. * A group of clauses and groups combined with a logic operator, used to screen securities - * @alias module:invoker/model/SecurityScreenGroup + * @alias module:model/SecurityScreenGroup * @class */ var exports = function() { @@ -57,8 +57,8 @@ * Constructs a SecurityScreenGroup from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/SecurityScreenGroup} obj Optional instance to populate. - * @return {module:invoker/model/SecurityScreenGroup} The populated SecurityScreenGroup instance. + * @param {module:model/SecurityScreenGroup} obj Optional instance to populate. + * @return {module:model/SecurityScreenGroup} The populated SecurityScreenGroup instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -84,12 +84,12 @@ exports.prototype['operator'] = undefined; /** * The logic clauses in the group - * @member {Array.} clauses + * @member {Array.} clauses */ exports.prototype['clauses'] = undefined; /** * The nested groups within the group - * @member {Array.} groups + * @member {Array.} groups */ exports.prototype['groups'] = undefined; diff --git a/src/invoker/model/SecurityScreenResult.js b/src/model/SecurityScreenResult.js similarity index 83% rename from src/invoker/model/SecurityScreenResult.js rename to src/model/SecurityScreenResult.js index ca8a5c5d..0d52872d 100644 --- a/src/invoker/model/SecurityScreenResult.js +++ b/src/model/SecurityScreenResult.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/SecurityScreenResultData', 'invoker/model/SecuritySummary'], factory); + define(['ApiClient', 'model/SecurityScreenResultData', 'model/SecuritySummary'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('./SecurityScreenResultData'), require('./SecuritySummary')); @@ -35,14 +35,14 @@ /** * The SecurityScreenResult model module. - * @module invoker/model/SecurityScreenResult + * @module model/SecurityScreenResult * @version 0.0.1 */ /** * Constructs a new SecurityScreenResult. * A security that matches the screen and its corresponding screened properties - * @alias module:invoker/model/SecurityScreenResult + * @alias module:model/SecurityScreenResult * @class */ var exports = function() { @@ -56,8 +56,8 @@ * Constructs a SecurityScreenResult from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/SecurityScreenResult} obj Optional instance to populate. - * @return {module:invoker/model/SecurityScreenResult} The populated SecurityScreenResult instance. + * @param {module:model/SecurityScreenResult} obj Optional instance to populate. + * @return {module:model/SecurityScreenResult} The populated SecurityScreenResult instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -74,11 +74,11 @@ } /** - * @member {module:invoker/model/SecuritySummary} security + * @member {module:model/SecuritySummary} security */ exports.prototype['security'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ exports.prototype['data'] = undefined; diff --git a/src/invoker/model/SecurityScreenResultData.js b/src/model/SecurityScreenResultData.js similarity index 88% rename from src/invoker/model/SecurityScreenResultData.js rename to src/model/SecurityScreenResultData.js index c6f727bd..595658f4 100644 --- a/src/invoker/model/SecurityScreenResultData.js +++ b/src/model/SecurityScreenResultData.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,13 +35,13 @@ /** * The SecurityScreenResultData model module. - * @module invoker/model/SecurityScreenResultData + * @module model/SecurityScreenResultData * @version 0.0.1 */ /** * Constructs a new SecurityScreenResultData. - * @alias module:invoker/model/SecurityScreenResultData + * @alias module:model/SecurityScreenResultData * @class */ var exports = function() { @@ -56,8 +56,8 @@ * Constructs a SecurityScreenResultData from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/SecurityScreenResultData} obj Optional instance to populate. - * @return {module:invoker/model/SecurityScreenResultData} The populated SecurityScreenResultData instance. + * @param {module:model/SecurityScreenResultData} obj Optional instance to populate. + * @return {module:model/SecurityScreenResultData} The populated SecurityScreenResultData instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/SecuritySummary.js b/src/model/SecuritySummary.js similarity index 92% rename from src/invoker/model/SecuritySummary.js rename to src/model/SecuritySummary.js index aa453ee7..26a1ee17 100644 --- a/src/invoker/model/SecuritySummary.js +++ b/src/model/SecuritySummary.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The SecuritySummary model module. - * @module invoker/model/SecuritySummary + * @module model/SecuritySummary * @version 0.0.1 */ /** * Constructs a new SecuritySummary. * The summary of a financial instrument representing shares of ownership in a publicly-traded company - * @alias module:invoker/model/SecuritySummary + * @alias module:model/SecuritySummary * @class */ var exports = function() { @@ -60,8 +60,8 @@ * Constructs a SecuritySummary from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/SecuritySummary} obj Optional instance to populate. - * @return {module:invoker/model/SecuritySummary} The populated SecuritySummary instance. + * @param {module:model/SecuritySummary} obj Optional instance to populate. + * @return {module:model/SecuritySummary} The populated SecuritySummary instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/StandardizedFinancial.js b/src/model/StandardizedFinancial.js similarity index 88% rename from src/invoker/model/StandardizedFinancial.js rename to src/model/StandardizedFinancial.js index 0cbf51f1..ad512a01 100644 --- a/src/invoker/model/StandardizedFinancial.js +++ b/src/model/StandardizedFinancial.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/StandardizedTag'], factory); + define(['ApiClient', 'model/StandardizedTag'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('./StandardizedTag')); @@ -35,14 +35,14 @@ /** * The StandardizedFinancial model module. - * @module invoker/model/StandardizedFinancial + * @module model/StandardizedFinancial * @version 0.0.1 */ /** * Constructs a new StandardizedFinancial. * Professional-grade historical financial data for a Company. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as-reported financial statements because of the inherent complexity of reporting standards. - * @alias module:invoker/model/StandardizedFinancial + * @alias module:model/StandardizedFinancial * @class */ var exports = function() { @@ -56,8 +56,8 @@ * Constructs a StandardizedFinancial from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/StandardizedFinancial} obj Optional instance to populate. - * @return {module:invoker/model/StandardizedFinancial} The populated StandardizedFinancial instance. + * @param {module:model/StandardizedFinancial} obj Optional instance to populate. + * @return {module:model/StandardizedFinancial} The populated StandardizedFinancial instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -74,7 +74,7 @@ } /** - * @member {module:invoker/model/StandardizedTag} data_tag + * @member {module:model/StandardizedTag} data_tag */ exports.prototype['data_tag'] = undefined; /** diff --git a/src/invoker/model/StandardizedTag.js b/src/model/StandardizedTag.js similarity index 92% rename from src/invoker/model/StandardizedTag.js rename to src/model/StandardizedTag.js index 21775866..47844baf 100644 --- a/src/invoker/model/StandardizedTag.js +++ b/src/model/StandardizedTag.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,13 +35,13 @@ /** * The StandardizedTag model module. - * @module invoker/model/StandardizedTag + * @module model/StandardizedTag * @version 0.0.1 */ /** * Constructs a new StandardizedTag. - * @alias module:invoker/model/StandardizedTag + * @alias module:model/StandardizedTag * @class */ var exports = function() { @@ -63,8 +63,8 @@ * Constructs a StandardizedTag from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/StandardizedTag} obj Optional instance to populate. - * @return {module:invoker/model/StandardizedTag} The populated StandardizedTag instance. + * @param {module:model/StandardizedTag} obj Optional instance to populate. + * @return {module:model/StandardizedTag} The populated StandardizedTag instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -126,7 +126,7 @@ exports.prototype['statement_code'] = undefined; /** * The format of the financial statment to which this tag belongs - * @member {module:invoker/model/StandardizedTag.StatementTypeEnum} statement_type + * @member {module:model/StandardizedTag.StatementTypeEnum} statement_type */ exports.prototype['statement_type'] = undefined; /** diff --git a/src/invoker/model/StockExchange.js b/src/model/StockExchange.js similarity index 94% rename from src/invoker/model/StockExchange.js rename to src/model/StockExchange.js index 0bb7842e..c700f9ca 100644 --- a/src/invoker/model/StockExchange.js +++ b/src/model/StockExchange.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The StockExchange model module. - * @module invoker/model/StockExchange + * @module model/StockExchange * @version 0.0.1 */ /** * Constructs a new StockExchange. * An organized and regulated financial market in which securities are bought and sold. - * @alias module:invoker/model/StockExchange + * @alias module:model/StockExchange * @class */ var exports = function() { @@ -64,8 +64,8 @@ * Constructs a StockExchange from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/StockExchange} obj Optional instance to populate. - * @return {module:invoker/model/StockExchange} The populated StockExchange instance. + * @param {module:model/StockExchange} obj Optional instance to populate. + * @return {module:model/StockExchange} The populated StockExchange instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/StockMarketIndex.js b/src/model/StockMarketIndex.js similarity index 93% rename from src/invoker/model/StockMarketIndex.js rename to src/model/StockMarketIndex.js index 6437a8a1..eafa858f 100644 --- a/src/invoker/model/StockMarketIndex.js +++ b/src/model/StockMarketIndex.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,13 +35,13 @@ /** * The StockMarketIndex model module. - * @module invoker/model/StockMarketIndex + * @module model/StockMarketIndex * @version 0.0.1 */ /** * Constructs a new StockMarketIndex. - * @alias module:invoker/model/StockMarketIndex + * @alias module:model/StockMarketIndex * @class */ var exports = function() { @@ -63,8 +63,8 @@ * Constructs a StockMarketIndex from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/StockMarketIndex} obj Optional instance to populate. - * @return {module:invoker/model/StockMarketIndex} The populated StockMarketIndex instance. + * @param {module:model/StockMarketIndex} obj Optional instance to populate. + * @return {module:model/StockMarketIndex} The populated StockMarketIndex instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/StockMarketIndexSummary.js b/src/model/StockMarketIndexSummary.js similarity index 92% rename from src/invoker/model/StockMarketIndexSummary.js rename to src/model/StockMarketIndexSummary.js index 7d129fc0..97af4206 100644 --- a/src/invoker/model/StockMarketIndexSummary.js +++ b/src/model/StockMarketIndexSummary.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,13 +35,13 @@ /** * The StockMarketIndexSummary model module. - * @module invoker/model/StockMarketIndexSummary + * @module model/StockMarketIndexSummary * @version 0.0.1 */ /** * Constructs a new StockMarketIndexSummary. - * @alias module:invoker/model/StockMarketIndexSummary + * @alias module:model/StockMarketIndexSummary * @class */ var exports = function() { @@ -62,8 +62,8 @@ * Constructs a StockMarketIndexSummary from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/StockMarketIndexSummary} obj Optional instance to populate. - * @return {module:invoker/model/StockMarketIndexSummary} The populated StockMarketIndexSummary instance. + * @param {module:model/StockMarketIndexSummary} obj Optional instance to populate. + * @return {module:model/StockMarketIndexSummary} The populated StockMarketIndexSummary instance. */ exports.constructFromObject = function(data, obj) { if (data) { diff --git a/src/invoker/model/StockPrice.js b/src/model/StockPrice.js similarity index 94% rename from src/invoker/model/StockPrice.js rename to src/model/StockPrice.js index 76c6e40a..178bbb5c 100644 --- a/src/invoker/model/StockPrice.js +++ b/src/model/StockPrice.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient', 'invoker/model/SecuritySummary'], factory); + define(['ApiClient', 'model/SecuritySummary'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient'), require('./SecuritySummary')); @@ -35,14 +35,14 @@ /** * The StockPrice model module. - * @module invoker/model/StockPrice + * @module model/StockPrice * @version 0.0.1 */ /** * Constructs a new StockPrice. * The stock price of a security on a given date. - * @alias module:invoker/model/StockPrice + * @alias module:model/StockPrice * @class */ var exports = function() { @@ -70,8 +70,8 @@ * Constructs a StockPrice from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/StockPrice} obj Optional instance to populate. - * @return {module:invoker/model/StockPrice} The populated StockPrice instance. + * @param {module:model/StockPrice} obj Optional instance to populate. + * @return {module:model/StockPrice} The populated StockPrice instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -131,7 +131,7 @@ /** * The Security of the stock price - * @member {module:invoker/model/SecuritySummary} security + * @member {module:model/SecuritySummary} security */ exports.prototype['security'] = undefined; /** @@ -146,7 +146,7 @@ exports.prototype['intraperiod'] = undefined; /** * The type of period that the stock price represents - * @member {module:invoker/model/StockPrice.FrequencyEnum} frequency + * @member {module:model/StockPrice.FrequencyEnum} frequency */ exports.prototype['frequency'] = undefined; /** diff --git a/src/invoker/model/StockPriceSummary.js b/src/model/StockPriceSummary.js similarity index 94% rename from src/invoker/model/StockPriceSummary.js rename to src/model/StockPriceSummary.js index e7de5bcd..26bf7803 100644 --- a/src/invoker/model/StockPriceSummary.js +++ b/src/model/StockPriceSummary.js @@ -16,7 +16,7 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['invoker/ApiClient'], factory); + define(['ApiClient'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. module.exports = factory(require('../ApiClient')); @@ -35,14 +35,14 @@ /** * The StockPriceSummary model module. - * @module invoker/model/StockPriceSummary + * @module model/StockPriceSummary * @version 0.0.1 */ /** * Constructs a new StockPriceSummary. * The summary of a stock price for a security on a given date. - * @alias module:invoker/model/StockPriceSummary + * @alias module:model/StockPriceSummary * @class */ var exports = function() { @@ -69,8 +69,8 @@ * Constructs a StockPriceSummary from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:invoker/model/StockPriceSummary} obj Optional instance to populate. - * @return {module:invoker/model/StockPriceSummary} The populated StockPriceSummary instance. + * @param {module:model/StockPriceSummary} obj Optional instance to populate. + * @return {module:model/StockPriceSummary} The populated StockPriceSummary instance. */ exports.constructFromObject = function(data, obj) { if (data) { @@ -137,7 +137,7 @@ exports.prototype['intraperiod'] = undefined; /** * The type of period that the stock price represents - * @member {module:invoker/model/StockPriceSummary.FrequencyEnum} frequency + * @member {module:model/StockPriceSummary.FrequencyEnum} frequency */ exports.prototype['frequency'] = undefined; /**