@barchart/portfolio-client-js 1.2.13 → 1.2.16

package/example/example.js

@@ -193,8 +193,6 @@ 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);
-			}).withHeadersBuilder(function (hb) {
-				hb.withLiteralParameter('Accept-Encoding', 'Accept-Encoding', 'gzip');
 			}).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) {
@@ -269,6 +267,8 @@ module.exports = function () {
 
 			_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');
+			}).withQueryBuilder(function (qb) {
+				qb.withVariableParameter('start', 'start', 'start', true).withVariableParameter('end', 'end', 'end', true);
 			}).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(ResponseInterceptor.DATA).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 			return _this;
 		}
@@ -722,9 +722,22 @@ module.exports = function () {
 					return Gateway.invoke(_this16._readTransactionsEndpoint, { portfolio: portfolio, position: position || '*' });
 				});
 			}
+
+			/**
+    * Retrieves transactions, where the property values are suitable for display,
+    * for a portfolio, or a single position.
+    *
+    * @public
+    * @param {String} portfolio
+    * @param {String=} position
+    * @param {Day=} startDay
+    * @param {Day=} endDay
+    * @returns {Promise.<Object[]>}
+    */
+
 		}, {
 			key: 'readTransactionsFormatted',
-			value: function readTransactionsFormatted(portfolio, position) {
+			value: function readTransactionsFormatted(portfolio, position, startDay, endDay) {
 				var _this17 = this;
 
 				return Promise.resolve().then(function () {
@@ -732,8 +745,23 @@ module.exports = function () {
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsOptional(position, 'position', String);
+					assert.argumentIsOptional(startDay, 'startDay', Day, 'Day');
+					assert.argumentIsOptional(endDay, 'endDay', Day, 'Day');
+
+					var payload = {};
+
+					payload.portfolio = portfolio;
+					payload.position = position || '*';
+
+					if (startDay) {
+						payload.start = startDay;
+					}
+
+					if (endDay) {
+						payload.end = endDay;
+					}
 
-					return Gateway.invoke(_this17._readTransactionsReportEndpoint, { portfolio: portfolio, position: position || '*' });
+					return Gateway.invoke(_this17._readTransactionsReportEndpoint, payload);
 				});
 			}
 
@@ -1324,7 +1352,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.2.13'
+		version: '1.2.16'
 	};
 }();
 

package/lib/gateway/PortfolioGateway.js

@@ -66,9 +66,6 @@ module.exports = (() => {
 					pb.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
-				.withHeadersBuilder((hb) => {
-					hb.withLiteralParameter('Accept-Encoding', 'Accept-Encoding', 'gzip')
-				})
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
 				.withRequestInterceptor(requestInterceptorToUse)
 				.withResponseInterceptor(responseInterceptorForPortfolioDeserialization)
@@ -315,6 +312,10 @@ module.exports = (() => {
 						.withLiteralParameter('transactions', 'transactions')
 						.withLiteralParameter('formatted', 'formatted');
 				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('start', 'start', 'start', true)
+						.withVariableParameter('end', 'end', 'end', true);
+				})
 				.withRequestInterceptor(requestInterceptorToUse)
 				.withResponseInterceptor(ResponseInterceptor.DATA)
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
@@ -714,15 +715,41 @@ module.exports = (() => {
 				});
 		}
 
-		readTransactionsFormatted(portfolio, position) {
+		/**
+		 * Retrieves transactions, where the property values are suitable for display,
+		 * for a portfolio, or a single position.
+		 *
+		 * @public
+		 * @param {String} portfolio
+		 * @param {String=} position
+		 * @param {Day=} startDay
+		 * @param {Day=} endDay
+		 * @returns {Promise.<Object[]>}
+		 */
+		readTransactionsFormatted(portfolio, position, startDay, endDay) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsOptional(position, 'position', String);
+					assert.argumentIsOptional(startDay, 'startDay', Day, 'Day');
+					assert.argumentIsOptional(endDay, 'endDay', Day, 'Day');
+
+					const payload = { };
+
+					payload.portfolio = portfolio;
+					payload.position = position || '*';
+
+					if (startDay) {
+						payload.start = startDay;
+					}
+
+					if (endDay) {
+						payload.end = endDay;
+					}
 
-					return Gateway.invoke(this._readTransactionsReportEndpoint, { portfolio: portfolio, position: position || '*' });
+					return Gateway.invoke(this._readTransactionsReportEndpoint, payload);
 				});
 		}
 

package/lib/index.js

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

package/package.json

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