@barchart/portfolio-client-js 10.0.0 → 10.0.1

package/lib/data/.meta.js

@@ -240,6 +240,19 @@ const InstrumentType = require('@barchart/portfolio-api-common/lib/data/Instrume
  * @property {Boolean} replaced - If true, the position (and position summaries) need to be replaced.
  */
 
+/**
+ * The result of a position mutation operation (like moving, adding, or deleting a position).
+ * It contains structured information about what changed in the portfolio(s).
+ *
+ * @typedef PositionMutateResult
+ * @type Object
+ * @memberOf Schema
+ * @property {Object} positions - The raw lists of saved and deleted positions directly from the API.
+ * @property {Schema.Position[]} positions.saved - All positions that were inserted or updated in the database.
+ * @property {Schema.Position[]} positions.deleted - All positions that were deleted from the database.
+ * @property {Schema.PositionSummary[]} summaries - All position summaries created or updated as a result of the operation.
+ */
+
 /**
  * The symbols (i.e. codes) used to identify an instrument (e.g. "AAPL" for Apple Inc).
  *
@@ -283,4 +296,95 @@ const InstrumentType = require('@barchart/portfolio-api-common/lib/data/Instrume
  * @memberOf Schema
  * @property {Boolean} available - If true, all position and portfolio valuations are up-to-date.
  * @property {String[]} positions - Array of position identifiers for which are currently being calculated. An empty result indicates all position valuations are up-to-date.
- */
+ */
+
+/**
+ * Instructions for connecting to a brokerage via SnapTrade.
+ *
+ * @ignore
+ * @typedef SnapTradeConnectInstructions
+ * @type {Object}
+ * @memberOf Schema
+ * @property {String} uri - The URI for brokerage authentication.
+ */
+
+/**
+ * Data regarding a SnapTrade brokerage.
+ *
+ * @ignore
+ * @typedef SnapTradeBrokerage
+ * @type {Object}
+ * @memberOf Schema
+ * @property {String} id - The SnapTrade identifier for the brokerage.
+ * @property {String} name - The name of the brokerage.
+ * @property {String} display - The name of the brokerage (for display to a user).
+ * @property {String} logo - The URI for the logo image for the brokerage.
+ * @property {SnapTradeConnection|null} connection
+ * @property {SnapTradeAccount[]} accounts
+ */
+
+/**
+ * Data regarding a connection to a SnapTrade brokerage.
+ *
+ * @ignore
+ * @typedef SnapTradeConnection
+ * @type {Object}
+ * @memberOf Schema
+ * @property {String} id - The SnapTrade identifier for the brokerage connection.
+ * @property {Boolean} broken - Indicates if the user needs to authenticate again.
+ */
+
+/**
+ * Data regarding an SnapTrade brokerage account.
+ *
+ * @ignore
+ * @typedef SnapTradeAccount
+ * @type {Object}
+ * @memberOf Schema
+ * @property {String} id - The SnapTrade identifier for the brokerage account.
+ * @property {String} number - The brokerage account number (masked).
+ * @property {String} name - The brokerage account name.
+ * @property {String} type - The brokerage account type.
+ * @property {SnapTradeLink|null} link
+ */
+
+/**
+ * Data regarding the linkage SnapTrade account and a portfolio.
+ *
+ * @ignore
+ * @typedef SnapTradeLink
+ * @type {Object}
+ * @memberOf Schema
+ * @property {SnapTradeLinkStatus} status - The status of the link.
+ * @property {number} progress - If the status indicates work in progress, this is the percent complete (as a whole number).
+ * @property {Timestamp} timestamp - The timestamp of the most recent status update.
+ * @property {String=} advice
+ */
+
+/**
+ * Data regarding the status of a link between a SnapTrade account and a portfolio.
+ *
+ * @ignore
+ * @typedef SnapTradeLinkProgress
+ * @type {Object}
+ * @memberOf Schema
+ * @property {String} user
+ * @property {String} portfolio
+ * @property {String} connection
+ * @property {String} account
+ * @property {SnapTradeLinkStatus} status
+ * @property {number} progress
+ */
+
+/**
+ * Data returned by a linking operation (which could add or remove portfolios).
+ *
+ * @ignore
+ * @typedef SnapTradeLinkingReport
+ * @type {Object}
+ * @memberOf Schema
+ * @property {SnapTradeBrokerage[]} brokerages
+ * @property {Object} portfolios
+ * @property {Portfolio} portfolios.saved
+ * @property {Portfolio} portfolios.deleted
+ */

package/lib/gateway/PortfolioGateway.js

@@ -5,7 +5,8 @@ const array = require('@barchart/common-js/lang/array'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	Event = require('@barchart/common-js/messaging/Event'),
 	is = require('@barchart/common-js/lang/is'),
-	promise = require('@barchart/common-js/lang/promise');
+	promise = require('@barchart/common-js/lang/promise'),
+	Timestamp = require('@barchart/common-js/lang/Timestamp');
 
 const TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
 
@@ -15,7 +16,8 @@ const BrokerageReportAvailabilitySchema = require('@barchart/portfolio-api-commo
 	PositionSchema = require('@barchart/portfolio-api-common/lib/serialization/PositionSchema'),
 	TransactionSchema = require('@barchart/portfolio-api-common/lib/serialization/TransactionSchema');
 
-const PositionSummaryFrame = require('@barchart/portfolio-api-common/lib/data/PositionSummaryFrame');
+const PositionSummaryFrame = require('@barchart/portfolio-api-common/lib/data/PositionSummaryFrame'),
+	SnapTradeLinkStatus = require('@barchart/portfolio-api-common/lib/data/SnapTradeLinkStatus');
 
 const EndpointBuilder = require('@barchart/common-js/api/http/builders/EndpointBuilder'),
 	Gateway = require('@barchart/common-js/api/http/Gateway'),
@@ -62,27 +64,27 @@ module.exports = (() => {
 
 			this._authorizationEvent = new Event(this);
 
-			const requestInterceptor = RequestInterceptor.fromDelegate((options, endpoint) => {
-				return Promise.resolve()
-					.then(() => {
-						return this._jwtProvider.getToken()
-							.then((token) => {
-								options.headers = options.headers || {};
-								options.headers.Authorization = `Bearer ${token}`;
+			const requestInterceptor = RequestInterceptor.fromDelegate(async (options, endpoint) => {
+				let token;
 
-								if (is.string(product) && product.length > 0) {
-									options.headers['X-Barchart-Product'] = product;
-								}
+				try {
+					token = await this._jwtProvider.getToken();
+				} catch (e) {
+					const failure = FailureReason.forRequest({ endpoint: endpoint })
+						.addItem(FailureType.REQUEST_IDENTITY_FAILURE)
+						.format();
 
-								return options;
-							});
-					}).catch((e) => {
-						const failure = FailureReason.forRequest({ endpoint: endpoint })
-							.addItem(FailureType.REQUEST_IDENTITY_FAILURE)
-							.format();
+					throw failure;
+				}
 
-						return Promise.reject(failure);
-					});
+				options.headers = options.headers || {};
+				options.headers.Authorization = `Bearer ${token}`;
+
+				if (is.string(product) && product.length > 0) {
+					options.headers['X-Barchart-Product'] = product;
+				}
+
+				return options;
 			});
 
 			const errorInterceptor = ErrorInterceptor.fromDelegate((error, endpoint) => {
@@ -231,6 +233,26 @@ module.exports = (() => {
 				.withErrorInterceptor(errorInterceptor)
 				.endpoint;
 
+			this._movePositionEndpoint = EndpointBuilder.for('move-position', 'move position')
+				.withVerb(VerbType.PATCH)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('portfolios', 'portfolios')
+						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
+						.withLiteralParameter('positions', 'positions')
+						.withVariableParameter('position', 'position', 'position', false);
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('target', 'target', 'target', false);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForPositionMutateDeserialization)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
 			this._readPositionSummariesEndpoint = EndpointBuilder.for('read-position-summaries', 'read position summaries')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -473,6 +495,149 @@ module.exports = (() => {
 				.withErrorInterceptor(errorInterceptor)
 				.endpoint;
 
+			this._readSnapTradeBrokeragesEndpoint = EndpointBuilder.for('query-snaptrade-brokerages', 'query-snaptrade-accounts')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('brokerages', 'brokerages');
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForSnapTradeBrokerages)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
+			this._connectSnapTradeBrokerEndpoint = EndpointBuilder.for('connect-snaptrade-broker', 'connect-snaptrade-connection')
+				.withVerb(VerbType.POST)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('connections', 'connections');
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('brokerage', 'brokerage', 'brokerage', true);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(ResponseInterceptor.DATA)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
+			this._reconnectSnapTradeBrokerEndpoint = EndpointBuilder.for('reconnect-snaptrade-broker', 'reconnect-snaptrade-connection')
+				.withVerb(VerbType.PUT)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('connections', 'connections')
+						.withVariableParameter('connection', 'connection', 'connection', false);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(ResponseInterceptor.DATA)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
+			this._disconnectSnapTradeBrokerEndpoint = EndpointBuilder.for('disconnect-snaptrade-broker', 'disconnect-snaptrade-connection')
+				.withVerb(VerbType.DELETE)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('connections', 'connections')
+						.withVariableParameter('connection', 'connection', 'connection', false);
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('remove', 'remove', 'remove', true);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForSnapTradeAccountLinkResponse)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
+			this._readSnapTradeAccountLinkEndpoint = EndpointBuilder.for('query-snaptrade-account-link', 'query-snaptrade-account-link')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('connections', 'connections')
+						.withVariableParameter('connection', 'connection', 'connection', false)
+						.withLiteralParameter('accounts', 'accounts')
+						.withVariableParameter('account', 'account', 'account', false);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForSnapTradeAccountLinkSnapshot)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
+			this._linkSnapTradeAccountEndpoint = EndpointBuilder.for('link-snaptrade-account', 'link-snaptrade-account')
+				.withVerb(VerbType.POST)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('connections', 'connections')
+						.withVariableParameter('connection', 'connection', 'connection', false)
+						.withLiteralParameter('accounts', 'accounts')
+						.withVariableParameter('account', 'account', 'account', false);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForSnapTradeAccountLinkResponse)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
+			this._unlinkSnapTradeAccountEndpoint = EndpointBuilder.for('unlink-snaptrade-account', 'unlink-snaptrade-account')
+				.withVerb(VerbType.DELETE)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('connections', 'connections')
+						.withVariableParameter('connection', 'connection', 'connection', false)
+						.withLiteralParameter('accounts', 'accounts')
+						.withVariableParameter('account', 'account', 'account', false);
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('remove', 'remove', 'remove', true);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForSnapTradeAccountLinkResponse)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
+			this._refreshSnapTradeAccountEndpoint = EndpointBuilder.for('refresh-snaptrade-account', 'refresh-snaptrade-account')
+				.withVerb(VerbType.PUT)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', REST_API_VERSION)
+						.withLiteralParameter('snaptrade', 'snaptrade')
+						.withLiteralParameter('connections', 'connections')
+						.withVariableParameter('connection', 'connection', 'connection', false)
+						.withLiteralParameter('accounts', 'accounts')
+						.withVariableParameter('account', 'account', 'account', false);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(responseInterceptorForSnapTradeAccountLinkResponse)
+				.withErrorInterceptor(errorInterceptor)
+				.endpoint;
+
 			this._readVersionEndpoint = EndpointBuilder.for('read-api-version', 'read api version')
 				.withVerb(VerbType.GET)
 				.withProtocol(protocolType)
@@ -518,21 +683,13 @@ module.exports = (() => {
 			assert.argumentIsRequired(jwtProvider, 'jwtProvider', JwtProvider, 'JwtProvider');
 
 			if (this._startPromise === null) {
-				this._startPromise = Promise.resolve()
-					.then(() => {
-						this._started = true;
-
-						this._jwtProvider = jwtProvider;
+				this._startPromise = (async () => {
+					this._started = true;
 
-						return this;
-					}).catch((e) => {
-						this._started = false;
-						this._startPromise = null;
+					this._jwtProvider = jwtProvider;
 
-						this._jwtProvider = null;
-
-						throw e;
-					});
+					return this;
+				})();
 			}
 
 			return this._startPromise;
@@ -584,7 +741,7 @@ module.exports = (() => {
 
 			assert.argumentIsRequired(portfolio, 'portfolio', String);
 
-			return Gateway.invoke(this._deletePortfolioEndpoint, { portfolio: portfolio });
+			return Gateway.invoke(this._deletePortfolioEndpoint, { portfolio });
 		}
 
 		/**
@@ -639,6 +796,26 @@ module.exports = (() => {
 			return Gateway.invoke(this._deletePositionEndpoint, { portfolio: portfolio, position: position });
 		}
 
+		/**
+		 * Moves a position from the current portfolio to a target portfolio.
+		 *
+		 * @public
+		 * @async
+		 * @param {String} portfolio - The identifier of the source portfolio.
+		 * @param {String} position - The identifier of the position to move.
+		 * @param {String} target - The identifier of the destination portfolio.
+		 * @returns {Promise<Schema.PositionMutateResult>}
+		 */
+		async movePosition(portfolio, position, target) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(portfolio, 'portfolio', String);
+			assert.argumentIsRequired(position, 'position', String);
+			assert.argumentIsRequired(target, 'target', String);
+
+			return Gateway.invoke(this._movePositionEndpoint, { portfolio: portfolio, position: position, target: target });
+		}
+
 		/**
 		 * Retrieves all positions for a user, a user's portfolio, or a single position.
 		 *
@@ -707,24 +884,33 @@ module.exports = (() => {
 				assert.argumentIsRequired(position, 'position', String);
 
 				const scheduleCheck = (delay) => {
-					setTimeout(() => {
-						Gateway.invoke(this._readPositionsEndpoint, { portfolio: portfolio, position: position, includePreviousPrice: false })
-							.then((positions) => {
-								const p = positions.find(p => p.position === position);
-
-								if (is.object(p)) {
-									if (is.object(p.system) && is.object(p.system) && is.boolean(p.system.locked) && p.system.locked) {
-										scheduleCheck(delay + 1000);
-									} else {
-										resolveCallback(p);
-									}
-								} else {
-									resolveCallback(null);
-								}
-							}).catch((e) => {
-								scheduleCheck(delay + 5000);
-							});
-					}, delay);
+					const process = async () => {
+						let positions;
+
+						try {
+							positions = await Gateway.invoke(this._readPositionsEndpoint, { portfolio: portfolio, position: position, includePreviousPrice: false });
+						} catch (e) {
+							scheduleCheck(delay + 5000);
+
+							return;
+						}
+
+						const p = positions.find(p => p.position === position);
+
+						if (!is.object(p)) {
+							resolveCallback(null);
+
+							return;
+						}
+
+						if (is.object(p.system) && is.boolean(p.system.locked) && p.system.locked) {
+							scheduleCheck(delay + 1000);
+						} else {
+							resolveCallback(p);
+						}
+					};
+
+					setTimeout(process, Math.min(delay, 15000));
 				};
 
 				scheduleCheck(2500);
@@ -807,7 +993,7 @@ module.exports = (() => {
 		 * @public
 		 * @async
 		 * @ignore
-		 * @param {String} portfolio - The identifier of the portfolio.
+		 * @param {String=} portfolio - The identifier of the portfolio.
 		 * @param {String=} position - The identifier of the position. If omitted, that valuation history will be returned for the entire portfolio (i.e. sum of valuations for all positions contained in the portfolio).
 		 * @param {Boolean=} parse - If true, the result will be a {@link Schema.ValuationContainer} object. Otherwise, the result will be a JSON-formatted string.
 		 * @returns {Promise<String|Schema.ValuationContainer>}
@@ -815,26 +1001,26 @@ module.exports = (() => {
 		async readPositionValuations(portfolio, position, parse) {
 			checkStart.call(this);
 
-			assert.argumentIsRequired(portfolio, 'portfolio', String);
+			assert.argumentIsOptional(portfolio, 'portfolio', String);
 			assert.argumentIsOptional(position, 'position', String);
 
 			const payload = { };
 
-			payload.portfolio = portfolio;
-			payload.position = position || '*';
+			payload.portfolio = portfolio || '*';
 
-			return Gateway.invoke(this._readPositionValuationsEndpoint, payload)
-				.then((json) => {
-					let result;
+			if (portfolio) {
+				payload.position = position || '*';
+			} else {
+				payload.position = '*';
+			}
 
-					if (parse) {
-						result = JSON.parse(json);
-					} else {
-						result = json;
-					}
+			const json = await Gateway.invoke(this._readPositionValuationsEndpoint, payload);
 
-					return result;
-				});
+			if (parse) {
+				return JSON.parse(json);
+			} else {
+				return json;
+			}
 		}
 
 		/**
@@ -1155,6 +1341,160 @@ module.exports = (() => {
 			return this._brokerageReportUrlGenerator(user, portfolio, frame, end);
 		}
 
+		/**
+		 * Read the list of available SnapTrade brokerages (excluding account information).
+		 *
+		 * @public
+		 * @async
+		 * @returns {Promise<Schema.SnapTradeBrokerage[]>}
+		 */
+		async readSnapTradeBrokerages() {
+			checkStart.call(this);
+
+			return Gateway.invoke(this._readSnapTradeBrokeragesEndpoint, { });
+		}
+
+		/**
+		 * Generates connection instructions for a SnapTrade brokerage.
+		 *
+		 * @public
+		 * @async
+		 * @param {String} brokerage - The SnapTrade identifier for the brokerage.
+		 * @returns {Promise<Schema.SnapTradeConnectInstructions>}
+		 */
+		async connectSnapTradeBrokerage(brokerage) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(brokerage, 'brokerage', String);
+
+			return Gateway.invoke(this._connectSnapTradeBrokerEndpoint, { brokerage });
+		}
+
+		/**
+		 * Generates reconnect instructions for a SnapTrade brokerage.
+		 *
+		 * @public
+		 * @async
+		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
+		 * @returns {Promise<Schema.SnapTradeConnectInstructions>}
+		 */
+		async reconnectSnapTradeBrokerage(connection) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(connection, 'connection', String);
+
+			return Gateway.invoke(this._reconnectSnapTradeBrokerEndpoint, { connection });
+		}
+
+		/**
+		 * Removes the connection to a SnapTrade brokerage.
+		 *
+		 * @public
+		 * @async
+		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
+		 * @param {Boolean=} remove - Causes all linked portfolios to be deleted.
+		 * @returns {Promise<SnapTradeLinkingReport>}
+		 */
+		async disconnectSnapTradeBrokerage(connection, remove) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(connection, 'connection', String);
+
+			return Gateway.invoke(this._disconnectSnapTradeBrokerEndpoint, { connection, remove: remove || false });
+		}
+
+		/**
+		 * Repeatedly queries the SnapTrade account linking status (until disposed or until
+		 * the status reaches 100%).
+		 *
+		 * @public
+		 * @async
+		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
+		 * @param {String} account - The SnapTrade identifier for the brokerage account.
+		 * @param {SnapTradeLinkStatusCallback} callback
+		 * @returns {Disposable}
+		 */
+		subscribeSnapTradeAccountLink(connection, account, callback) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(connection, 'connection', String);
+			assert.argumentIsRequired(account, 'account', String);
+
+			let disposable;
+
+			const poll = async () => {
+				try {
+					const status = await Gateway.invoke(this._readSnapTradeAccountLinkEndpoint, { connection, account });
+
+					if (status && status.progress === 100) {
+						disposable.dispose();
+					}
+
+					callback(status);
+				} catch (e) {
+
+				}
+			};
+
+			const token = setInterval(poll, 2500);
+
+			disposable = Disposable.fromAction(() => {
+				clearInterval(token);
+			});
+
+			return disposable;
+		}
+
+		/**
+		 * @public
+		 * @async
+		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
+		 * @param {String} account - The SnapTrade identifier for the brokerage account.
+		 * @returns {Promise<Schema.SnapTradeLinkingReport>}
+		 */
+		async linkSnapTradeAccount(connection, account) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(connection, 'connection', String);
+			assert.argumentIsRequired(account, 'account', String);
+
+			return Gateway.invoke(this._linkSnapTradeAccountEndpoint, { connection, account });
+		}
+
+		/**
+		 * @public
+		 * @async
+		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
+		 * @param {String} account - The SnapTrade identifier for the brokerage account.
+		 * @param {Boolean=} remove - Causes the linked portfolio to be deleted.
+		 * @returns {Promise<Schema.SnapTradeLinkingReport>}
+		 */
+		async unlinkSnapTradeAccount(connection, account, remove) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(connection, 'connection', String);
+			assert.argumentIsRequired(account, 'account', String);
+			assert.argumentIsOptional(remove, 'remove', Boolean);
+
+			return Gateway.invoke(this._unlinkSnapTradeAccountEndpoint, { connection, account, remove: remove || false });
+		}
+
+		/**
+		 * @public
+		 * @async
+		 * @param {String} connection - The SnapTrade identifier for the brokerage connection.
+		 * @param {String} account - The SnapTrade identifier for the brokerage account.
+		 * @returns {Promise<Schema.SnapTradeLinkingReport>}
+		 */
+		async refreshSnapTradeAccount(connection, account) {
+			checkStart.call(this);
+
+			assert.argumentIsRequired(connection, 'connection', String);
+			assert.argumentIsRequired(account, 'account', String);
+
+			return Gateway.invoke(this._refreshSnapTradeAccountEndpoint, { connection, account });
+		}
+
 		/**
 		 * Returns current version of the Portfolio Service.
 		 *
@@ -1450,6 +1790,30 @@ module.exports = (() => {
 		}
 	});
 
+	const responseInterceptorForSnapTradeBrokerages = ResponseInterceptor.fromDelegate((response, ignored) => {
+		try {
+			return deserializeSnapTradeBrokeragesData(response.data);
+		} catch (e) {
+			console.error('Error deserializing snaptrade brokerage data', e);
+		}
+	});
+
+	const responseInterceptorForSnapTradeAccountLinkResponse = ResponseInterceptor.fromDelegate((response, ignored) => {
+		try {
+			return deserializeSnapTradeAccountLinkResponseData(response.data);
+		} catch (e) {
+			console.error('Error deserializing snaptrade account link response data', e);
+		}
+	});
+
+	const responseInterceptorForSnapTradeAccountLinkSnapshot = ResponseInterceptor.fromDelegate((response, ignored) => {
+		try {
+			return deserializeSnapTradeAccountLinkSnapshotData(response.data);
+		} catch (e) {
+			console.error('Error deserializing snaptrade account link snapshot data', e);
+		}
+	});
+
 	const responseInterceptorForDeserialization = ResponseInterceptor.fromDelegate((response, ignored) => {
 		try {
 			return JSON.parse(response.data);
@@ -1487,7 +1851,7 @@ module.exports = (() => {
 		const removed = array.differenceBy(deleted, saved, extractInstrumentId);
 		const edited = array.differenceBy(array.unionBy(saved, deleted, extractInstrumentId), array.unionBy(created, removed, extractInstrumentId), extractInstrumentId);
 
-		const returnRef = {
+		const deserialized = {
 			actions: {
 				created: created,
 				removed: removed,
@@ -1501,11 +1865,56 @@ module.exports = (() => {
 		};
 
 		if (data.transactions) {
-			returnRef.transactions = data.transactions;
+			deserialized.transactions = data.transactions;
 		}
 
-		return returnRef;
+		return deserialized;
 	}
 
- 	return PortfolioGateway;
-})();
+	function deserializeSnapTradeBrokeragesData(data) {
+		const brokerages = data;
+
+		brokerages.forEach((brokerage) => {
+			const accounts = brokerage.accounts || [ ];
+
+			accounts.forEach((account) => {
+				if (account.link) {
+					account.link.status = SnapTradeLinkStatus.parse(account.link.status);
+					account.link.timestamp = Timestamp.parse(account.link.timestamp);
+				}
+			});
+		});
+
+		return brokerages;
+	}
+
+	function deserializeSnapTradeAccountLinkResponseData(data) {
+		const brokerages = deserializeSnapTradeBrokeragesData(data.brokerages);
+
+		const saved = data.portfolios.saved.map(p => JSON.parse(p, PortfolioSchema.CLIENT.schema.getReviver()));
+		const deleted = data.portfolios.deleted.map(p => JSON.parse(p, PortfolioSchema.CLIENT.schema.getReviver()));
+
+		return { brokerages, portfolios: { saved, deleted } };
+	}
+
+	function deserializeSnapTradeAccountLinkSnapshotData(data) {
+		const status = data;
+
+		if (status) {
+			status.status = SnapTradeLinkStatus.parse(status.status);
+			status.timestamp = Timestamp.parse(status.timestamp);
+		}
+
+		return status;
+	}
+
+	/**
+	 * A callback return a {@link SnapTradeLinkStatus}.
+	 *
+	 * @public
+	 * @callback SnapTradeLinkStatusCallback
+	 * @param {SnapTradeLinkProgress} status
+	 */
+
+	return PortfolioGateway;
+})();

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "10.0.0",
+  "version": "10.0.1",
   "description": "JavaScript SDK for Barchart's Portfolio Service",
   "homepage": "https://docs.barchart.com/portfolio/#/",
   "author": {
@@ -28,8 +28,8 @@
     "SDK"
   ],
   "dependencies": {
-    "@barchart/common-js": "^4.58.0",
-    "@barchart/portfolio-api-common": "^7.0.0"
+    "@barchart/common-js": "^4.70.0",
+    "@barchart/portfolio-api-common": "^7.0.1"
   },
   "devDependencies": {
     "@babel/core": "^7.11.1",