@barchart/portfolio-client-js 1.2.45 → 1.3.3

package/README.md

@@ -8,7 +8,6 @@ The code is documented with [JSDoc](http://usejsdoc.org/). While the output hasn
     > npm install
     > gulp document
 
-
 ## Development
 
 Gulp is used to check "linting" and to run unit tests.
@@ -18,7 +17,6 @@ Gulp is used to check "linting" and to run unit tests.
     > gulp lint
     > gulp test
 
-
 ## Build
 
 Polyfills for ES6 are required:

package/example/example.js

@@ -194,37 +194,37 @@ module.exports = function () {
 			}
 
 			_this._readPortfoliosEndpoint = EndpointBuilder.for('read-portfolios', 'read portfolios').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 			}).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPortfolioDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._createPortfolioEndpoint = EndpointBuilder.for('create-portfolio', 'create portfolio').withVerb(VerbType.POST).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios');
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios');
 			}).withBody('portfolio').withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withRequestInterceptor(RequestInterceptor.fromDelegate(createPortfolioRequestInterceptor)).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPortfolioDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._updatePortfolioEndpoint = EndpointBuilder.for('update-portfolio', 'update portfolio').withVerb(VerbType.PUT).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 			}).withBody('portfolio').withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withRequestInterceptor(RequestInterceptor.fromDelegate(updatePortfolioRequestInterceptor)).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPortfolioDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._deletePortfolioEndpoint = EndpointBuilder.for('delete-portfolio', 'delete portfolio').withVerb(VerbType.DELETE).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 			}).withRequestInterceptor(requestInterceptorToUse).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._readPositionsEndpoint = EndpointBuilder.for('read-positions', 'read positions').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('includePreviousPrice', 'includePreviousPrice', 'includePreviousPrice', true);
 			}).withRequestInterceptor(requestInterceptorToUse).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withResponseInterceptor(responseInterceptorForPositionDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._updatePositionEndpoint = EndpointBuilder.for('update-position', 'update position').withVerb(VerbType.PUT).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
 			}).withBody('portfolio').withRequestInterceptor(RequestInterceptor.fromDelegate(updatePositionRequestInterceptor)).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPositionMutateDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._deletePositionEndpoint = EndpointBuilder.for('delete-position', 'delete position').withVerb(VerbType.DELETE).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
 			}).withBody('transaction').withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPositionMutateDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._readPositionSummariesEndpoint = EndpointBuilder.for('read-position-summaries', 'read position summaries').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('summaries', 'summaries').withVariableParameter('position', 'position', 'position', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('summaries', 'summaries').withVariableParameter('position', 'position', 'position', false);
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('frames', 'frames', 'frames', true, function (frames) {
 					return frames.map(function (f) {
@@ -236,13 +236,13 @@ module.exports = function () {
 			}).withRequestInterceptor(requestInterceptorToUse).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withResponseInterceptor(responseInterceptorForPositionSummaryDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._readTransactionsEndpoint = EndpointBuilder.for('read-transactions', 'read transactions').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions');
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions');
 			}).withQueryBuilder(function (qb) {
 				qb.withLiteralParameter('mode', 'mode', 'text');
 			}).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForTransactionDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._createTransactionEndpoint = EndpointBuilder.for('create-transaction', 'create transaction').withVerb(VerbType.POST).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions');
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions');
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('type', 'type', 'type', false, function (x) {
 					return x.code;
@@ -250,11 +250,11 @@ module.exports = function () {
 			}).withBody('transaction').withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPositionMutateDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._batchTransactionEndpoint = EndpointBuilder.for('batch-transactions', 'batch transactions').withVerb(VerbType.POST).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withLiteralParameter('multiple', 'multiple').withLiteralParameter('transactions', 'transactions');
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withLiteralParameter('multiple', 'multiple').withLiteralParameter('transactions', 'transactions');
 			}).withBody('transactions').withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(ResponseInterceptor.DATA).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._editTransactionEndpoint = EndpointBuilder.for('edit-transaction', 'edit transaction').withVerb(VerbType.POST).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions').withVariableParameter('sequence', 'sequence', 'sequence', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions').withVariableParameter('sequence', 'sequence', 'sequence', false);
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('type', 'type', 'type', false, function (x) {
 					return x.code;
@@ -262,7 +262,7 @@ module.exports = function () {
 			}).withBody('transaction').withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPositionMutateDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._deleteTransactionEndpoint = EndpointBuilder.for('delete-transaction', 'delete transaction').withVerb(VerbType.DELETE).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions').withVariableParameter('sequence', 'sequence', 'sequence', false);
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false).withLiteralParameter('transactions', 'transactions').withVariableParameter('sequence', 'sequence', 'sequence', false);
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('force', 'force', 'force', false).withVariableParameter('echoStart', 'echoStart', 'echoStart', true, function (x) {
 					return x.format();
@@ -272,7 +272,7 @@ module.exports = function () {
 			}).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPositionMutateDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._readTransactionsReportEndpoint = EndpointBuilder.for('read-transaction-report', 'read transaction report').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', true).withLiteralParameter('transactions', 'transactions').withLiteralParameter('formatted', 'formatted');
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', true).withLiteralParameter('transactions', 'transactions').withLiteralParameter('formatted', 'formatted');
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('start', 'start', 'start', true, function (x) {
 					return x.format();
@@ -282,7 +282,7 @@ module.exports = function () {
 			}).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(ResponseInterceptor.DATA).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
 			_this._readBrokerageReportAvailabilityEndpoint = EndpointBuilder.for('read-brokerage-report-availability', 'read brokerage report availability').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('reports', 'reports').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('availability', 'availability');
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('reports', 'reports').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('availability', 'availability');
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('frames', 'frames', 'frames', true, function (frames) {
 					return frames.map(function (f) {
@@ -290,14 +290,6 @@ module.exports = function () {
 					}).join();
 				});
 			}).withRequestInterceptor(requestInterceptorToUse).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withResponseInterceptor(responseInterceptorForBrokerageReportAvailabilityDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
-
-			_this._downloadBrokerageReportEndpoint = EndpointBuilder.for('download-brokerage-report', 'download brokerage report').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
-				pb.withLiteralParameter('reports', 'reports').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('frames', 'frames').withVariableParameter('frame', 'frame', 'frame', false, function (x) {
-					return x.code;
-				}).withLiteralParameter('date', 'date').withVariableParameter('start', 'start', 'start', false, function (x) {
-					return x.format();
-				});
-			}).withRequestInterceptor(requestInterceptorToUse).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 			return _this;
 		}
 
@@ -318,7 +310,7 @@ module.exports = function () {
     * containing the current instance.
     *
     * @public
-    * @returns {Promise.<PortfolioGateway>}
+    * @returns {Promise<PortfolioGateway>}
     */
 			value: function start() {
 				var _this2 = this;
@@ -345,7 +337,7 @@ module.exports = function () {
     *
     * @public
     * @param {String=} portfolio
-    * @returns {Promise.<Portfolio[]>}
+    * @returns {Promise<Portfolio[]>}
     */
 
 		}, {
@@ -367,7 +359,7 @@ module.exports = function () {
     *
     * @public
     * @param {Object} portfolio
-    * @returns {Promise.<Portfolio>}
+    * @returns {Promise<Portfolio>}
     */
 
 		}, {
@@ -389,7 +381,7 @@ module.exports = function () {
     *
     * @public
     * @param {Object} portfolio
-    * @returns {Promise.<Portfolio>}
+    * @returns {Promise<Portfolio>}
     */
 
 		}, {
@@ -411,7 +403,7 @@ module.exports = function () {
     *
     * @public
     * @param {Object} portfolio
-    * @returns {Promise.<Portfolio>}
+    * @returns {Promise<Portfolio>}
     */
 
 		}, {
@@ -433,7 +425,7 @@ module.exports = function () {
     *
     * @public
     * @param {String} portfolio - ID of the portfolio to update
-    * @returns {Promise.<Portfolio>}
+    * @returns {Promise<Portfolio>}
     */
 
 		}, {
@@ -457,7 +449,7 @@ module.exports = function () {
     * @param {String=} portfolio
     * @param {String=} position
     * @param {Boolean=} includePreviousPrice
-    * @returns {Promise.<Position[]>}
+    * @returns {Promise<Position[]>}
     */
 
 		}, {
@@ -481,7 +473,7 @@ module.exports = function () {
     *
     * @public
     * @param {Object} position
-    * @returns {Promise.<Position>}
+    * @returns {Promise<Position>}
     */
 
 		}, {
@@ -549,10 +541,10 @@ module.exports = function () {
     * @public
     * @param {String=} portfolio
     * @param {String=} position
-    * @param {Array.<PositionSummaryFrame>=|Array.<String>=} frames
+    * @param {Array<PositionSummaryFrame>=|Array<String>=} frames
     * @param {Number=} periods
     * @param {Day=|String=} start
-    * @returns {Promise.<Position[]>}
+    * @returns {Promise<Position[]>}
     */
 
 		}, {
@@ -624,7 +616,7 @@ module.exports = function () {
     * @public
     * @param {String} portfolio
     * @param {String} position
-    * @returns {Promise.<Position[]>}
+    * @returns {Promise<Position[]>}
     */
 
 		}, {
@@ -647,7 +639,7 @@ module.exports = function () {
     *
     * @public
     * @param {Object} transaction
-    * @returns {Promise.<TransactionMutateResult>}
+    * @returns {Promise<TransactionMutateResult>}
     */
 
 		}, {
@@ -720,7 +712,7 @@ module.exports = function () {
     *
     * @public
     * @param {Object} transaction
-    * @returns {Promise.<TransactionMutateResult>}
+    * @returns {Promise<TransactionMutateResult>}
     */
 
 		}, {
@@ -752,7 +744,7 @@ module.exports = function () {
     * @param {Boolean=} force
     * @param {Day=} echoStart
     * @param {Day=} echoEnd
-    * @returns {Promise.<TransactionMutateResult>}
+    * @returns {Promise<TransactionMutateResult>}
     */
 
 		}, {
@@ -795,7 +787,7 @@ module.exports = function () {
     * @public
     * @param {String} portfolio
     * @param {String=} position
-    * @returns {Promise.<Transaction[]>}
+    * @returns {Promise<Transaction[]>}
     */
 
 		}, {
@@ -823,7 +815,7 @@ module.exports = function () {
     * @param {Day=} startDay
     * @param {Day=} endDay
     * @oaram {Boolean=} descending
-    * @returns {Promise.<Object[]>}
+    * @returns {Promise<Object[]>}
     */
 
 		}, {
@@ -928,18 +920,9 @@ module.exports = function () {
 					return Gateway.invoke(_this20._readBrokerageReportAvailabilityEndpoint, payload);
 				});
 			}
-
-			/**
-    * @public
-    * @param {String=} portfolio
-    * @param {PositionSummaryFrame} frame
-    * @param {Day} end
-    * @returns {Promise}
-    */
-
 		}, {
-			key: 'downloadBrokerageReport',
-			value: function downloadBrokerageReport(portfolio, frame, end) {
+			key: 'getBrokerageReportUrl',
+			value: function getBrokerageReportUrl(portfolio, frame, start) {
 				var _this21 = this;
 
 				return Promise.resolve().then(function () {
@@ -947,15 +930,9 @@ module.exports = function () {
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsRequired(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
-					assert.argumentIsRequired(end, 'end', Day, 'Day');
-
-					var payload = {};
-
-					payload.portfolio = portfolio;
-					payload.frame = frame;
-					payload.start = end;
+					assert.argumentIsRequired(start, 'start', Day, 'Day');
 
-					return Gateway.invoke(_this21._downloadBrokerageReportEndpoint, payload);
+					return 'https://portfolio-dev.aws.barchart.com/binary/reports/portfolios/9555fb81-f640-4a95-8766-aa59f38d2abd/frames/MONTHLY/date/2017-06-30';
 				});
 			}
 
@@ -964,8 +941,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-    * @returns {Promise.<PortfolioGateway>}
+    * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+    * @returns {Promise<PortfolioGateway>}
     */
 
 		}, {
@@ -998,8 +975,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-    * @returns {Promise.<PortfolioGateway>}
+    * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+    * @returns {Promise<PortfolioGateway>}
     */
 
 		}, {
@@ -1017,8 +994,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-    * @returns {Promise.<PortfolioGateway>}
+    * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+    * @returns {Promise<PortfolioGateway>}
     */
 
 		}, {
@@ -1036,8 +1013,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-    * @returns {Promise.<PortfolioGateway>}
+    * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+    * @returns {Promise<PortfolioGateway>}
     */
 
 		}, {
@@ -1195,8 +1172,8 @@ module.exports = function () {
   *
   * @typedef TransactionMutateResult
   * @type {Object}
-  * @property {Array.<Object>} positions - All positions updated as a consequence of processing the transaction.
-  * @property {Array.<Object>} summaries - All position summaries updated as a consequence of processing the transaction.
+  * @property {Object[]} positions - All positions updated as a consequence of processing the transaction.
+  * @property {Object[]} summaries - All position summaries updated as a consequence of processing the transaction.
   * @property {Boolean} replaced - If true, the position (and position summaries) need to be replaced.
   */
 
@@ -1267,7 +1244,7 @@ module.exports = function () {
    * containing the current instance
    *
    * @public
-   * @returns {Promise.<JwtGateway>}
+   * @returns {Promise<JwtGateway>}
    */
 
 
@@ -1297,7 +1274,7 @@ module.exports = function () {
     * Retrieves a JWT token from the remote server.
     *
     * @public
-    * @returns {Promise.<String>}
+    * @returns {Promise<String>}
     */
 
 		}, {
@@ -1336,7 +1313,7 @@ module.exports = function () {
 				var refreshToken = function refreshToken() {
 					var refreshPromise = scheduler.backoff(function () {
 						return _this4.readToken();
-					}, 100, 'Read JWT token', 3).then(function (token) {
+					}, 0, 'Read JWT token', 3).then(function (token) {
 						if (_this4._refreshInterval) {
 							cachePromise = refreshPromise;
 						}
@@ -1393,7 +1370,7 @@ module.exports = function () {
     * @static
     * @param {String} userId - The identifier of the user to impersonate.
     * @param {String} userLegacyId - The legacy identifier of the user to impersonate.
-    * @returns {Promise.<JwtGateway>}
+    * @returns {Promise<JwtGateway>}
     */
 
 		}, {
@@ -1418,7 +1395,7 @@ module.exports = function () {
     * @public
     * @static
     * @param {String} userId - The identifier of the user to impersonate.
-    * @returns {Promise.<RequestInterceptor>}
+    * @returns {Promise<RequestInterceptor>}
     */
 
 		}, {
@@ -1434,8 +1411,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-    * @returns {Promise.<JwtGateway>}
+    * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+    * @returns {Promise<JwtGateway>}
     */
 
 		}, {
@@ -1451,8 +1428,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-    * @returns {Promise.<RequestInterceptor>}
+    * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+    * @returns {Promise<RequestInterceptor>}
     */
 
 		}, {
@@ -1468,8 +1445,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-    * @returns {Promise.<JwtGateway>}
+    * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+    * @returns {Promise<JwtGateway>}
     */
 
 		}, {
@@ -1485,8 +1462,8 @@ module.exports = function () {
     *
     * @public
     * @static
-    * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-    * @returns {Promise.<RequestInterceptor>}
+    * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+    * @returns {Promise<RequestInterceptor>}
     */
 
 		}, {
@@ -1504,7 +1481,7 @@ module.exports = function () {
     * @static
     * @param {String} userId - The identifier of the user to impersonate.
     * @param {String} userLegacyId - The legacy identifier of the user to impersonate.
-    * @returns {Promise.<JwtGateway>}
+    * @returns {Promise<JwtGateway>}
     */
 
 		}, {
@@ -1519,7 +1496,7 @@ module.exports = function () {
     * @public
     * @static
     * @param {String} userId - The identifier of the user to impersonate.
-    * @returns {Promise.<RequestInterceptor>}
+    * @returns {Promise<RequestInterceptor>}
     */
 
 		}, {
@@ -1552,7 +1529,7 @@ module.exports = function () {
 
 	function _forDevelopment(userId, legacyUserId) {
 		return EndpointBuilder.for('read-jwt-token-for-development', 'lookup user identity').withVerb(VerbType.GET).withProtocol(ProtocolType.HTTPS).withHost(Configuration.developmentHost).withPathBuilder(function (pb) {
-			pb.withLiteralParameter('token', 'token').withLiteralParameter('barchart', 'barchart').withLiteralParameter('generator', 'generator');
+			pb.withLiteralParameter('json', 'json').withLiteralParameter('token', 'token').withLiteralParameter('barchart', 'barchart').withLiteralParameter('generator', 'generator');
 		}).withQueryBuilder(function (qb) {
 			qb.withLiteralParameter('user', 'userId', userId).withLiteralParameter('legacy user', 'userLegacyId', legacyUserId).withLiteralParameter('user context', 'userContext', 'TGAM').withLiteralParameter('user permission level', 'userPermissions', 'registered');
 		}).withResponseInterceptor(ResponseInterceptor.DATA).endpoint;
@@ -1560,19 +1537,19 @@ module.exports = function () {
 
 	function _forStaging(externalRequestInterceptor) {
 		return EndpointBuilder.for('translate-jwt-token-for-staging', 'lookup Barchart user identity').withVerb(VerbType.GET).withProtocol(ProtocolType.HTTPS).withHost(Configuration.stagingHost).withPathBuilder(function (pb) {
-			return pb.withLiteralParameter('token', 'token').withLiteralParameter('system', 'tgam').withLiteralParameter('converter', 'converter');
+			pb.withLiteralParameter('json', 'json').withLiteralParameter('token', 'token').withLiteralParameter('system', 'tgam').withLiteralParameter('converter', 'converter');
 		}).withRequestInterceptor(externalRequestInterceptor).withResponseInterceptor(ResponseInterceptor.DATA).endpoint;
 	}
 
 	function _forProduction(externalRequestInterceptor) {
 		return EndpointBuilder.for('translate-jwt-token-for-production', 'lookup Barchart user identity').withVerb(VerbType.GET).withProtocol(ProtocolType.HTTPS).withHost(Configuration.productionHost).withPathBuilder(function (pb) {
-			return pb.withLiteralParameter('token', 'token').withLiteralParameter('system', 'tgam').withLiteralParameter('converter', 'converter');
+			pb.withLiteralParameter('json', 'json').withLiteralParameter('token', 'token').withLiteralParameter('system', 'tgam').withLiteralParameter('converter', 'converter');
 		}).withRequestInterceptor(externalRequestInterceptor).withResponseInterceptor(ResponseInterceptor.DATA).endpoint;
 	}
 
 	function _forAdmin(userId, legacyUserId) {
 		return EndpointBuilder.for('read-jwt-token-for-admin', 'lookup user identity').withVerb(VerbType.GET).withProtocol(ProtocolType.HTTPS).withHost(Configuration.adminHost).withPathBuilder(function (pb) {
-			pb.withLiteralParameter('token', 'token').withLiteralParameter('barchart', 'barchart').withLiteralParameter('generator', 'generator');
+			pb.withLiteralParameter('json', 'json').withLiteralParameter('token', 'token').withLiteralParameter('barchart', 'barchart').withLiteralParameter('generator', 'generator');
 		}).withQueryBuilder(function (qb) {
 			if (userId) {
 				qb.withLiteralParameter('user', 'userId', userId);
@@ -1601,7 +1578,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.45'
+		version: '1.3.3'
 	};
 }();
 

package/lib/gateway/PortfolioGateway.js

@@ -65,7 +65,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
@@ -80,7 +81,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios');
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios');
 				})
 				.withBody('portfolio')
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
@@ -96,7 +98,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
 				.withBody('portfolio')
@@ -113,7 +116,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
 				.withRequestInterceptor(requestInterceptorToUse)
@@ -126,7 +130,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false);
@@ -146,7 +151,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false);
@@ -164,7 +170,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false);
@@ -181,7 +188,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('summaries', 'summaries')
 						.withVariableParameter('position', 'position', 'position',  false);
@@ -203,7 +211,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -224,7 +233,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -245,7 +255,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withLiteralParameter('multiple', 'multiple')
@@ -263,7 +274,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -285,7 +297,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', false)
@@ -308,7 +321,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
 						.withVariableParameter('position', 'position', 'position', true)
@@ -334,7 +348,8 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('reports', 'reports')
+					pb.withLiteralParameter('json', 'json')
+						.withLiteralParameter('reports', 'reports')
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('availability', 'availability');
@@ -347,24 +362,6 @@ module.exports = (() => {
 				.withResponseInterceptor(responseInterceptorForBrokerageReportAvailabilityDeserialization)
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
-
-			this._downloadBrokerageReportEndpoint = EndpointBuilder.for('download-brokerage-report', 'download brokerage report')
-				.withVerb(VerbType.GET)
-				.withProtocol(protocolType)
-				.withHost(host)
-				.withPort(port)
-				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('reports', 'reports')
-						.withLiteralParameter('portfolios', 'portfolios')
-						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
-						.withLiteralParameter('frames', 'frames')
-						.withVariableParameter('frame', 'frame', 'frame', false, x => x.code)
-						.withLiteralParameter('date', 'date')
-						.withVariableParameter('start', 'start', 'start', false, x => x.format());
-				})
-				.withRequestInterceptor(requestInterceptorToUse)
-				.withErrorInterceptor(ErrorInterceptor.GENERAL)
-				.endpoint;
 		}
 
 		/**
@@ -382,7 +379,7 @@ module.exports = (() => {
 		 * containing the current instance.
 		 *
 		 * @public
-		 * @returns {Promise.<PortfolioGateway>}
+		 * @returns {Promise<PortfolioGateway>}
 		 */
 		start() {
 			return Promise.resolve()
@@ -409,7 +406,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String=} portfolio
-		 * @returns {Promise.<Portfolio[]>}
+		 * @returns {Promise<Portfolio[]>}
 		 */
 		readPortfolios(portfolio) {
 			return Promise.resolve()
@@ -427,7 +424,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} portfolio
-		 * @returns {Promise.<Portfolio>}
+		 * @returns {Promise<Portfolio>}
 		 */
 		createPortfolio(portfolio) {
 			return Promise.resolve()
@@ -445,7 +442,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} portfolio
-		 * @returns {Promise.<Portfolio>}
+		 * @returns {Promise<Portfolio>}
 		 */
 		importPortfolio(portfolio, transactions) {
 			return Promise.resolve()
@@ -464,7 +461,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} portfolio
-		 * @returns {Promise.<Portfolio>}
+		 * @returns {Promise<Portfolio>}
 		 */
 		updatePortfolio(portfolio) {
 			return Promise.resolve()
@@ -482,7 +479,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {String} portfolio - ID of the portfolio to update
-		 * @returns {Promise.<Portfolio>}
+		 * @returns {Promise<Portfolio>}
 		 */
 		deletePortfolio(portfolio) {
 			return Promise.resolve()
@@ -502,7 +499,7 @@ module.exports = (() => {
 		 * @param {String=} portfolio
 		 * @param {String=} position
 		 * @param {Boolean=} includePreviousPrice
-		 * @returns {Promise.<Position[]>}
+		 * @returns {Promise<Position[]>}
 		 */
 		readPositions(portfolio, position, includePreviousPrice) {
 			return Promise.resolve()
@@ -522,7 +519,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} position
-		 * @returns {Promise.<Position>}
+		 * @returns {Promise<Position>}
 		 */
 		updatePosition(position) {
 			return Promise.resolve()
@@ -580,10 +577,10 @@ module.exports = (() => {
 		 * @public
 		 * @param {String=} portfolio
 		 * @param {String=} position
-		 * @param {Array.<PositionSummaryFrame>=|Array.<String>=} frames
+		 * @param {Array<PositionSummaryFrame>=|Array<String>=} frames
 		 * @param {Number=} periods
 		 * @param {Day=|String=} start
-		 * @returns {Promise.<Position[]>}
+		 * @returns {Promise<Position[]>}
 		 */
 		readPositionSummaries(portfolio, position, frames, periods, start) {
 			return Promise.resolve()
@@ -651,7 +648,7 @@ module.exports = (() => {
 		 * @public
 		 * @param {String} portfolio
 		 * @param {String} position
-		 * @returns {Promise.<Position[]>}
+		 * @returns {Promise<Position[]>}
 		 */
 		deletePosition(portfolio, position) {
 			return Promise.resolve()
@@ -670,7 +667,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} transaction
-		 * @returns {Promise.<TransactionMutateResult>}
+		 * @returns {Promise<TransactionMutateResult>}
 		 */
 		createTransaction(transaction) {
 			return Promise.resolve()
@@ -735,7 +732,7 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @param {Object} transaction
-		 * @returns {Promise.<TransactionMutateResult>}
+		 * @returns {Promise<TransactionMutateResult>}
 		 */
 		editTransaction(transaction) {
 			return Promise.resolve()
@@ -763,7 +760,7 @@ module.exports = (() => {
 		 * @param {Boolean=} force
 		 * @param {Day=} echoStart
 		 * @param {Day=} echoEnd
-		 * @returns {Promise.<TransactionMutateResult>}
+		 * @returns {Promise<TransactionMutateResult>}
 		 */
 		deleteTransaction(portfolio, position, sequence, force, echoStart, echoEnd) {
 			return Promise.resolve()
@@ -802,7 +799,7 @@ module.exports = (() => {
 		 * @public
 		 * @param {String} portfolio
 		 * @param {String=} position
-		 * @returns {Promise.<Transaction[]>}
+		 * @returns {Promise<Transaction[]>}
 		 */
 		readTransactions(portfolio, position) {
 			return Promise.resolve()
@@ -826,7 +823,7 @@ module.exports = (() => {
 		 * @param {Day=} startDay
 		 * @param {Day=} endDay
 		 * @oaram {Boolean=} descending
-		 * @returns {Promise.<Object[]>}
+		 * @returns {Promise<Object[]>}
 		 */
 		readTransactionsFormatted(portfolio, position, startDay, endDay, descending) {
 			return Promise.resolve()
@@ -909,40 +906,27 @@ module.exports = (() => {
 		 */
 		readBrokerageReportAvailability(portfolio) {
 			return Promise.resolve()
-			.then(() => {
-				assert.argumentIsRequired(portfolio, 'portfolio', String);
+				.then(() => {
+					assert.argumentIsRequired(portfolio, 'portfolio', String);
 
-				const payload = { };
+					const payload = { };
 
-				payload.portfolio = portfolio;
+					payload.portfolio = portfolio;
 
-				return Gateway.invoke(this._readBrokerageReportAvailabilityEndpoint, payload);
-			});
+					return Gateway.invoke(this._readBrokerageReportAvailabilityEndpoint, payload);
+				});
 		}
 
-		/**
-		 * @public
-		 * @param {String=} portfolio
-		 * @param {PositionSummaryFrame} frame
-		 * @param {Day} end
-		 * @returns {Promise}
-		 */
-		downloadBrokerageReport(portfolio, frame, end) {
+		getBrokerageReportUrl(portfolio, frame, start) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
-	
+
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsRequired(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
-					assert.argumentIsRequired(end, 'end', Day, 'Day');
-	
-					const payload = { };
-	
-					payload.portfolio = portfolio;
-					payload.frame = frame;
-					payload.start = end;
-					
-					return Gateway.invoke(this._downloadBrokerageReportEndpoint, payload);
+					assert.argumentIsRequired(start, 'start', Day, 'Day');
+
+					return 'https://portfolio-dev.aws.barchart.com/binary/reports/portfolios/9555fb81-f640-4a95-8766-aa59f38d2abd/frames/MONTHLY/date/2017-06-30';
 				});
 		}
 
@@ -951,8 +935,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-		 * @returns {Promise.<PortfolioGateway>}
+		 * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+		 * @returns {Promise<PortfolioGateway>}
 		 */
 		static forDevelopment(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
@@ -968,8 +952,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-		 * @returns {Promise.<PortfolioGateway>}
+		 * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+		 * @returns {Promise<PortfolioGateway>}
 		 */
 		static forStaging(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
@@ -985,8 +969,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-		 * @returns {Promise.<PortfolioGateway>}
+		 * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+		 * @returns {Promise<PortfolioGateway>}
 		 */
 		static forProduction(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
@@ -1002,8 +986,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {RequestInterceptor=|Promise.<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
-		 * @returns {Promise.<PortfolioGateway>}
+		 * @param {RequestInterceptor=|Promise<RequestInterceptor>=} requestInterceptor - A request interceptor used with each request (typically used to inject JWT tokens).
+		 * @returns {Promise<PortfolioGateway>}
 		 */
 		static forAdmin(requestInterceptor) {
 			return Promise.resolve(requestInterceptor)
@@ -1162,8 +1146,8 @@ module.exports = (() => {
 	 *
 	 * @typedef TransactionMutateResult
 	 * @type {Object}
-	 * @property {Array.<Object>} positions - All positions updated as a consequence of processing the transaction.
-	 * @property {Array.<Object>} summaries - All position summaries updated as a consequence of processing the transaction.
+	 * @property {Object[]} positions - All positions updated as a consequence of processing the transaction.
+	 * @property {Object[]} summaries - All position summaries updated as a consequence of processing the transaction.
 	 * @property {Boolean} replaced - If true, the position (and position summaries) need to be replaced.
 	 */
 

package/lib/gateway/jwt/JwtGateway.js

@@ -45,7 +45,7 @@ module.exports = (() => {
 		 * containing the current instance
 		 *
 		 * @public
-		 * @returns {Promise.<JwtGateway>}
+		 * @returns {Promise<JwtGateway>}
 		 */
 		start() {
 			return Promise.resolve()
@@ -71,7 +71,7 @@ module.exports = (() => {
 		 * Retrieves a JWT token from the remote server.
 		 *
 		 * @public
-		 * @returns {Promise.<String>}
+		 * @returns {Promise<String>}
 		 */
 		readToken() {
 			return Promise.resolve()
@@ -101,7 +101,7 @@ module.exports = (() => {
 			let cacheDisposable = null;
 
 			const refreshToken = () => {
-				const refreshPromise = scheduler.backoff(() => this.readToken(), 100, 'Read JWT token', 3)
+				const refreshPromise = scheduler.backoff(() => this.readToken(), 0, 'Read JWT token', 3)
 					.then((token) => {
 						if (this._refreshInterval) {
 							cachePromise = refreshPromise;
@@ -159,7 +159,7 @@ module.exports = (() => {
 		 * @static
 		 * @param {String} userId - The identifier of the user to impersonate.
 		 * @param {String} userLegacyId - The legacy identifier of the user to impersonate.
-		 * @returns {Promise.<JwtGateway>}
+		 * @returns {Promise<JwtGateway>}
 		 */
 		static forDevelopment(userId, userLegacyId) {
 			return start(new JwtGateway(forDevelopment(userId, userLegacyId), 180000));
@@ -171,7 +171,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {String} userId - The identifier of the user to impersonate.
-		 * @returns {Promise.<RequestInterceptor>}
+		 * @returns {Promise<RequestInterceptor>}
 		 */
 		static forDevelopmentClient(userId, userLegacyId) {
 			return JwtGateway.forDevelopment(userId, userLegacyId)
@@ -185,8 +185,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-		 * @returns {Promise.<JwtGateway>}
+		 * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+		 * @returns {Promise<JwtGateway>}
 		 */
 		static forStaging(externalRequestInterceptorPromise) {
 			return externalRequestInterceptorPromise.then((externalRequestInterceptor) => {
@@ -199,8 +199,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-		 * @returns {Promise.<RequestInterceptor>}
+		 * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+		 * @returns {Promise<RequestInterceptor>}
 		 */
 		static forStagingClient(externalRequestInterceptorPromise) {
 			return JwtGateway.forStaging(externalRequestInterceptorPromise)
@@ -214,8 +214,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-		 * @returns {Promise.<JwtGateway>}
+		 * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+		 * @returns {Promise<JwtGateway>}
 		 */
 		static forProduction(externalRequestInterceptorPromise) {
 			return externalRequestInterceptorPromise.then((externalRequestInterceptor) => {
@@ -228,8 +228,8 @@ module.exports = (() => {
 		 *
 		 * @public
 		 * @static
-		 * @param {Promise.<RequestInterceptor>} externalRequestInterceptorPromise
-		 * @returns {Promise.<RequestInterceptor>}
+		 * @param {Promise<RequestInterceptor>} externalRequestInterceptorPromise
+		 * @returns {Promise<RequestInterceptor>}
 		 */
 		static forProductionClient(externalRequestInterceptorPromise) {
 			return JwtGateway.forProduction(externalRequestInterceptorPromise)
@@ -245,7 +245,7 @@ module.exports = (() => {
 		 * @static
 		 * @param {String} userId - The identifier of the user to impersonate.
 		 * @param {String} userLegacyId - The legacy identifier of the user to impersonate.
-		 * @returns {Promise.<JwtGateway>}
+		 * @returns {Promise<JwtGateway>}
 		 */
 		static forAdmin(userId, userLegacyId) {
 			return start(new JwtGateway(forAdmin(userId, userLegacyId), 180000));
@@ -257,7 +257,7 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {String} userId - The identifier of the user to impersonate.
-		 * @returns {Promise.<RequestInterceptor>}
+		 * @returns {Promise<RequestInterceptor>}
 		 */
 		static forAdminClient(userId, userLegacyId) {
 			return JwtGateway.forAdmin(userId, userLegacyId)
@@ -298,7 +298,8 @@ module.exports = (() => {
 			.withProtocol(ProtocolType.HTTPS)
 			.withHost(Configuration.developmentHost)
 			.withPathBuilder((pb) => {
-				pb.withLiteralParameter('token', 'token')
+				pb.withLiteralParameter('json', 'json')
+					.withLiteralParameter('token', 'token')
 					.withLiteralParameter('barchart', 'barchart')
 					.withLiteralParameter('generator', 'generator');
 			})
@@ -317,7 +318,12 @@ module.exports = (() => {
 			.withVerb(VerbType.GET)
 			.withProtocol(ProtocolType.HTTPS)
 			.withHost(Configuration.stagingHost)
-			.withPathBuilder((pb) => pb.withLiteralParameter('token', 'token').withLiteralParameter('system', 'tgam').withLiteralParameter('converter', 'converter'))
+			.withPathBuilder((pb) => {
+				pb.withLiteralParameter('json', 'json')
+					.withLiteralParameter('token', 'token')
+					.withLiteralParameter('system', 'tgam')
+					.withLiteralParameter('converter', 'converter');
+			})
 			.withRequestInterceptor(externalRequestInterceptor)
 			.withResponseInterceptor(ResponseInterceptor.DATA)
 			.endpoint;
@@ -328,7 +334,12 @@ module.exports = (() => {
 			.withVerb(VerbType.GET)
 			.withProtocol(ProtocolType.HTTPS)
 			.withHost(Configuration.productionHost)
-			.withPathBuilder((pb) => pb.withLiteralParameter('token', 'token').withLiteralParameter('system', 'tgam').withLiteralParameter('converter', 'converter'))
+			.withPathBuilder((pb) => {
+				pb.withLiteralParameter('json', 'json')
+					.withLiteralParameter('token', 'token')
+					.withLiteralParameter('system', 'tgam')
+					.withLiteralParameter('converter', 'converter');
+			})
 			.withRequestInterceptor(externalRequestInterceptor)
 			.withResponseInterceptor(ResponseInterceptor.DATA)
 			.endpoint;
@@ -340,7 +351,8 @@ module.exports = (() => {
 			.withProtocol(ProtocolType.HTTPS)
 			.withHost(Configuration.adminHost)
 			.withPathBuilder((pb) => {
-				pb.withLiteralParameter('token', 'token')
+				pb.withLiteralParameter('json', 'json')
+					.withLiteralParameter('token', 'token')
 					.withLiteralParameter('barchart', 'barchart')
 					.withLiteralParameter('generator', 'generator');
 			})

package/lib/index.js

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.45'
+		version: '1.3.3'
 	};
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "1.2.45",
+  "version": "1.3.3",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/barchart/barchart/watchlist-client-js.git"
+    "url": "git+ssh://git@github.com/barchart/barchart/portfolio-client-js.git"
   },
   "keywords": [
     "Barchart",
@@ -21,9 +21,9 @@
     "API"
   ],
   "dependencies": {
-    "@barchart/common-js": "~3.2.0",
-    "@barchart/tgam-jwt-js": "~1.0.0",
-    "@barchart/portfolio-api-common": "~1.2.0"
+    "@barchart/common-js": "~3.3.0",
+    "@barchart/tgam-jwt-js": "~1.3.0",
+    "@barchart/portfolio-api-common": "~1.3.0"
   },
   "devDependencies": {
     "babel-core": "^6.26.0",