@barchart/portfolio-client-js 5.1.2 → 5.3.0

package/.awspublish-docs.barchart.com

@@ -0,0 +1 @@
+{"portfolio/_coverpage.md":"\"f957831627399d4be57ceda0fed32e20\"","portfolio/_sidebar.md":"\"a854b0dcd2d5c0eb4de979a93a232b45\"","portfolio/index.html":"\"9966477f3d373643c1cdff2dfde919d4\"","portfolio/content/_sidebar.md":"\"a854b0dcd2d5c0eb4de979a93a232b45\"","portfolio/content/api_reference.md":"\"d554e76f82877a86c6edfadb6c8ee9fc\"","portfolio/content/product_overview.md":"\"fde131b3a4a7c574a8f41ecfd7f202eb\"","portfolio/content/quick_start.md":"\"2e0d8de7247ebc847ad8a56619ef51d3\"","portfolio/content/release_notes.md":"\"1bd7efe30b675a8e3945070c7e9baf49\"","portfolio/content/sdk_reference.md":"\"a9c9669ce7a6478281ada65009738555\"","portfolio/styles/override.css":"\"9445e9c6a2bb7c2e435a09f22142a073\"","portfolio/static/openapi.yaml":"\"835322160925f1cf7e1e8534dec6fd12\"","portfolio/content/api/_sidebar.md":"\"60cdc1db76e58b2631a95a81411c6963\"","portfolio/content/api/components.md":"\"433f10a6c68ffce3920ece1db1de6b4a\"","portfolio/content/api/paths.md":"\"e11c608cde2a5ad94abe70d01bb43b95\"","portfolio/content/concepts/_sidebar.md":"\"a854b0dcd2d5c0eb4de979a93a232b45\"","portfolio/content/concepts/connecting_to_barchart.md":"\"ebbe0644caea27269ca2d553e9507bbc\"","portfolio/content/concepts/interaction_basics.md":"\"9fd648c53f183143f352e5d117739cdc\"","portfolio/content/concepts/understanding_corporate_actions.md":"\"d41d8cd98f00b204e9800998ecf8427e\"","portfolio/content/concepts/working_with_portfolios.md":"\"520310bbc64c34c82cb3fd9c28321eff\"","portfolio/content/concepts/working_with_positions.md":"\"fa78dc740b9c46b0c2c06e8d810f1a60\"","portfolio/content/concepts/working_with_summaries.md":"\"d41d8cd98f00b204e9800998ecf8427e\"","portfolio/content/concepts/working_with_transactions.md":"\"49f7be257a872ff55c08075ce8c376d0\"","portfolio/content/concepts/working_with_valuations.md":"\"63cd4b5926aae46d91e958d2532a4abd\"","portfolio/content/appendices/data_model_enumerations.md":"\"5180ae3da33e24780eaad020a5443f30\"","portfolio/content/appendices/data_model_structures.md":"\"0fa41f49c618a12c3adb83e496b77763\"","portfolio/content/appendices/demo_applications.md":"\"c26aef709b5c75f0f805f4904e9572a5\"","portfolio/content/appendices/other_services.md":"\"a078a70e4228b093c04329577dd1ad8e\"","portfolio/content/appendices/sample_code.md":"\"e41296a9fbaaab0f7e1355e10dc55493\"","portfolio/content/images/portfolio_ui_web.png":"\"d04afe475e03c1f2121f2a70130e7c42\"","portfolio/content/releases/3.0.0.md":"\"1484919526d7d08694b2ed5afbd84365\"","portfolio/content/releases/3.1.0.md":"\"f28a0be6fbeb32f59ca9ec6c2f9011b4\"","portfolio/content/releases/3.2.0.md":"\"b3b0c996fb4fc094459629a104c24ffb\"","portfolio/content/releases/3.3.0.md":"\"3bbcfedbeb75d5a3206000f85d095a88\"","portfolio/content/releases/3.4.0.md":"\"3a2ad68ebcf001714a163c0b7da74305\"","portfolio/content/releases/3.4.1.md":"\"2dcbc977a354c88cf359ff17b59a4008\"","portfolio/content/releases/4.0.0.md":"\"3e6acdcc34335a3b900a5a1df8b671f1\"","portfolio/content/releases/4.1.0.md":"\"e6f85264ab0ff56d17074c7c0e4d90c5\"","portfolio/content/releases/5.0.1.md":"\"14e442b964a30dab5f1e14edaf9674e9\"","portfolio/content/releases/5.1.0.md":"\"a5a7b4b37328cb60f1cade7ecd779a28\"","portfolio/content/releases/5.1.1.md":"\"4edc2e50d9d8bdd6b5d543f15c1365ea\"","portfolio/content/releases/5.1.2.md":"\"04fc554763d1d664610094d6e2145411\"","portfolio/content/releases/5.2.0.md":"\"08356e1c1d6c068c3aae73876ad941aa\"","portfolio/content/sdk/_sidebar.md":"\"d813bcd5bbfc603368856ca6f71dbee6\"","portfolio/content/sdk/lib-common.md":"\"bd35e956a85e420e62895442fd873d2a\"","portfolio/content/sdk/lib-data.md":"\"1b6feb7043f5f630d2ba744100814a14\"","portfolio/content/sdk/lib-gateway.md":"\"44d4c09ef9020129dfe472061d26359b\"","portfolio/content/sdk/lib-security.md":"\"d8f8c087202e9c2e34e509d5c352c51a\"","portfolio/content/releases/5.3.0.md":"\"7edf2fbbacef8befdeaf589d4fb190ce\""}

package/LICENSE

@@ -0,0 +1,28 @@
+Copyright 2022, Barchart.com, Inc., http://www.barchart.com/
+
+This software consists of voluntary contributions made by many
+individuals. For exact contribution history, see the revision history
+available at https://github.com/barchart/barchart-common-js
+
+The following license applies to all parts of this software.
+
+====
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -2,20 +2,21 @@
 
 [![AWS CodeBuild](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiM0hCbTN3M253WGFUUUpFcnk1RFZOSTdUcUZnOWJxbXltaEMvQ3JrcENZeWI0cFRDWlFidks2VFhNR3lHeHlBUVdOSjk5TDU5MWd1bE1abGtoc3p1NjFrPSIsIml2UGFyYW1ldGVyU3BlYyI6InZMalFMNG9pZ3E1ekxJSEciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)](https://github.com/barchart/portfolio-client-js)
 
-A JavaScript SDK for Barchart's Portfolio System.
+### Overview
 
-### Development
+This **JavaScript SDK** connects your applications to the [**Barchart Portfolio Service**](https://www.barchart.com/solutions/services/digital/portfolio) — a service for building, managing, and tracking performance for investment portfolios.
 
-#### Documentation
+### Documentation
 
-The code is documented with [JSDoc](http://usejsdoc.org/). This will be used as the basis for formal documentation (coming soon).
+Complete documentation for this SDK can be accessed here:
+
+* [https://docs.barchart.com/portfolio/](https://docs.barchart.com/portfolio/)
 
 #### Package Managers
 
-This library has been published as a *private* module to NPM as [@barchart/portfolio-client-js](https://www.npmjs.com/package/@barchart/portfolio-client-js).
+This library has been published as a _public_ package to NPM as [@barchart/portfolio-client-js](https://www.npmjs.com/package/@barchart/portfolio-client-js).
 
 ```shell
-npm login
 npm install @barchart/portfolio-client-js -S
 ```
 

package/lib/common/Configuration.js

@@ -5,6 +5,7 @@ module.exports = (() => {
 	 * Static configuration data.
 	 *
 	 * @public
+	 * @ignore
 	 */
 	class Configuration {
 		constructor() {

package/lib/data/.meta.js

@@ -0,0 +1,285 @@
+const Currency = require('@barchart/common-js/lang/Currency'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
+	Timezones = require('@barchart/common-js/lang/Timezones');
+
+const InstrumentType = require('@barchart/portfolio-api-common/lib/data/InstrumentType'),
+	PositionDirection = require('@barchart/portfolio-api-common/lib/data/PositionDirection'),
+	TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
+
+/**
+ * A meta namespace containing structural contracts of anonymous objects.
+ *
+ * @namespace Schema
+ */
+
+/**
+ * A portfolio.
+ *
+ * @typedef Portfolio
+ * @type Object
+ * @memberOf Schema
+ * @property {String} portfolio - The portfolio identifier (assigned by the backend).
+ * @property {String} user - The identifier for the portfolio's owner (assigned by the backend, based on the authorized user).
+ * @property {String} name - The name of the portfolio.
+ * @property {Timezones} timezone - The timezone of the portfolio.
+ * @property {Schema.PortfolioDefaults} defaults - Default settings for the portfolio.
+ */
+
+/**
+ * An object used to create a new portfolio.
+ *
+ * @typedef PortfolioCreate
+ * @type Object
+ * @memberOf Schema
+ * @property {String} name - The name of the portfolio.
+ * @property {Timezones} timezone - The timezone of the portfolio.
+ * @property {Schema.PortfolioDefaults} defaults - Default settings for the portfolio.
+ */
+
+/**
+ * An object used to update an existing portfolio.
+ *
+ * @typedef PortfolioUpdate
+ * @type Object
+ * @memberOf Schema
+ * @property {String} portfolio - The identifier of the portfolio to update.
+ * @property {String=} name - The updated name of the portfolio, if present.
+ * @property {Timezones=} timezone - The updated timezone for the portfolio, if present.
+ * @property {Schema.PortfolioDefaults=} defaults - The updated default settings for the portfolio, if present.
+ */
+
+/**
+ * An object containing defining default behavior for positions added to the portfolio.
+ *
+ * @typedef PortfolioDefaults
+ * @type Object
+ * @memberOf Schema
+ * @property {Boolean=} cash - Indicates if corresponding cash transactions should be created, when appropriate (e.g. also DEBIT cash when creating a BUY transaction for stock).
+ * @property {Currency=} currency - The default currency for the portfolio, used to determine the basis for reporting.
+ * @property {Boolean=} reinvest - Indicates if dividends should be automatically reinvested.
+ */
+
+/**
+ * A position.
+ *
+ * @typedef Position
+ * @type Object
+ * @memberOf Schema
+ * @property {String} user - The identifier for the position's owner.
+ * @property {String} portfolio - The identifier of the portfolio which contains the position.
+ * @property {Schema.PositionInstrument} instrument - The position's instrument.
+ * @property {String} position - The unique identifier for the position.
+ * @property {Number} transaction - The sequence number of the most recent transaction for the position.
+ * @property {Boolean=} cash - Indicates if corresponding cash transactions should be created, when appropriate (e.g. also DEBIT cash when creating a BUY transaction for stock).
+ * @property {Boolean} reinvest - Indicates if dividends should be automatically reinvested.
+ * @property {Schema.PositionSnapshot} snapshot - Summary and performance information for the position, as of the last transaction.
+ */
+
+/**
+ * An object used to update a position's settings (e.g. dividend re-investment settings). Other changes
+ * to a position (e.g. the size of the position) are affected by executing transactions.
+ *
+ * @typedef PositionUpdate
+ * @type Object
+ * @memberOf Schema
+ * @property {String} portfolio - The identifier of the portfolio containing the position to update.
+ * @property {String} position - The identifier of the position to update.
+ * @property {Boolean=} cash - If present, changes the setting for automatic creation of the cash transactions (based on investment transactions).
+ * @property {Boolean=} reinvest - If present, changes whether future dividends are re-invested.
+ */
+
+/**
+ * A position's instrument.
+ *
+ * @typedef PositionInstrument
+ * @type Object
+ * @memberOf Schema
+ * @property {String} id - The instrument's unique identifier.
+ * @property {String} name - The instrument's name (e.g. Apple Inc).
+ * @property {InstrumentType} type - The instrument's type (e.g. EQUITY).
+ * @property {Currency} currency - The currency used to trade (or value) the instrument (e.g. USD).
+ * @property {Schema.Symbols} symbol - The symbol(s) used for the instrument.
+ */
+
+/**
+ * A summary of the status of a position on a given date.
+ *
+ * @typedef PositionSnapshot
+ * @type Object
+ * @memberOf Schema
+ * @property {Day} date - The date of the snapshot.
+ * @property {Decimal} open - The number of shares (units) open (value may be negative).
+ * @property {PositionDirection} direction - Qualifies the number of open shares as LONG (i.e. positive), short (i.e. negative), or EVEN (i.e. zero).
+ * @property {Decimal} buys - The sum of all purchases in the currency of the underlying instrument (value is never negative).
+ * @property {Decimal} sells - The sum of all sales in the currency of the underlying instrument (value is never negative).
+ * @property {Decimal} gain - The _realized_ gain on the position (value may be negative).
+ * @property {Decimal} basis - The amount invested in the remaining position (value may be negative).
+ * @property {Decimal} income - The sum of all income (e.g. dividends) earned on the position (value may be negative).
+ * @property {Decimal} value - The current value of the position (value may be negative). Valuation is based on the last transaction price (not the current market price).
+ */
+
+/**
+ * @typedef PositionSummary
+ * @type Object
+ * @memberOf Schema
+ */
+
+/**
+ * A transaction.
+ *
+ * @typedef Transaction
+ * @type Object
+ * @memberOf Schema
+ * @property {String} portfolio - The identifier of the portfolio which contains the transaction (a UUID).
+ * @property {String} position - The identifier of the position which contains the transaction (a UUID).
+ * @property {String} transaction - The identifier of the transaction (a UUID).
+ * @property {String} sequence - The sequence number of the transaction (with respect to other transactions for the same position, starts with one).
+ * @property {TransactionType} type - The type of transaction (e.g. BUY, SELL, SELL_SHORT, etc).
+ * @property {Day} date - The day the transaction occurs. Time of day is not specified. Refer to the "sequence" property for ordering within the same day.
+ * @property {String=} description - Autogenerated text describing the transaction (used for cash positions).
+ * @property {Decimal} amount - The amount of currency affected by the transaction. In cases where currency was paid, the value is negative. In cases where currency was received, the value is positive.
+ * @property {Decimal} quantity - The number of shares (or units) of the position's instrument affected by the transaction. The value will be positive when purchasing and negative when selling.
+ * @property {Decimal=} fee - The number of shares or units of the position's instrument affected by the transaction. The value will be positive when purchasing and negative when selling.
+ * @property {Schema.TransactionReference=} reference - A reference to another transaction — a transaction which caused this transaction to occur.
+ * @property {Schema.PositionSnapshot} snapshot - A summary of the position size and performance, immediately after this transaction was executed.
+ * @property {Schema.TransactionExtensionForTrade=} trade - Additional information, only present if transaction is a trade (type is B, S, SS, etc).
+ * @property {Schema.TransactionExtensionForDividend=} dividend - Additional information, only present if transaction is a dividend (type is DV, DX, DF, DY, etc).
+ * @property {Schema.TransactionExtensionForSplit=} split - Additional information, only present if transaction is a split (type is SP).
+ */
+
+/**
+ * A reference to a related, automatically-generated transaction. For example, assume we execute
+ * a transaction to BUY stock. If the stock position is configured to automatically create cash
+ * transactions, then a DEBIT transaction to a cash position is also executed (to pay for the stock
+ * purchase). In this case, the DEBIT transaction will reference the BUY transaction.
+ *
+ * @typedef TransactionReference
+ * @type Object
+ * @memberOf Schema
+ * @property {String} position - The identifier of the referenced position.
+ * @property {String} transaction - The identifier of the referenced transaction.
+ */
+
+/**
+ * Information, extending a {@link Schema.Transaction}, where the transaction's type is a trade.
+ *
+ * @typedef TransactionExtensionForTrade
+ * @type Object
+ * @memberOf Schema
+ * @property {Decimal} price - The unit price the transaction was executed at.
+ */
+
+/**
+ * Information, extending a {@link Schema.Transaction}, where the transaction's type is a
+ * dividend (or a distribution).
+ *
+ * @typedef TransactionExtensionForDividend
+ * @type Object
+ * @memberOf Schema
+ * @property {Decimal} rate - The amount paid per unit.
+ * @property {Day} effective - The day used to determine the quantity eligible to receive the dividend (i.e. the dividend ex-date).
+ * @property {Decimal=} price - The market value of the underlying at the time the dividend was paid (used to calculate reinvestment quantities).
+ * @property {Decimal} amount - The currency amount of the dividend (e.g the rate multiplied by the quantity eligible to receive the dividend).
+ */
+
+/**
+ * Information, extending a {@link Schema.Transaction}, where the transaction's type is a split.
+ *
+ * @typedef TransactionExtensionForSplit
+ * @type Object
+ * @memberOf Schema
+ * @property {Decimal} numerator - The numerator in the following fraction: [ shares owned after dividend ] / [ shares owned before dividend ].
+ * @property {Decimal} numerator - The denominator in the following fraction: [ shares owned after dividend ] / [ shares owned before dividend ].
+ * @property {Day} effective - The day used to determine the quantity eligible to be split (i.e. the split ex-date).
+ */
+
+/**
+ * Data required to create a new transaction. Essentially a subset of the _Transaction_ schema (although,
+ * instrument metadata is added for transactions which open new positions).
+ *
+ * @typedef TransactionCreate
+ * @type Object
+ * @memberOf Schema
+ * @property {String} portfolio - The identifier of the portfolio which will contain the transaction (a UUID).
+ * @property {String} position - The identifier of the position to add the transaction to (use "new" for new positions).
+ * @property {TransactionType} type - The type of transaction (e.g. BUY, SELL, SELL_SHORT, etc).
+ * @property {Schema.TransactionCreateInstrument} instrument - Information about the instrument (required when opening a new position, ignored otherwise).
+ * @property {Day} date - The day the transaction occurs.
+ * @property {Decimal=} price - The unit price of the instrument at the time the transaction executes.
+ * @property {Decimal} quantity - The number of units affected by the transaction (can be an integer or decimal value).
+ * @property {Decimal=} fee - A fee paid to execute the transaction (can be zero).
+ */
+
+/**
+ * Data required to identify the instrument for a new transaction.
+ *
+ * @typedef TransactionCreateInstrument
+ * @type Object
+ * @memberOf Schema
+ * @property {Schema.Symbols} symbol - The symbol(s) used to identify an instrument.
+ * @property {String=} name - The name of the instrument.
+ * @property {String=} type - The code of the asset class. See the InstrumentAssetClass enumeration in the @barchart/portfolio-api-common library.
+ * @property {Number=} code - The numeric code of the asset class. See the InstrumentAssetClass enumeration in the @barchart/portfolio-api-common library.
+ * @property {String=} exchange - The code of the listing exchange.
+ * @property {Currency=} currency - The currency the instrument is transacted in.
+ */
+
+/**
+ * The result of transaction create, update, or delete operation. This object lists the positions
+ * that were changed (as a result of the operation) and includes updated {@link Schema.PositionSummary}
+ * objects.
+ *
+ * @typedef TransactionMutateResult
+ * @type Object
+ * @memberOf Schema
+ * @property {Object} positions
+ * @property {Schema.Position[]} positions.saved - All positions which were created or updated.
+ * @property {Schema.Position[]} positions.deleted - All positions which were deleted.
+ * @property {Schema.PositionSummary[]} summaries - All position summaries created or updated.
+ * @property {Boolean} replaced - If true, the position (and position summaries) need to be replaced.
+ */
+
+/**
+ * The symbols (i.e. codes) used to identify an instrument (e.g. "AAPL" for Apple Inc).
+ *
+ * @typedef Symbols
+ * @type Object
+ * @memberOf Schema
+ * @property {String} barchart - The symbol used by Barchart (required to lookup quotes and determine prices).
+ * @property {String} display - The symbol used for display purposes (often the same as the Barchart symbol).
+ */
+
+/**
+ * An ordered list of end-of-day valuations (for an individual position or an entire portfolio),
+ * along with metadata regarding the valuations (e.g. portfolio, position, currency).
+ *
+ * @typedef ValuationContainer
+ * @type Object
+ * @memberOf Schema
+ * @property {String} user - The identifier for the portfolio's owner.
+ * @property {String} portfolio - The identifier for the portfolio.
+ * @property {String} position - The identifier for the position being valued. If this value is an asterisk (```*```), then valuation refers to the entire portfolio.
+ * @property {Currency=} currency - The currency of the valuations (absent when no valuations are returned).
+ * @property {Array<Schema.Valuation>} valuations - The end-of-day valuations.
+ */
+
+/**
+ * The valuation of a position (or portfolio) on a given day.
+ *
+ * @typedef Valuation
+ * @type Object
+ * @memberOf Schema
+ * @property {Day} date - The date of the valuation.
+ * @property {Number} market - The market value of the position (or portfolio).
+ */
+
+/**
+ * The result of valuations availability.
+ *
+ * @ignore
+ * @typedef ValuationsAvailabilityResult
+ * @type {Object}
+ * @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.
+ */

package/lib/gateway/PortfolioGateway.js

@@ -32,6 +32,7 @@ const Configuration = require('./../common/Configuration'),
 module.exports = (() => {
 	'use strict';
 
+	const REST_API_VERSION = 'v1';
 	const REST_API_SECURE_PROTOCOL = 'https';
 	const REST_API_SECURE_PORT = 443;
 
@@ -40,7 +41,7 @@ module.exports = (() => {
 	 * Portfolio Service. It can be used to query, edit, and delete portfolios.
 	 *
 	 * @public
-	 * @param {String} protocol - The protocol of the of the Portfolio web service (either http or https).
+	 * @param {String} protocol - The protocol of the Portfolio web service (either http or https).
 	 * @param {String} host - The hostname of the Portfolio web service.
 	 * @param {Number} port - The TCP port number of the Portfolio web service.
 	 * @param {String} environment - A description of the environment we're connecting to.
@@ -89,7 +90,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
@@ -105,7 +106,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios');
 				})
 				.withBody('portfolio')
@@ -122,7 +123,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
@@ -140,7 +141,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 				})
@@ -154,7 +155,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -177,7 +178,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -196,7 +197,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -214,7 +215,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('summaries', 'summaries')
@@ -237,7 +238,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('values', 'values')
@@ -255,7 +256,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -274,7 +275,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('values', 'values');
 				})
 				.withQueryBuilder((qb) => {
@@ -291,7 +292,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -311,17 +312,20 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
-						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
+						.withVariableParameter('portfolio', 'portfolio', 'transaction.portfolio', false)
 						.withLiteralParameter('positions', 'positions')
-						.withVariableParameter('position', 'position', 'position', false)
+						.withVariableParameter('position', 'position', 'transaction.position', false)
 						.withLiteralParameter('transactions', 'transactions');
 				})
 				.withQueryBuilder((qb) => {
-					qb.withVariableParameter('type', 'type', 'type', false, x => x.code);
+					qb.withVariableParameter('type', 'type', 'transaction.type', false, x => x.code)
+						.withVariableParameter('suppressCorporateActions', 'suppressCorporateActions', 'options.suppressCorporateActions', true, x => is.boolean(x) && x ? 'true' : x);
+				})
+				.withBodyBuilder((bb) => {
+					bb.withVariableParameter('body', 'body', 'transaction', false);
 				})
-				.withBody('transaction')
 				.withRequestInterceptor(requestInterceptor)
 				.withResponseInterceptor(responseInterceptorForPositionMutateDeserialization)
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
@@ -333,7 +337,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -356,7 +360,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -379,7 +383,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -403,7 +407,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('positions', 'positions')
@@ -429,7 +433,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('wealthscope', 'wealthscope')
@@ -447,7 +451,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('portfolios', 'portfolios')
 						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
 						.withLiteralParameter('reports', 'reports')
@@ -469,7 +473,7 @@ module.exports = (() => {
 				.withHost(host)
 				.withPort(port)
 				.withPathBuilder((pb) => {
-					pb.withLiteralParameter('version', 'v1')
+					pb.withLiteralParameter('version', REST_API_VERSION)
 						.withLiteralParameter('system', 'system')
 						.withLiteralParameter('version', 'version');
 				})
@@ -531,104 +535,127 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Reads all portfolios for a user, or a single portfolio.
+		 * Creates a new portfolio for the current user.
 		 *
 		 * @public
-		 * @param {String=} portfolio
-		 * @returns {Promise<Portfolio[]>}
+		 * @param {Schema.PortfolioCreate} portfolio - Data regarding the portfolio to create.
+		 * @returns {Promise<Schema.Portfolio>}
 		 */
-		readPortfolios(portfolio) {
+		createPortfolio(portfolio) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
-					assert.argumentIsOptional(portfolio, 'portfolio', String);
+					assert.argumentIsRequired(portfolio, 'portfolio', Object);
 
-					return Gateway.invoke(this._readPortfoliosEndpoint, { portfolio: portfolio || '*' });
+					return Gateway.invoke(this._createPortfolioEndpoint, PortfolioSchema.CREATE.schema.format(portfolio));
 				});
 		}
 
 		/**
-		 * Creates a portfolio.
+		 * Updates a portfolio.
 		 *
 		 * @public
-		 * @param {Object} portfolio
-		 * @returns {Promise<Portfolio>}
+		 * @param {Schema.PortfolioUpdate} portfolio
+		 * @returns {Promise<Schema.Portfolio>}
 		 */
-		createPortfolio(portfolio) {
+		updatePortfolio(portfolio) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', Object);
 
-					return Gateway.invoke(this._createPortfolioEndpoint, PortfolioSchema.CREATE.schema.format(portfolio));
+					return Gateway.invoke(this._updatePortfolioEndpoint, PortfolioSchema.UPDATE.schema.format(portfolio));
 				});
 		}
 
 		/**
-		 * Creates a new portfolio and immediately populates it with transactions.
+		 * Deletes a portfolio. All data associated with the portfolio will also be
+		 * deleted (e.g. positions, transactions, etc).
 		 *
 		 * @public
-		 * @param {Object} portfolio
-		 * @returns {Promise<Portfolio>}
+		 * @param {String} portfolio - The identifier of the portfolio to delete.
+		 * @returns {Promise}
 		 */
-		importPortfolio(portfolio, transactions) {
+		deletePortfolio(portfolio) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
-					return this.createPortfolio(portfolio)
-						.then((portfolio) => {
-							return this.batchTransactions(portfolio, transactions);
-						});
+					assert.argumentIsRequired(portfolio, 'portfolio', String);
+
+					return Gateway.invoke(this._deletePortfolioEndpoint, { portfolio: portfolio });
 				});
 		}
 
 		/**
-		 * Updates a portfolio.
+		 * Reads all portfolios (or a single portfolio) for the current user.
 		 *
 		 * @public
-		 * @param {Object} portfolio
-		 * @returns {Promise<Portfolio>}
+		 * @param {String=} portfolio - A portfolio identifier. If omitted, all portfolios for the current user will be returned.
+		 * @returns {Promise<Schema.Portfolio[]>}
 		 */
-		updatePortfolio(portfolio) {
+		readPortfolios(portfolio) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
-					assert.argumentIsRequired(portfolio, 'portfolio', Object);
+					assert.argumentIsOptional(portfolio, 'portfolio', String);
 
-					return Gateway.invoke(this._updatePortfolioEndpoint, PortfolioSchema.UPDATE.schema.format(portfolio));
+					return Gateway.invoke(this._readPortfoliosEndpoint, { portfolio: portfolio || '*' });
 				});
 		}
 
 		/**
-		 * Deletes a portfolio.
+		 * Updates a position.
 		 *
 		 * @public
-		 * @param {String} portfolio - ID of the portfolio to update
-		 * @returns {Promise<Portfolio>}
+		 * @param {Schema.PositionUpdate} position
+		 * @returns {Promise<Schema.Position>}
 		 */
-		deletePortfolio(portfolio) {
+		updatePosition(position) {
+			return Promise.resolve()
+				.then(() => {
+					checkStart.call(this);
+
+					assert.argumentIsRequired(position, 'position', Object);
+
+					return Gateway.invoke(this._updatePositionEndpoint, PositionSchema.UPDATE.schema.format(position));
+				});
+		}
+
+		/**
+		 * Deletes a position (and all associated data, including transactions and summaries).
+		 * An array of deleted  positions is returned (in some rare cases, deleting one position
+		 * may cause other positions to be be deleted — for example, a position which was spun-off).
+		 *
+		 * @public
+		 * @param {String} portfolio - The identifier of the portfolio which contains the position to delete.
+		 * @param {String} position - The identifier of the position to delete.
+		 * @returns {Promise<Schema.Position[]>}
+		 */
+		deletePosition(portfolio, position) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
+					assert.argumentIsRequired(position, 'position', String);
 
-					return Gateway.invoke(this._deletePortfolioEndpoint, { portfolio: portfolio });
+					return Gateway.invoke(this._deletePositionEndpoint, { portfolio: portfolio, position: position });
 				});
 		}
 
+
 		/**
 		 * Retrieves all positions for a user, a user's portfolio, or a single position.
 		 *
 		 * @public
-		 * @param {String=} portfolio
-		 * @param {String=} position
+		 * @param {String=} portfolio - The identifier of the portfolio containing the desired positions. If omitted, all positions for the current user, regardless of portfolio, will be returned.
+		 * @param {String=} position - The identifier of the specific position to read. If included, the "portfolio" parameter must be specified.
 		 * @param {Boolean=} includePreviousPrice
-		 * @returns {Promise<Position[]>}
+		 * @returns {Promise<Schema.Position[]>}
 		 */
 		readPositions(portfolio, position, includePreviousPrice) {
 			return Promise.resolve()
@@ -639,7 +666,7 @@ module.exports = (() => {
 					assert.argumentIsOptional(position, 'position', String);
 					assert.argumentIsOptional(includePreviousPrice, 'includePreviousPrice', Boolean);
 
-					return Gateway.invoke(this._readPositionsEndpoint, { portfolio: portfolio || '*', position: position || '*', includePreviousPrice: includePreviousPrice });
+					return Gateway.invoke(this._readPositionsEndpoint, { portfolio: portfolio || '*', position: position || '*', includePreviousPrice: includePreviousPrice || false });
 				});
 		}
 
@@ -647,10 +674,11 @@ module.exports = (() => {
 		 * Queries positions.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} symbol
 		 * @param {Boolean=} open
 		 * @param {PositionSchema=} schema
-		 * @returns {Promise<Position[]>}
+		 * @returns {Promise<Schema.Position[]>}
 		 */
 		queryPositionsForSymbol(symbol, open, schema) {
 			return Promise.resolve()
@@ -675,29 +703,12 @@ module.exports = (() => {
 				});
 		}
 
-		/**
-		 * Updates a position.
-		 *
-		 * @public
-		 * @param {Object} position
-		 * @returns {Promise<Position>}
-		 */
-		updatePosition(position) {
-			return Promise.resolve()
-				.then(() => {
-					checkStart.call(this);
-
-					assert.argumentIsRequired(position, 'position', Object);
-
-					return Gateway.invoke(this._updatePositionEndpoint, PositionSchema.UPDATE.schema.format(position));
-				});
-		}
-
 		/**
 		 * Returns a promise which resolves as soon as the position's lock status
 		 * changes to false.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} portfolio
 		 * @param {String} position
 		 * @returns {Promise}
@@ -733,15 +744,16 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Retrieves positions for a user, a user's portfolio, or a single position.
+		 * Retrieves summaries for a user, a user's portfolio, or a single position.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String=} portfolio
 		 * @param {String=} position
 		 * @param {Array<PositionSummaryFrame>=|Array<String>=} frames
 		 * @param {Number=} periods
 		 * @param {Day=|String=} start
-		 * @returns {Promise<Position[]>}
+		 * @returns {Promise<Schema.Position[]>}
 		 */
 		readPositionSummaries(portfolio, position, frames, periods, start) {
 			return Promise.resolve()
@@ -804,49 +816,63 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Retrieves values availability of the portfolio and it's positions.
+		 * Retrieves end-of-day valuations for the entire portfolio (or a single position).
 		 *
 		 * @public
-		 * @param {String} portfolio
-		 * @return {Promise<ValuationsAvailabilityResult>}
+		 * @ignore
+		 * @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>}
 		 */
-		readPositionValuationsAvailability(portfolio) {
+		readPositionValuations(portfolio, position, parse) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
+					assert.argumentIsOptional(position, 'position', String);
 
 					const payload = { };
 
 					payload.portfolio = portfolio;
+					payload.position = position || '*';
 
-					return Gateway.invoke(this._readPositionValuationsAvailabilityEndpoint, payload);
+					return Gateway.invoke(this._readPositionValuationsEndpoint, payload)
+						.then((json) => {
+							let result;
+
+							if (parse) {
+								result = JSON.parse(json);
+							} else {
+								result = json;
+							}
+
+							return result;
+						});
 				});
 		}
 
 		/**
-		 * Retrieves end-of-day position valuations for the entire portfolio or single position.
+		 * Retrieves values availability of the portfolio and it's positions.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} portfolio
-		 * @param {String=} position
-		 * @returns {Promise<Object[]>}
+		 * @return {Promise<Schema.ValuationsAvailabilityResult>}
 		 */
-		readPositionValuations(portfolio, position) {
+		readPositionValuationsAvailability(portfolio) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
-					assert.argumentIsOptional(position, 'position', String);
 
 					const payload = { };
 
 					payload.portfolio = portfolio;
-					payload.position = position || '*';
 
-					return Gateway.invoke(this._readPositionValuationsEndpoint, payload);
+					return Gateway.invoke(this._readPositionValuationsAvailabilityEndpoint, payload);
 				});
 		}
 
@@ -854,6 +880,7 @@ module.exports = (() => {
 		 * Queries end-of-day position valuations across all user portfolios.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} symbol
 		 * @return {Promise<Object[]>}
 		 */
@@ -866,34 +893,15 @@ module.exports = (() => {
 				});
 		}
 
-		/**
-		 * Deletes a position.
-		 *
-		 * @public
-		 * @param {String} portfolio
-		 * @param {String} position
-		 * @returns {Promise<Position[]>}
-		 */
-		deletePosition(portfolio, position) {
-			return Promise.resolve()
-				.then(() => {
-					checkStart.call(this);
-
-					assert.argumentIsRequired(portfolio, 'portfolio', String);
-					assert.argumentIsRequired(position, 'position', String);
-
-					return Gateway.invoke(this._deletePositionEndpoint, { portfolio: portfolio, position: position });
-				});
-		}
-
 		/**
 		 * Creates a new transaction.
 		 *
 		 * @public
-		 * @param {Object} transaction
-		 * @returns {Promise<TransactionMutateResult>}
+		 * @param {Schema.TransactionCreate} transaction
+		 * @param {Object} options
+		 * @returns {Promise<Schema.TransactionMutateResult>}
 		 */
-		createTransaction(transaction) {
+		createTransaction(transaction, options) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
@@ -901,6 +909,7 @@ module.exports = (() => {
 					assert.argumentIsRequired(transaction, 'transaction', Object);
 					assert.argumentIsRequired(transaction.portfolio, 'transaction.portfolio', String);
 					assert.argumentIsOptional(transaction.position, 'transaction.position', String);
+					assert.argumentIsOptional(options, 'options', Object);
 
 					if (!transaction.position) {
 						transaction.position = 'new';
@@ -908,16 +917,21 @@ module.exports = (() => {
 
 					const schema = getTransactionSchema(transaction);
 
-					return Gateway.invoke(this._createTransactionEndpoint, schema.schema.format(transaction));
+					const payload = { };
+
+					payload.transaction = schema.schema.format(transaction);
+					payload.options = options || { };
+
+					return Gateway.invoke(this._createTransactionEndpoint, payload);
 				});
 		}
 
 		/**
-		 * Edits a transaction.
+		 * Edits a transaction (e.g. change the date, price, quantity, etc).
 		 *
 		 * @public
-		 * @param {Object} transaction
-		 * @returns {Promise<TransactionMutateResult>}
+		 * @param {Schema.Transaction} transaction
+		 * @returns {Promise<Schema.TransactionMutateResult>}
 		 */
 		editTransaction(transaction) {
 			return Promise.resolve()
@@ -939,9 +953,10 @@ module.exports = (() => {
 		 * Switch the reinvestment strategy for a single transaction.
 		 *
 		 * @public
-		 * @param {Object} transaction
+		 * @ignore
+		 * @param {Schema.Transaction} transaction
 		 * @param {TransactionType} type
-		 * @returns {Promise<TransactionMutateResult>}
+		 * @returns {Promise<Schema.TransactionMutateResult>}
 		 */
 		switchTransaction(transaction, type) {
 			return Promise.resolve()
@@ -967,13 +982,13 @@ module.exports = (() => {
 		 * Deletes a transaction.
 		 *
 		 * @public
-		 * @param {String} portfolio
-		 * @param {String} position
-		 * @param {Number} sequence
+		 * @param {String} portfolio - The identifier of the portfolio which contains the targeted position.
+		 * @param {String} position - The identifier of the targeted position.
+		 * @param {Number} sequence - The sequence number of the transaction to delete.
 		 * @param {Boolean=} force
 		 * @param {Day=} echoStart
 		 * @param {Day=} echoEnd
-		 * @returns {Promise<TransactionMutateResult>}
+		 * @returns {Promise<Schema.TransactionMutateResult>}
 		 */
 		deleteTransaction(portfolio, position, sequence, force, echoStart, echoEnd) {
 			return Promise.resolve()
@@ -1010,10 +1025,10 @@ module.exports = (() => {
 		 * Retrieves transactions for a portfolio, or a single position.
 		 *
 		 * @public
-		 * @param {String} portfolio
-		 * @param {String=} position
-		 * @param {Number=} sequence
-		 * @returns {Promise<Transaction[]>}
+		 * @param {String} portfolio - The identifier of the portfolio containing the desired transactions.
+		 * @param {String=} position - The identifier for the position to read transactions for. If included, the resulting transactions will be limited to the specified position. Otherwise, transactions for all positions in the portfolio, will be returned.
+		 * @param {Number=} sequence - The sequence number of the specific transaction to read. If included, both the "portfolio" and "position" parameters must be specified.
+		 * @returns {Promise<Schema.Transaction[]>}
 		 */
 		readTransactions(portfolio, position, sequence) {
 			return Promise.resolve()
@@ -1033,6 +1048,7 @@ module.exports = (() => {
 		 * for a portfolio, or a single position.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} portfolio
 		 * @param {String=} position
 		 * @param {Day=} startDay
@@ -1074,6 +1090,7 @@ module.exports = (() => {
 		 * Reads a single page of formatted transactions.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} portfolio
 		 * @param {String} position
 		 * @param {Number=} sequence
@@ -1113,10 +1130,35 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Retrieves end-of-day valuations for the entire portfolio (or a single position).
+		 *
+		 * @public
+		 * @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).
+		 * @returns {Promise<Schema.ValuationContainer>}
+		 */
+		readValuations(portfolio, position) {
+			return this.readPositionValuations(portfolio, position, true);
+		}
+
+		/**
+		 * Retrieves the status of end-of-day valuations for all positions contained
+		 * within a portfolio.
+		 *
+		 * @public
+		 * @param {String} portfolio - The identifier of the portfolio.
+		 * @returns {Promise<Schema.ValuationsAvailabilityResult>}
+		 */
+		checkValuations(portfolio) {
+			return this.readPositionValuationsAvailability(portfolio);
+		}
+
 		/**
 		 * Reads a wealthscope token for a specific portfolio.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} portfolio
 		 * @return {Promise<String>}
 		 */
@@ -1139,6 +1181,7 @@ module.exports = (() => {
 		 * Returns all position summary definitions for a portfolio.
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} portfolio
 		 */
 		readBrokerageReportAvailability(portfolio) {
@@ -1158,6 +1201,7 @@ module.exports = (() => {
 		 * Generates a URL suitable for downloading a brokerage report (as a PDF).
 		 *
 		 * @public
+		 * @ignore
 		 * @param {String} user
 		 * @param {String} portfolio
 		 * @param {PositionSummaryFrame} frame
@@ -1179,21 +1223,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Queries existing positions for a specific symbol.
-		 *
-		 * @public
-		 * @param {String} symbol
-		 * @returns {Promise<Array>}
-		 */
-		querySymbol(symbol) {
-			return Promise.resolve()
-				.then(() => {
-					return [ ];
-				});
-		}
-
-		/**
-		 * Returns current API version of portfolio.
+		 * Returns current version of the Portfolio Service.
 		 *
 		 * @public
 		 * @returns {Promise<Object>}
@@ -1228,6 +1258,7 @@ module.exports = (() => {
 		 * Creates and starts a new {@link PortfolioGateway} for use in the private development environment.
 		 *
 		 * @public
+		 * @ignore
 		 * @static
 		 * @param {JwtProvider} jwtProvider
 		 * @param {String=} product
@@ -1247,6 +1278,7 @@ module.exports = (() => {
 		 * Creates and starts a new {@link PortfolioGateway} for use in the private staging environment.
 		 *
 		 * @public
+		 * @ignore
 		 * @static
 		 * @param {JwtProvider} jwtProvider
 		 * @param {String=} product
@@ -1263,7 +1295,7 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Creates and starts a new {@link PortfolioGateway} for use in the private demo environment.
+		 * Creates and starts a new {@link PortfolioGateway} for use in the public demo environment.
 		 *
 		 * @public
 		 * @static
@@ -1304,6 +1336,7 @@ module.exports = (() => {
 		 * Creates and starts a new {@link PortfolioGateway} for use in the private admin environment.
 		 *
 		 * @public
+		 * @ignore
 		 * @static
 		 * @param {JwtProvider} jwtProvider
 		 * @param {String=} product
@@ -1503,24 +1536,5 @@ module.exports = (() => {
 		return returnRef;
 	}
 
-	/**
-	 * The result of transaction create operation.
-	 *
-	 * @typedef TransactionMutateResult
-	 * @type {Object}
-	 * @property {Object[]} positions - All positions updated as a consequence of processing the transaction.
-	 * @property {Object[]} summaries - All position summaries updated as a consequence of processing the transaction.
-	 * @property {Boolean} replaced - If true, the position (and position summaries) need to be replaced.
-	 */
-
-	/**
-	 * The result of valuations availability.
-	 *
-	 * @typedef ValuationsAvailabilityResult
-	 * @type {Object}
-	 * @property {Boolean} available - If true, portfolio valuations are up-to-date and ready.
-	 * @property {String[]} positions - Array of position id's that are in recalculation state.
-	 */
-
  	return PortfolioGateway;
 })();

package/lib/index.js

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

package/lib/security/.meta.js

@@ -5,7 +5,7 @@
  */
 
 /**
- * A function which returns a signed token.
+ * A function, accepting no arguments, which returns a signed token.
  *
  * @public
  * @callback JwtTokenGenerator

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "5.1.2",
-  "description": "JavaScript library for interfacing with Barchart's Portfolio API",
+  "version": "5.3.0",
+  "description": "JavaScript SDK for Barchart's Portfolio Service",
+  "homepage": "https://docs.barchart.com/portfolio/#/",
   "author": {
     "name": "Bryan Ingle",
     "email": "bryan.ingle@barchart.com",
@@ -12,12 +13,18 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/barchart/barchart/portfolio-client-js.git"
+    "url": "git+ssh://git@github.com/barchart/portfolio-client-js.git"
+  },
+  "directories": {
+    "test": "test"
+  },
+  "bugs": {
+    "url": "https://github.com/barchart/portfolio-client-js/issues"
   },
   "keywords": [
     "Barchart",
+    "Portfolio",
     "JavaScript",
-    "Client",
     "SDK"
   ],
   "dependencies": {
@@ -31,11 +38,13 @@
     "git-get-status": "^1.0.5",
     "glob": "^6.0.1",
     "gulp": "^4.0.2",
+    "gulp-awspublish": "^4.1.2",
     "gulp-git": "^2.9.0",
     "gulp-jasmine": "^2.2.1",
     "gulp-jsdoc3": "^1.0.1",
     "gulp-jshint": "~2.1.0",
     "gulp-prompt": "^1.2.0",
+    "gulp-rename": "^1.4.0",
     "gulp-replace": "^0.5.4",
     "jshint": "^2.12.0",
     "vinyl-buffer": "^1.0.1",
@@ -48,12 +57,5 @@
       ]
     ]
   },
-  "license": "UNLICENSED",
-  "bugs": {
-    "url": "https://github.com/barchart/portfolio-client-js/issues"
-  },
-  "homepage": "https://github.com/barchart/portfolio-client-js#readme",
-  "directories": {
-    "test": "test"
-  }
+  "license": "MIT"
 }