@barchart/portfolio-client-js 1.2.30 → 1.2.33

package/example/example.js

@@ -292,7 +292,7 @@ module.exports = function () {
 			}).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(ResponseInterceptor.DATA).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('pdf', 'pdf').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('brokerage', 'brokerage').withLiteralParameter('frames', 'frames').withVariableParameter('frame', 'frame', 'frame', false, function (x) {
+				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();
@@ -935,13 +935,13 @@ module.exports = function () {
     * @public
     * @param {String=} portfolio
     * @param {PositionSummaryFrame} frame
-    * @param {Day} start
+    * @param {Day} end
     * @returns {Promise}
     */
 
 		}, {
 			key: 'downloadBrokerageReport',
-			value: function downloadBrokerageReport(portfolio, frame, start) {
+			value: function downloadBrokerageReport(portfolio, frame, end) {
 				var _this21 = this;
 
 				return Promise.resolve().then(function () {
@@ -949,13 +949,13 @@ 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');
 
 					var payload = {};
 
 					payload.portfolio = portfolio;
 					payload.frame = frame;
-					payload.start = start;
+					payload.start = end;
 
 					return Gateway.invoke(_this21._downloadBrokerageReportEndpoint, payload);
 				});
@@ -1556,7 +1556,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.30'
+		version: '1.2.32'
 	};
 }();
 

package/lib/gateway/PortfolioGateway.js

@@ -7,9 +7,9 @@ const assert = require('@barchart/common-js/lang/assert'),
 
 const TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
 
-const PortfolioSchema = require('@barchart/portfolio-api-common/lib/serialization/PortfolioSchema'),
+const BrokerageReportAvailabilitySchema = require('@barchart/portfolio-api-common/lib/serialization/reports/BrokerageReportAvailabilitySchema'),
+	PortfolioSchema = require('@barchart/portfolio-api-common/lib/serialization/PortfolioSchema'),
 	PositionSummarySchema = require('@barchart/portfolio-api-common/lib/serialization/PositionSummarySchema'),
-	PositionSummaryDefinitionSchema = require('@barchart/portfolio-api-common/lib/serialization/PositionSummaryDefinitionSchema'),
 	PositionSchema = require('@barchart/portfolio-api-common/lib/serialization/PositionSchema'),
 	TransactionSchema = require('@barchart/portfolio-api-common/lib/serialization/TransactionSchema');
 
@@ -197,26 +197,6 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
-			this._readPositionSummaryDefinitionEndpoint = EndpointBuilder.for('read-position-summary-definitions', 'read position summary definitions')
-				.withVerb(VerbType.GET)
-				.withProtocol(protocolType)
-				.withHost(host)
-				.withPort(port)
-				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('portfolios', 'portfolios')
-						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
-						.withLiteralParameter('summaries', 'summaries')
-						.withLiteralParameter('ranges', 'ranges');
-				})
-				.withQueryBuilder((qb) => {
-					qb.withVariableParameter('frames', 'frames', 'frames', true, frames => frames.map(f => f.code).join());
-				})
-				.withRequestInterceptor(requestInterceptorToUse)
-				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
-				.withResponseInterceptor(responseInterceptorForPositionSummaryDefinitionDeserialization)
-				.withErrorInterceptor(ErrorInterceptor.GENERAL)
-				.endpoint;
-
 			this._readTransactionsEndpoint = EndpointBuilder.for('read-transactions', 'read transactions')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -348,6 +328,26 @@ module.exports = (() => {
 				.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((pb) => {
+					pb.withLiteralParameter('portfolios', 'portfolios')
+					.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
+					.withLiteralParameter('summaries', 'summaries')
+					.withLiteralParameter('ranges', 'ranges');
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('frames', 'frames', 'frames', true, frames => frames.map(f => f.code).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)
@@ -355,9 +355,8 @@ module.exports = (() => {
 				.withPort(port)
 				.withPathBuilder((pb) => {
 					pb.withLiteralParameter('reports', 'reports')
-						.withLiteralParameter('pdf', 'pdf')
+						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
-						.withLiteralParameter('brokerage', 'brokerage')
 						.withLiteralParameter('frames', 'frames')
 						.withVariableParameter('frame', 'frame', 'frame', false, x => x.code)
 						.withLiteralParameter('date', 'date')
@@ -646,27 +645,6 @@ module.exports = (() => {
 				});
 		}
 
-		/**
-		 * Returns all position summary definitions for a portfolio.
-		 *
-		 * @public
-		 * @param {String} portfolio
-		 * @param {Array.<PositionSummaryFrame>} frames
-		 */
-		readPositionSummaryDefinitions(portfolio, frames) {
-			return Promise.resolve()
-				.then(() => {
-					assert.argumentIsRequired(portfolio, 'portfolio', String);
-
-					const payload = { };
-
-					payload.portfolio = portfolio;
-					payload.frames = frames;
-
-					return Gateway.invoke(this._readPositionSummaryDefinitionEndpoint, payload);
-				});
-		}
-
 		/**
 		 * Deletes a position.
 		 *
@@ -923,27 +901,46 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Returns all position summary definitions for a portfolio.
+		 *
+		 * @public
+		 * @param {String} portfolio
+		 */
+		readBrokerageReportAvailability(portfolio) {
+			return Promise.resolve()
+			.then(() => {
+				assert.argumentIsRequired(portfolio, 'portfolio', String);
+
+				const payload = { };
+
+				payload.portfolio = portfolio;
+
+				return Gateway.invoke(this._readBrokerageReportAvailabilityEndpoint, payload);
+			});
+		}
+
 		/**
 		 * @public
 		 * @param {String=} portfolio
 		 * @param {PositionSummaryFrame} frame
-		 * @param {Day} start
+		 * @param {Day} end
 		 * @returns {Promise}
 		 */
-		downloadBrokerageReport(portfolio, frame, start) {
+		downloadBrokerageReport(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');
 	
 					const payload = { };
 	
 					payload.portfolio = portfolio;
 					payload.frame = frame;
-					payload.start = start;
+					payload.start = end;
 					
 					return Gateway.invoke(this._downloadBrokerageReportEndpoint, payload);
 				});
@@ -1103,11 +1100,11 @@ module.exports = (() => {
 		}
 	});
 
-	const responseInterceptorForPositionSummaryDefinitionDeserialization = ResponseInterceptor.fromDelegate((response, ignored) => {
+	const responseInterceptorForBrokerageReportAvailabilityDeserialization = ResponseInterceptor.fromDelegate((response, ignored) => {
 		try {
-			return JSON.parse(response.data, PositionSummaryDefinitionSchema.COMPLETE.schema.getReviver());
+			return JSON.parse(response.data, BrokerageReportAvailabilitySchema.COMPLETE.schema.getReviver());
 		} catch (e) {
-			console.log('Error deserializing position summary definition', e);
+			console.log('Error deserializing brokerage report availability definition', e);
 		}
 	});
 

package/lib/index.js

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

package/package.json

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