@barchart/portfolio-client-js 10.3.1 → 10.5.0

package/lib/gateway/PortfolioGateway.js

@@ -119,7 +119,8 @@ module.exports = (() => {
 						.withVariableParameter('symbol', 'symbol', 'symbol', false);
 				})
 				.withQueryBuilder((qb) => {
-					qb.withVariableParameter('day', 'day', 'day', true, x => x.format());
+					qb.withVariableParameter('day', 'day', 'day', true, x => x.format())
+						.withVariableParameter('closing', 'closing', 'closing', true, x => is.boolean(x) && x ? 'true' : x);
 				})
 				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
 				.withRequestInterceptor(requestInterceptor)
@@ -630,6 +631,9 @@ module.exports = (() => {
 						.withLiteralParameter('accounts', 'accounts')
 						.withVariableParameter('account', 'account', 'account', false);
 				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('openOnly', 'openOnly', 'openOnly', true);
+				})
 				.withRequestInterceptor(requestInterceptor)
 				.withResponseInterceptor(responseInterceptorForSnapTradeAccountLinkResponse)
 				.withErrorInterceptor(errorInterceptor)
@@ -669,6 +673,9 @@ module.exports = (() => {
 						.withLiteralParameter('accounts', 'accounts')
 						.withVariableParameter('account', 'account', 'account', false);
 				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('openOnly', 'openOnly', 'openOnly', true);
+				})
 				.withRequestInterceptor(requestInterceptor)
 				.withResponseInterceptor(responseInterceptorForSnapTradeAccountLinkResponse)
 				.withErrorInterceptor(errorInterceptor)
@@ -755,6 +762,24 @@ module.exports = (() => {
 			return Gateway.invoke(this._readInstrumentEndpoint, payload);
 		}
 
+		/**
+		 * Resolves an instrument closing price.
+		 *
+		 * @public
+		 * @async
+		 * @param {String} symbol - The instrument symbol.
+		 * @param {Day} day - The date the closing price is requested.
+		 * @returns {Promise<Object>}
+		 */
+		async readInstrumentClosing(symbol, day) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(symbol, 'symbol', String);
+			assert.argumentIsRequired(day, 'day', Day, 'Day');
+
+			return Gateway.invoke(this._readInstrumentEndpoint, { symbol, day, closing: true });
+		}
+
 		/**
 		 * Creates a new portfolio for the current user.
 		 *
@@ -1529,15 +1554,23 @@ module.exports = (() => {
 		 * @async
 		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
 		 * @param {String} account - The SnapTrade identifier for the brokerage account.
+		 * @param {Boolean=} openOnly - When true, links only open positions. When false, links all positions.
 		 * @returns {Promise<Schema.SnapTradeLinkingReport>}
 		 */
-		async linkSnapTradeAccount(connection, account) {
+		async linkSnapTradeAccount(connection, account, openOnly) {
 			checkStart.call(this);
 
 			assert.argumentIsRequired(connection, 'connection', String);
 			assert.argumentIsRequired(account, 'account', String);
+			assert.argumentIsOptional(openOnly, 'openOnly', Boolean);
+
+			const payload = { connection, account };
 
-			return Gateway.invoke(this._linkSnapTradeAccountEndpoint, { connection, account });
+			if (is.boolean(openOnly)) {
+				payload.openOnly = openOnly;
+			}
+
+			return Gateway.invoke(this._linkSnapTradeAccountEndpoint, payload);
 		}
 
 		/**
@@ -1563,15 +1596,23 @@ module.exports = (() => {
 		 * @async
 		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
 		 * @param {String} account - The SnapTrade identifier for the brokerage account.
+		 * @param {Boolean=} openOnly - When true, refreshes only open positions. When false, refreshes all positions.
 		 * @returns {Promise<Schema.SnapTradeLinkingReport>}
 		 */
-		async refreshSnapTradeAccount(connection, account) {
+		async refreshSnapTradeAccount(connection, account, openOnly) {
 			checkStart.call(this);
 
 			assert.argumentIsRequired(connection, 'connection', String);
 			assert.argumentIsRequired(account, 'account', String);
+			assert.argumentIsOptional(openOnly, 'openOnly', Boolean);
+
+			const payload = { connection, account };
+
+			if (is.boolean(openOnly)) {
+				payload.openOnly = openOnly;
+			}
 
-			return Gateway.invoke(this._refreshSnapTradeAccountEndpoint, { connection, account });
+			return Gateway.invoke(this._refreshSnapTradeAccountEndpoint, payload);
 		}
 
 		/**

package/lib/index.js

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtProvider: JwtProvider,
 		PortfolioGateway: PortfolioGateway,
-		version: '10.3.1'
+		version: '10.5.0'
 	};
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "10.3.1",
+  "version": "10.5.0",
   "description": "JavaScript SDK for Barchart's Portfolio Service",
   "homepage": "https://docs.barchart.com/portfolio/#/",
   "author": {
@@ -8,6 +8,13 @@
     "email": "bryan.ingle@barchart.com",
     "url": "https://www.barchart.com"
   },
+  "contributors": [
+    {
+      "name": "Luka Sotra",
+      "email": "luka.sotra@barchart.com",
+      "url": "https://www.barchart.com"
+    }
+  ],
   "scripts": {
     "test": "echo \"Error: Please use gulp to run tests\" && exit 1"
   },