@barchart/portfolio-client-js 1.3.3 → 1.3.4

package/example/example.js

@@ -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('json', 'json').withLiteralParameter('reports', 'reports').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('availability', 'availability');
+				pb.withLiteralParameter('json', 'json').withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('reports', 'reports').withLiteralParameter('brokerage', 'brokerage').withLiteralParameter('availability', 'availability');
 			}).withQueryBuilder(function (qb) {
 				qb.withVariableParameter('frames', 'frames', 'frames', true, function (frames) {
 					return frames.map(function (f) {
@@ -290,6 +290,10 @@ module.exports = function () {
 					}).join();
 				});
 			}).withRequestInterceptor(requestInterceptorToUse).withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE).withResponseInterceptor(responseInterceptorForBrokerageReportAvailabilityDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
+
+			_this._brokerageReportUrlGenerator = function (portfolio, frame, end) {
+				return 'https://' + host + '/binary/reports/portfolios/' + portfolio + '/frames/' + frame.code + '/date/' + end.format();
+			};
 			return _this;
 		}
 
@@ -920,9 +924,20 @@ module.exports = function () {
 					return Gateway.invoke(_this20._readBrokerageReportAvailabilityEndpoint, payload);
 				});
 			}
+
+			/**
+    * Generates a URL suitable for downloading a brokerage report (as a PDF).
+    *
+    * @public
+    * @param {String} portfolio
+    * @param {PositionSummaryFrame} frame
+    * @param {Day} end
+    * @return {Promise<String>}
+    */
+
 		}, {
 			key: 'getBrokerageReportUrl',
-			value: function getBrokerageReportUrl(portfolio, frame, start) {
+			value: function getBrokerageReportUrl(portfolio, frame, end) {
 				var _this21 = this;
 
 				return Promise.resolve().then(function () {
@@ -930,9 +945,9 @@ module.exports = function () {
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsRequired(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
-					assert.argumentIsRequired(start, 'start', Day, 'Day');
+					assert.argumentIsRequired(end, 'end', Day, 'Day');
 
-					return 'https://portfolio-dev.aws.barchart.com/binary/reports/portfolios/9555fb81-f640-4a95-8766-aa59f38d2abd/frames/MONTHLY/date/2017-06-30';
+					return _this21._brokerageReportUrlGenerator(portfolio, frame, end);
 				});
 			}
 
@@ -1578,7 +1593,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.3.3'
+		version: '1.3.4'
 	};
 }();
 

package/lib/gateway/PortfolioGateway.js

@@ -349,9 +349,10 @@ module.exports = (() => {
 				.withPort(port)
 				.withPathBuilder((pb) => {
 					pb.withLiteralParameter('json', 'json')
-						.withLiteralParameter('reports', 'reports')
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
+						.withLiteralParameter('reports', 'reports')
+						.withLiteralParameter('brokerage', 'brokerage')
 						.withLiteralParameter('availability', 'availability');
 				})
 				.withQueryBuilder((qb) => {
@@ -362,6 +363,10 @@ module.exports = (() => {
 				.withResponseInterceptor(responseInterceptorForBrokerageReportAvailabilityDeserialization)
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
+
+			this._brokerageReportUrlGenerator = (portfolio, frame, end) => {
+				return `https://${host}/binary/reports/portfolios/${portfolio}/frames/${frame.code}/date/${end.format()}`;
+			};
 		}
 
 		/**
@@ -917,16 +922,25 @@ module.exports = (() => {
 				});
 		}
 
-		getBrokerageReportUrl(portfolio, frame, start) {
+		/**
+		 * Generates a URL suitable for downloading a brokerage report (as a PDF).
+		 *
+		 * @public
+		 * @param {String} portfolio
+		 * @param {PositionSummaryFrame} frame
+		 * @param {Day} end
+		 * @return {Promise<String>}
+		 */
+		getBrokerageReportUrl(portfolio, frame, end) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsRequired(frame, 'frame', PositionSummaryFrame, 'PositionSummaryFrame');
-					assert.argumentIsRequired(start, 'start', Day, 'Day');
+					assert.argumentIsRequired(end, 'end', Day, 'Day');
 
-					return 'https://portfolio-dev.aws.barchart.com/binary/reports/portfolios/9555fb81-f640-4a95-8766-aa59f38d2abd/frames/MONTHLY/date/2017-06-30';
+					return this._brokerageReportUrlGenerator(portfolio, frame, end);
 				});
 		}
 

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",