@barchart/portfolio-client-js 10.1.0 → 10.3.0

package/lib/data/.meta.js

@@ -298,6 +298,17 @@ const InstrumentType = require('@barchart/portfolio-api-common/lib/data/Instrume
  * @property {String[]} positions - Array of position identifiers for which are currently being calculated. An empty result indicates all position valuations are up-to-date.
  */
 
+/**
+ * The result of recalculating aggregate values in a requested currency for the authorized user.
+ *
+ * @typedef UpdateValuesCurrencyResult
+ * @type {Object}
+ * @memberOf Schema
+ * @property {Boolean} success - Indicates the aggregate values were successfully recalculated.
+ * @property {String} userId - The identifier of the authorized user whose values were recalculated.
+ * @property {String} currency - The currency code used for the recalculation.
+ */
+
 /**
  * Instructions for connecting to a brokerage via SnapTrade.
  *

package/lib/gateway/PortfolioGateway.js

@@ -108,6 +108,25 @@ module.exports = (() => {
 
 			const protocolType = Enum.fromCode(ProtocolType, protocol.toUpperCase());
 
+			this._readInstrumentEndpoint = EndpointBuilder.for('read-instrument', 'read instrument')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('instruments', 'instruments')
+						.withVariableParameter('symbol', 'symbol', 'symbol', false);
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('day', 'day', 'day', true, x => x.format());
+				})
+				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForDeserialization)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
 			this._readPortfoliosEndpoint = EndpointBuilder.for('read-portfolios', 'read portfolios')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -330,6 +349,23 @@ module.exports = (() => {
 				.withErrorInterceptor(errorInterceptor)
 				.endpoint;
 
+			this._updateValuesCurrencyEndpoint = EndpointBuilder.for('update-values-currency', 'update values currency')
+				.withVerb(VerbType.PUT)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('values', 'values')
+						.withLiteralParameter('currency', 'currency');
+				})
+				.withBody('currency')
+				.withRequestInterceptor(RequestInterceptor.PLAIN_TEXT_RESPONSE)
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForDeserialization)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
 			this._readTransactionsEndpoint = EndpointBuilder.for('read-transactions', 'read transactions')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -695,6 +731,30 @@ module.exports = (() => {
 			return this._startPromise;
 		}
 
+		/**
+		 * Resolves an instrument.
+		 *
+		 * @public
+		 * @async
+		 * @param {String} symbol - The symbol used to resolve the instrument.
+		 * @param {Day=} day - The day used for symbol resolution.
+		 * @returns {Promise<Object>}
+		 */
+		async readInstrument(symbol, day) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(symbol, 'symbol', String);
+			assert.argumentIsOptional(day, 'day', Day, 'Day');
+
+			const payload = { symbol };
+
+			if (day) {
+				payload.day = day;
+			}
+
+			return Gateway.invoke(this._readInstrumentEndpoint, payload);
+		}
+
 		/**
 		 * Creates a new portfolio for the current user.
 		 *
@@ -1055,6 +1115,22 @@ module.exports = (() => {
 			return Gateway.invoke(this._queryPositionValuationsEndpoint, { symbol });
 		}
 
+		/**
+		 * Recalculates aggregate values for the authorized user in the requested currency.
+		 *
+		 * @public
+		 * @async
+		 * @param {String} currency - The target currency code (e.g. `USD`).
+		 * @returns {Promise<Schema.UpdateValuesCurrencyResult>}
+		 */
+		async updateValuesCurrency(currency) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(currency, 'currency', String);
+
+			return Gateway.invoke(this._updateValuesCurrencyEndpoint, { currency });
+		}
+
 		/**
 		 * Creates a new transaction.
 		 *
@@ -1920,4 +1996,4 @@ module.exports = (() => {
 	 */
 
 	return PortfolioGateway;
-})();
+})();

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "10.1.0",
+  "version": "10.3.0",
   "description": "JavaScript SDK for Barchart's Portfolio Service",
   "homepage": "https://docs.barchart.com/portfolio/#/",
   "author": {