@barchart/portfolio-client-js 1.1.11 → 1.1.12

package/example/example.html

@@ -49,8 +49,6 @@
 					.then((data) => {
 						writeConsoleText(action, true);
 						writeConsoleObject(data);
-
-						debugger;
 					}).catch((e) => {
                         writeConsoleText(action, true);
                         writeConsoleObject(e);
@@ -63,15 +61,15 @@
 
 				var portfolio = {
 					name: `Random ${Math.random()}`,
-					timezone: 'America/New_York',
+					timezone: Barchart.Timezones.AMERICA_NEW_YORK,
 					dates: {
 						create: Barchart.Day.getToday(),
 						cash: Barchart.Day.getToday()
 					},
 					defaults: {
-						currency: 'CAD',
+						currency: Barchart.Currency.CAD,
 						reinvest: true,
-						valuation: 'AVG'
+						valuation: Barchart.ValuationType.AVERAGE_COST
 					},
 					miscellany: {
 						testing: {
@@ -154,6 +152,20 @@
                         writeConsoleText(action, true);
                         writeConsoleObject(e);
 
+                        that.setConsoleMode();
+                    });
+			};
+			var readPositionSummaries = function() {
+				var action = 'portfolioGateway.readPositionSummaries()';
+
+				that.gateway.readPositionSummaries(that.portfolio() || null, that.position() || null)
+					.then((data) => {
+						writeConsoleText(action, true);
+						writeConsoleObject(data);
+					}).catch((e) => {
+                        writeConsoleText(action, true);
+                        writeConsoleObject(e);
+
                         that.setConsoleMode();
                     });
 			};
@@ -300,6 +312,7 @@
                 { text: 'Update Portfolio', action: updatePortfolio },
                 { text: 'Delete Portfolio', action: deletePortfolio },
                 { text: 'Get Positions', action: getPositions },
+                { text: 'Get Positions Summaries', action: readPositionSummaries },
                 { text: 'Delete Position', action: deletePosition },
                 { text: 'Get Transactions', action: getTransactions },
                 { text: 'Get Transactions (Formatted)', action: getTransactionsFormatted },

package/example/example.js

@@ -5,9 +5,11 @@ var JwtGateway = require('@barchart/tgam-jwt-js/lib/JwtGateway');
 
 var Currency = require('@barchart/common-js/lang/Currency'),
     Day = require('@barchart/common-js/lang/Day'),
-    Decimal = require('@barchart/common-js/lang/Decimal');
+    Decimal = require('@barchart/common-js/lang/Decimal'),
+    Timezones = require('@barchart/common-js/lang/Timezones');
 
-var TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
+var TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType'),
+    ValuationType = require('@barchart/portfolio-api-common/lib/data/ValuationType');
 
 module.exports = function () {
 	'use strict';
@@ -19,10 +21,12 @@ module.exports = function () {
 	window.Barchart.Currency = Currency;
 	window.Barchart.Day = Day;
 	window.Barchart.Decimal = Decimal;
+	window.Barchart.Timezones = Timezones;
 	window.Barchart.TransactionType = TransactionType;
+	window.Barchart.ValuationType = ValuationType;
 }();
 
-},{"@barchart/common-js/lang/Currency":28,"@barchart/common-js/lang/Day":29,"@barchart/common-js/lang/Decimal":30,"@barchart/portfolio-api-common/lib/data/TransactionType":51,"@barchart/tgam-jwt-js/lib/JwtGateway":55}],2:[function(require,module,exports){
+},{"@barchart/common-js/lang/Currency":28,"@barchart/common-js/lang/Day":29,"@barchart/common-js/lang/Decimal":30,"@barchart/common-js/lang/Timezones":35,"@barchart/portfolio-api-common/lib/data/TransactionType":51,"@barchart/portfolio-api-common/lib/data/ValuationType":52,"@barchart/tgam-jwt-js/lib/JwtGateway":55}],2:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -114,6 +118,8 @@ var assert = require('@barchart/common-js/lang/assert'),
     Enum = require('@barchart/common-js/lang/Enum'),
     is = require('@barchart/common-js/lang/is');
 
+var TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
+
 var PortfolioSchema = require('@barchart/portfolio-api-common/lib/serialization/PortfolioSchema'),
     TransactionSchema = require('@barchart/portfolio-api-common/lib/serialization/TransactionSchema');
 
@@ -175,7 +181,7 @@ module.exports = function () {
 				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 			}).withBody('portfolio').withRequestInterceptor(RequestInterceptor.fromDelegate(updatePortfolioRequestInterceptor)).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPortfolioDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
-			_this._deletePortfoliosEndpoint = EndpointBuilder.for('delete-portfolio', 'delete portfolios').withVerb(VerbType.DELETE).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
+			_this._deletePortfolioEndpoint = EndpointBuilder.for('delete-portfolio', 'delete portfolios').withVerb(VerbType.DELETE).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
 				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false);
 			}).withRequestInterceptor(requestInterceptorToUse).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
@@ -183,6 +189,14 @@ module.exports = function () {
 				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
 			}).withRequestInterceptor(requestInterceptorToUse).withResponseInterceptor(responseInterceptorForPositionDeserialization).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
 
+			_this._readPositionSummariesEndpoint = EndpointBuilder.for('read-position-summaries', 'read position summaries').withVerb(VerbType.GET).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
+				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('summaries', 'summaries').withVariableParameter('position', 'position', 'position', false);
+			}).withQueryBuilder(function (qb) {
+				qb.withVariableParameter('frame', 'frame', 'frame', true).withVariableParameter('start', 'start', 'start', true).withVariableParameter('end', 'end', 'end', true);
+			}).withRequestInterceptor(requestInterceptorToUse)
+			// .withResponseInterceptor(responseInterceptorForPositionDeserialization)
+			.withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
+
 			_this._deletePortfoliosEndpoint = EndpointBuilder.for('delete-portfolio', 'delete portfolios').withVerb(VerbType.DELETE).withProtocol(protocolType).withHost(host).withPort(port).withPathBuilder(function (pb) {
 				pb.withLiteralParameter('portfolios', 'portfolios').withVariableParameter('portfolio', 'portfolio', 'portfolio', false).withLiteralParameter('positions', 'positions').withVariableParameter('position', 'position', 'position', false);
 			}).withRequestInterceptor(requestInterceptorToUse).withErrorInterceptor(ErrorInterceptor.GENERAL).endpoint;
@@ -264,7 +278,7 @@ module.exports = function () {
     * Creates a portfolio
     *
     * @public
-    * @param {Object=} portfolio
+    * @param {Object} portfolio
     * @return {Promise.<Portfolio>}
     */
 
@@ -286,7 +300,7 @@ module.exports = function () {
     * Updates a portfolio
     *
     * @public
-    * @param {String=} portfolio - ID of the portfolio to update
+    * @param {Object} portfolio
     * @return {Promise.<Portfolio>}
     */
 
@@ -298,7 +312,7 @@ module.exports = function () {
 				return Promise.resolve().then(function () {
 					checkStart.call(_this5);
 
-					assert.argumentIsRequired(portfolio, 'portfolio', String);
+					assert.argumentIsRequired(portfolio, 'portfolio', Object);
 
 					return Gateway.invoke(_this5._updatePortfolioEndpoint, PortfolioSchema.UPDATE.schema.format(portfolio));
 				});
@@ -308,8 +322,7 @@ module.exports = function () {
     * Updates a portfolio
     *
     * @public
-    * @param {String=} portfolio - ID of the portfolio to update
-    * @param {Object=} portfolioDatas
+    * @param {String} portfolio - ID of the portfolio to update
     * @return {Promise.<Portfolio>}
     */
 
@@ -323,7 +336,7 @@ module.exports = function () {
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 
-					return Gateway.invoke(_this6._deletePortfoliosEndpoint, { portfolio: portfolio });
+					return Gateway.invoke(_this6._deletePortfolioEndpoint, { portfolio: portfolio });
 				});
 			}
 
@@ -352,7 +365,7 @@ module.exports = function () {
 			}
 
 			/**
-    * Deletes a position.
+    * Retrieves positions for a user, a user's portfolio, or a single position.
     *
     * @public
     * @param {String=} portfolio
@@ -361,43 +374,77 @@ module.exports = function () {
     */
 
 		}, {
-			key: 'deletePosition',
-			value: function deletePosition(portfolio, position) {
+			key: 'readPositionSummaries',
+			value: function readPositionSummaries(portfolio, position) {
 				var _this8 = this;
 
 				return Promise.resolve().then(function () {
 					checkStart.call(_this8);
 
-					assert.argumentIsRequired(portfolio, 'portfolio', String);
-					assert.argumentIsRequired(position, 'position', String);
+					// console
+
+					assert.argumentIsOptional(portfolio, 'portfolio', String);
+					assert.argumentIsOptional(position, 'position', String);
 
-					return Gateway.invoke(_this8._deletePortfoliosEndpoint, { portfolio: portfolio, position: position });
+					return Gateway.invoke(_this8._readPositionSummariesEndpoint, { portfolio: portfolio || '*', position: position || '*' });
 				});
 			}
 
 			/**
-    * Retrieves transactions for a portfolio, or a single position.
+    * Deletes a position.
     *
     * @public
     * @param {String} portfolio
-    * @param {String=} position
-    * @returns {Promise.<Transaction[]>}
+    * @param {String} position
+    * @returns {Promise.<Position[]>}
     */
 
 		}, {
-			key: 'createTransaction',
-			value: function createTransaction(portfolio, position, transaction) {
+			key: 'deletePosition',
+			value: function deletePosition(portfolio, position) {
 				var _this9 = this;
 
 				return Promise.resolve().then(function () {
 					checkStart.call(_this9);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
-					assert.argumentIsOptional(position, 'position', String);
+					assert.argumentIsRequired(position, 'position', String);
+
+					return Gateway.invoke(_this9._deletePositionEndpoint, { portfolio: portfolio, position: position });
+				});
+			}
+
+			/**
+    * Retrieves transactions for a portfolio, or a single position.
+    *
+    * @public
+    * @param {Object} transaction
+    * @returns {Promise.<Transaction[]>}
+    */
+
+		}, {
+			key: 'createTransaction',
+			value: function createTransaction(transaction) {
+				var _this10 = this;
+
+				return Promise.resolve().then(function () {
+					checkStart.call(_this10);
 
 					assert.argumentIsRequired(transaction, 'transaction', Object);
+					assert.argumentIsRequired(transaction.portfolio, 'transaction.portfolio', String);
+					assert.argumentIsOptional(transaction.position, 'transaction.position', String);
+
+					if (transaction.type instanceof TransactionType) {
+						assert.argumentIsRequired(transaction.type, 'transaction.type', TransactionType, 'TransactionType');
+					} else {
+						assert.argumentIsRequired(transaction.type, 'transaction.type', String);
+					}
 
-					return Gateway.invoke(_this9._createTransactionEndpoint, { portfolio: portfolio, position: position || 'new', transaction: transaction });
+					if (!transaction.position) {
+						transaction.position = 'new';
+					}
+
+					return Gateway.invoke(_this10._createTransactionEndpoint, TransactionSchema.forCreate(transaction.type));
 				});
 			}
 
@@ -414,16 +461,16 @@ module.exports = function () {
 		}, {
 			key: 'deleteTransaction',
 			value: function deleteTransaction(portfolio, position, transaction) {
-				var _this10 = this;
+				var _this11 = this;
 
 				return Promise.resolve().then(function () {
-					checkStart.call(_this10);
+					checkStart.call(_this11);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsRequired(position, 'position', String);
 					assert.argumentIsRequired(transaction, 'transaction', String);
 
-					return Gateway.invoke(_this10._deleteTransactionsEndpoint, { portfolio: portfolio, position: position, transaction: transaction });
+					return Gateway.invoke(_this11._deleteTransactionsEndpoint, { portfolio: portfolio, position: position, transaction: transaction });
 				});
 			}
 
@@ -439,29 +486,29 @@ module.exports = function () {
 		}, {
 			key: 'readTransactions',
 			value: function readTransactions(portfolio, position) {
-				var _this11 = this;
+				var _this12 = this;
 
 				return Promise.resolve().then(function () {
-					checkStart.call(_this11);
+					checkStart.call(_this12);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsOptional(position, 'position', String);
 
-					return Gateway.invoke(_this11._readTransactionsEndpoint, { portfolio: portfolio, position: position || '*' });
+					return Gateway.invoke(_this12._readTransactionsEndpoint, { portfolio: portfolio, position: position || '*' });
 				});
 			}
 		}, {
 			key: 'readTransactionsFormatted',
 			value: function readTransactionsFormatted(portfolio, position) {
-				var _this12 = this;
+				var _this13 = this;
 
 				return Promise.resolve().then(function () {
-					checkStart.call(_this12);
+					checkStart.call(_this13);
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsOptional(position, 'position', String);
 
-					return Gateway.invoke(_this12._readTransactionsReportEndpoint, { portfolio: portfolio, position: position || '*' });
+					return Gateway.invoke(_this13._readTransactionsReportEndpoint, { portfolio: portfolio, position: position || '*' });
 				});
 			}
 
@@ -611,7 +658,7 @@ module.exports = function () {
 	return PortfolioGateway;
 }();
 
-},{"./../common/Configuration":2,"@barchart/common-js/api/failures/FailureReason":6,"@barchart/common-js/api/http/Gateway":9,"@barchart/common-js/api/http/builders/EndpointBuilder":10,"@barchart/common-js/api/http/definitions/ProtocolType":15,"@barchart/common-js/api/http/definitions/VerbType":16,"@barchart/common-js/api/http/interceptors/ErrorInterceptor":20,"@barchart/common-js/api/http/interceptors/RequestInterceptor":21,"@barchart/common-js/api/http/interceptors/ResponseInterceptor":22,"@barchart/common-js/lang/Disposable":31,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/portfolio-api-common/lib/serialization/PortfolioSchema":53,"@barchart/portfolio-api-common/lib/serialization/TransactionSchema":54}],4:[function(require,module,exports){
+},{"./../common/Configuration":2,"@barchart/common-js/api/failures/FailureReason":6,"@barchart/common-js/api/http/Gateway":9,"@barchart/common-js/api/http/builders/EndpointBuilder":10,"@barchart/common-js/api/http/definitions/ProtocolType":15,"@barchart/common-js/api/http/definitions/VerbType":16,"@barchart/common-js/api/http/interceptors/ErrorInterceptor":20,"@barchart/common-js/api/http/interceptors/RequestInterceptor":21,"@barchart/common-js/api/http/interceptors/ResponseInterceptor":22,"@barchart/common-js/lang/Disposable":31,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/portfolio-api-common/lib/data/TransactionType":51,"@barchart/portfolio-api-common/lib/serialization/PortfolioSchema":53,"@barchart/portfolio-api-common/lib/serialization/TransactionSchema":54}],4:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -924,7 +971,7 @@ module.exports = function () {
 	return {
 		JwtGateway: JwtGateway,
 		PortfolioGateway: PortfolioGateway,
-		version: '1.1.11'
+		version: '1.1.12'
 	};
 }();
 
@@ -8087,9 +8134,9 @@ function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-var functions = require('./../../lang/functions'),
-    is = require('./../../lang/is'),
-    array = require('./../../lang/array');
+var attributes = require('./../../lang/attributes'),
+    functions = require('./../../lang/functions'),
+    is = require('./../../lang/is');
 
 var LinkedList = require('./../../collections/LinkedList'),
     Tree = require('./../../collections/Tree');
@@ -8125,66 +8172,54 @@ module.exports = function () {
 		}
 
 		/**
-   * Name of the table.
+   * Accepts data and returns a new object which (should) conform to
+   * the schema.
    *
    * @public
-   * @returns {String}
+   * @param {data} data
+   * @returns {Object}
    */
 
 
 		_createClass(Schema, [{
-			key: 'validate',
+			key: 'format',
+			value: function format(data) {
+				var returnRef = {};
 
+				this._fields.forEach(function (field) {
+					formatField(returnRef, field, data);
+				});
 
-			/**
-    * Returns true, if an object complies with the schema.
-    *
-    * @public
-    * @param {*} candidate
-    */
-			value: function validate(candidate) {
-				var returnVal = is.object(candidate);
+				this._components.forEach(function (component) {
+					component.fields.forEach(function (field) {
+						formatField(returnRef, field, data);
+					});
+				});
 
-				return false;
+				return returnRef;
 			}
 
 			/**
-    * Generates a function suitable for use by JSON.parse.
+    * Name of the table.
     *
     * @public
-    * @returns {Function}
+    * @returns {String}
     */
 
 		}, {
-			key: 'getSimpleReviver',
-			value: function getSimpleReviver() {
-				var _this = this;
-
-				return function (key, value) {
-					var field = _this.fields.find(function (f) {
-						var fieldName = array.last(f.name.split('.'));
-
-						return fieldName === key;
-					});
-
-					if (is.object(value)) {
-						return value;
-					}
+			key: 'validate',
 
-					var returnVal = void 0;
 
-					try {
-						returnVal = field.dataType.reviver(value);
-					} catch (e) {
-						if (_this._strict) {
-							throw Error(e);
-						} else {
-							returnVal = value;
-						}
-					}
+			/**
+    * Returns true, if an object complies with the schema.
+    *
+    * @public
+    * @param {*} candidate
+    */
+			value: function validate(candidate) {
+				var returnVal = is.object(candidate);
 
-					return returnVal;
-				};
+				return false;
 			}
 
 			/**
@@ -8238,10 +8273,10 @@ module.exports = function () {
 		}, {
 			key: 'getReviverFactory',
 			value: function getReviverFactory() {
-				var _this2 = this;
+				var _this = this;
 
 				return function () {
-					return _this2.getReviver();
+					return _this.getReviver();
 				};
 			}
 		}, {
@@ -8305,11 +8340,11 @@ module.exports = function () {
 		function SchemaError(key, name, message) {
 			_classCallCheck(this, SchemaError);
 
-			var _this3 = _possibleConstructorReturn(this, (SchemaError.__proto__ || Object.getPrototypeOf(SchemaError)).call(this, message));
+			var _this2 = _possibleConstructorReturn(this, (SchemaError.__proto__ || Object.getPrototypeOf(SchemaError)).call(this, message));
 
-			_this3.key = key;
-			_this3.name = name;
-			return _this3;
+			_this2.key = key;
+			_this2.name = name;
+			return _this2;
 		}
 
 		_createClass(SchemaError, [{
@@ -8441,10 +8476,16 @@ module.exports = function () {
 		return head;
 	}
 
+	function formatField(target, field, data) {
+		if (attributes.has(data, field.name)) {
+			attributes.write(target, field.name, field.dataType.convert(attributes.read(data, field.name)));
+		}
+	}
+
 	return Schema;
 }();
 
-},{"./../../collections/LinkedList":23,"./../../collections/Tree":24,"./../../lang/array":36,"./../../lang/functions":39,"./../../lang/is":40,"./Component":44,"./Field":46}],48:[function(require,module,exports){
+},{"./../../collections/LinkedList":23,"./../../collections/Tree":24,"./../../lang/attributes":38,"./../../lang/functions":39,"./../../lang/is":40,"./Component":44,"./Field":46}],48:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -9474,6 +9515,7 @@ module.exports = (() => {
 
 },{"./../data/ValuationType":52,"@barchart/common-js/lang/Currency":28,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/Timezones":35,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/common-js/serialization/json/DataType":45,"@barchart/common-js/serialization/json/Schema":47,"@barchart/common-js/serialization/json/builders/SchemaBuilder":49}],54:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
+	is = require('@barchart/common-js/lang/is'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	DataType = require('@barchart/common-js/serialization/json/DataType'),
 	Enum = require('@barchart/common-js/lang/Enum'),
@@ -9508,6 +9550,35 @@ module.exports = (() => {
 			return this._schema;
 		}
 
+		/**
+		 * Returns the appropriate schema for creating a transaction of the
+		 * supplied type.
+		 *
+		 * @public
+		 * @static
+		 * @param {String|TransactionType} transactionType
+		 * @returns {TransactionSchema|null}
+		 */
+		static forCreate(transactionType) {
+			let code;
+
+			if (transactionType instanceof TransactionType) {
+				code = transactionType.code;
+			} else {
+				code = transactionType;
+			}
+
+			let schema;
+
+			if (is.string(code)) {
+				schema = Enum.fromCode(code);
+			} else {
+				schema = null;
+			}
+
+			return schema;
+		}
+
 		/**
 		 * The complete transaction schema.
 		 *
@@ -9685,9 +9756,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const buy = new TransactionSchema(SchemaBuilder.withName('B')
+	const buy = new TransactionSchema(SchemaBuilder.withName(TransactionType.BUY.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
 		.withField('instrument.name', DataType.STRING, true)
 		.withField('instrument.type', DataType.STRING, true)
 		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
@@ -9701,10 +9773,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const sell = new TransactionSchema(SchemaBuilder.withName('S')
+	const sell = new TransactionSchema(SchemaBuilder.withName(TransactionType.SELL.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -9712,10 +9784,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const buyShort = new TransactionSchema(SchemaBuilder.withName('BS')
+	const buyShort = new TransactionSchema(SchemaBuilder.withName(TransactionType.BUY_SHORT.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -9723,10 +9795,15 @@ module.exports = (() => {
 		.schema
 	);
 
-	const sellShort = new TransactionSchema(SchemaBuilder.withName('SS')
+	const sellShort = new TransactionSchema(SchemaBuilder.withName(TransactionType.SELL_SHORT.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
+		.withField('instrument.name', DataType.STRING, true)
+		.withField('instrument.type', DataType.STRING, true)
+		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
+		.withField('instrument.symbol.barchart', DataType.STRING, true)
+		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
 		.withField('price', DataType.DECIMAL)
 		.withField('quantity', DataType.DECIMAL)
@@ -9734,10 +9811,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const dividend = new TransactionSchema(SchemaBuilder.withName('DV')
+	const dividend = new TransactionSchema(SchemaBuilder.withName(TransactionType.DIVIDEND.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
 		.withField('open', DataType.DECIMAL, true)
@@ -9746,10 +9823,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const dividendReinvest = new TransactionSchema(SchemaBuilder.withName('DX')
+	const dividendReinvest = new TransactionSchema(SchemaBuilder.withName(TransactionType.DIVIDEND_REINVEST.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
 		.withField('open', DataType.DECIMAL, true)
@@ -9759,10 +9836,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const dividendStock = new TransactionSchema(SchemaBuilder.withName('DS')
+	const dividendStock = new TransactionSchema(SchemaBuilder.withName(TransactionType.DIVIDEND_STOCK.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
 		.withField('open', DataType.DECIMAL, true)
@@ -9772,10 +9849,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const distributionCash = new TransactionSchema(SchemaBuilder.withName('DC')
+	const distributionCash = new TransactionSchema(SchemaBuilder.withName(TransactionType.DISTRIBUTION_CASH.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
 		.withField('open', DataType.DECIMAL, true)
@@ -9784,10 +9861,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const distributionFund = new TransactionSchema(SchemaBuilder.withName('DF')
+	const distributionFund = new TransactionSchema(SchemaBuilder.withName(TransactionType.DISTRIBUTION_FUND.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('rate', DataType.DECIMAL)
 		.withField('open', DataType.DECIMAL, true)
@@ -9796,10 +9873,10 @@ module.exports = (() => {
 		.schema
 	);
 
-	const split = new TransactionSchema(SchemaBuilder.withName('SP')
+	const split = new TransactionSchema(SchemaBuilder.withName(TransactionType.SPLIT.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('numerator', DataType.DECIMAL)
 		.withField('denominator', DataType.DECIMAL)
@@ -9808,89 +9885,115 @@ module.exports = (() => {
 		.schema
 	);
 
-	const fee = new TransactionSchema(SchemaBuilder.withName('F')
+	const fee = new TransactionSchema(SchemaBuilder.withName(TransactionType.FEE.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('fee', DataType.DECIMAL)
 		.schema
 	);
 
-	const feeUnits = new TransactionSchema(SchemaBuilder.withName('FU')
+	const feeUnits = new TransactionSchema(SchemaBuilder.withName(TransactionType.FEE_UNITS.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('fee', DataType.DECIMAL)
 		.withField('price', DataType.DECIMAL)
 		.schema
 	);
 
-	const deposit = new TransactionSchema(SchemaBuilder.withName('D')
+	const deposit = new TransactionSchema(SchemaBuilder.withName(TransactionType.DEPOSIT.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
+		.withField('instrument.name', DataType.STRING, true)
+		.withField('instrument.type', DataType.STRING, true)
+		.withField('instrument.currency', DataType.forEnum(Currency, 'Currency'), true)
+		.withField('instrument.symbol.barchart', DataType.STRING, true)
+		.withField('instrument.symbol.display', DataType.STRING, true)
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
 
-	const withdrawal = new TransactionSchema(SchemaBuilder.withName('W')
+	const withdrawal = new TransactionSchema(SchemaBuilder.withName(TransactionType.WITHDRAWAL.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
 
-	const debit = new TransactionSchema(SchemaBuilder.withName('DR')
+	const debit = new TransactionSchema(SchemaBuilder.withName(TransactionType.DEBIT.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
 
-	const credit = new TransactionSchema(SchemaBuilder.withName('CR')
+	const credit = new TransactionSchema(SchemaBuilder.withName(TransactionType.CREDIT.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('amount', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
 
-	const valuation = new TransactionSchema(SchemaBuilder.withName('V')
+	const valuation = new TransactionSchema(SchemaBuilder.withName(TransactionType.VALUATION.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('value', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
 
-	const income = new TransactionSchema(SchemaBuilder.withName('I')
+	const income = new TransactionSchema(SchemaBuilder.withName(TransactionType.INCOME.code)
+		.withField('portfolio', DataType.STRING)
+		.withField('position', DataType.STRING)
 		.withField('type', DataType.forEnum(TransactionType, 'TransactionType'))
-		.withField('position', DataType.STRING, true)
-		.withField('currency', DataType.forEnum(Currency, 'Currency'))
 		.withField('date', DataType.DAY)
 		.withField('income', DataType.DECIMAL)
 		.withField('fee', DataType.DECIMAL, true)
 		.schema
 	);
 
+	const map = { };
+
+	function addSchemaToMap(type, schema) {
+		map[type.code] = schema;
+	}
+
+	addSchemaToMap(TransactionType.BUY, buy);
+	addSchemaToMap(TransactionType.SELL, sell);
+	addSchemaToMap(TransactionType.BUY_SHORT, buyShort);
+	addSchemaToMap(TransactionType.SELL_SHORT, sellShort);
+	addSchemaToMap(TransactionType.DIVIDEND, dividend);
+	addSchemaToMap(TransactionType.DIVIDEND_STOCK, dividendStock);
+	addSchemaToMap(TransactionType.DIVIDEND_REINVEST, dividendReinvest);
+	addSchemaToMap(TransactionType.SPLIT, split);
+	addSchemaToMap(TransactionType.FEE, fee);
+	addSchemaToMap(TransactionType.FEE_UNITS, feeUnits);
+	addSchemaToMap(TransactionType.DEPOSIT, deposit);
+	addSchemaToMap(TransactionType.WITHDRAWAL, withdrawal);
+	addSchemaToMap(TransactionType.VALUATION, valuation);
+	addSchemaToMap(TransactionType.INCOME, income);
+
 	return TransactionSchema;
 })();
 
-},{"./../data/TransactionType":51,"@barchart/common-js/lang/Currency":28,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/serialization/json/DataType":45,"@barchart/common-js/serialization/json/Schema":47,"@barchart/common-js/serialization/json/builders/SchemaBuilder":49}],55:[function(require,module,exports){
+},{"./../data/TransactionType":51,"@barchart/common-js/lang/Currency":28,"@barchart/common-js/lang/Enum":32,"@barchart/common-js/lang/assert":37,"@barchart/common-js/lang/is":40,"@barchart/common-js/serialization/json/DataType":45,"@barchart/common-js/serialization/json/Schema":47,"@barchart/common-js/serialization/json/builders/SchemaBuilder":49}],55:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

package/example/example.shim.js

@@ -2,9 +2,11 @@ const JwtGateway = require('@barchart/tgam-jwt-js/lib/JwtGateway');
 
 const Currency = require('@barchart/common-js/lang/Currency'),
 	Day = require('@barchart/common-js/lang/Day'),
-	Decimal = require('@barchart/common-js/lang/Decimal');
+	Decimal = require('@barchart/common-js/lang/Decimal'),
+	Timezones = require('@barchart/common-js/lang/Timezones');
 
-const TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
+const TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType'),
+	ValuationType = require('@barchart/portfolio-api-common/lib/data/ValuationType');
 
 module.exports = (() => {
 	'use strict';
@@ -16,6 +18,8 @@ module.exports = (() => {
 	window.Barchart.Currency = Currency;
 	window.Barchart.Day = Day;
 	window.Barchart.Decimal = Decimal;
+	window.Barchart.Timezones = Timezones;
 	window.Barchart.TransactionType = TransactionType;
+	window.Barchart.ValuationType = ValuationType;
 
 })();

package/lib/gateway/PortfolioGateway.js

@@ -3,6 +3,8 @@ const assert = require('@barchart/common-js/lang/assert'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	is = require('@barchart/common-js/lang/is');
 
+const TransactionType = require('@barchart/portfolio-api-common/lib/data/TransactionType');
+
 const PortfolioSchema = require('@barchart/portfolio-api-common/lib/serialization/PortfolioSchema'),
 	TransactionSchema = require('@barchart/portfolio-api-common/lib/serialization/TransactionSchema');
 
@@ -93,7 +95,7 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
-			this._deletePortfoliosEndpoint = EndpointBuilder.for('delete-portfolio', 'delete portfolios')
+			this._deletePortfolioEndpoint = EndpointBuilder.for('delete-portfolio', 'delete portfolios')
 				.withVerb(VerbType.DELETE)
 				.withProtocol(protocolType)
 				.withHost(host)
@@ -122,6 +124,27 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
+			this._readPositionSummariesEndpoint = EndpointBuilder.for('read-position-summaries', 'read position summaries')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('portfolios', 'portfolios')
+						.withVariableParameter('portfolio', 'portfolio', 'portfolio', false)
+						.withLiteralParameter('summaries', 'summaries')
+						.withVariableParameter('position', 'position', 'position',  false);
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('frame', 'frame', 'frame', true)
+						.withVariableParameter('start', 'start', 'start', true)
+						.withVariableParameter('end', 'end', 'end', true);
+				})
+				.withRequestInterceptor(requestInterceptorToUse)
+				// .withResponseInterceptor(responseInterceptorForPositionDeserialization)
+				.withErrorInterceptor(ErrorInterceptor.GENERAL)
+				.endpoint;
+
 			this._deletePortfoliosEndpoint = EndpointBuilder.for('delete-portfolio', 'delete portfolios')
 				.withVerb(VerbType.DELETE)
 				.withProtocol(protocolType)
@@ -262,7 +285,7 @@ module.exports = (() => {
 		 * Creates a portfolio
 		 *
 		 * @public
-		 * @param {Object=} portfolio
+		 * @param {Object} portfolio
 		 * @return {Promise.<Portfolio>}
 		 */
 		createPortfolio(portfolio) {
@@ -280,7 +303,7 @@ module.exports = (() => {
 		 * Updates a portfolio
 		 *
 		 * @public
-		 * @param {String=} portfolio - ID of the portfolio to update
+		 * @param {Object} portfolio
 		 * @return {Promise.<Portfolio>}
 		 */
 		updatePortfolio(portfolio) {
@@ -288,7 +311,7 @@ module.exports = (() => {
 				.then(() => {
 					checkStart.call(this);
 
-					assert.argumentIsRequired(portfolio, 'portfolio', String);
+					assert.argumentIsRequired(portfolio, 'portfolio', Object);
 					
 					return Gateway.invoke(this._updatePortfolioEndpoint, PortfolioSchema.UPDATE.schema.format(portfolio));
 				});
@@ -298,8 +321,7 @@ module.exports = (() => {
 		 * Updates a portfolio
 		 *
 		 * @public
-		 * @param {String=} portfolio - ID of the portfolio to update
-		 * @param {Object=} portfolioDatas
+		 * @param {String} portfolio - ID of the portfolio to update
 		 * @return {Promise.<Portfolio>}
 		 */
 		deletePortfolio(portfolio) {
@@ -309,7 +331,7 @@ module.exports = (() => {
 
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					
-					return Gateway.invoke(this._deletePortfoliosEndpoint, { portfolio: portfolio });
+					return Gateway.invoke(this._deletePortfolioEndpoint, { portfolio: portfolio });
 				});
 		}
 
@@ -334,13 +356,35 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Deletes a position.
+		 * Retrieves positions for a user, a user's portfolio, or a single position.
 		 *
 		 * @public
 		 * @param {String=} portfolio
 		 * @param {String=} position
 		 * @returns {Promise.<Position[]>}
 		 */
+		readPositionSummaries(portfolio, position) {
+			return Promise.resolve()
+				.then(() => {
+					checkStart.call(this);
+
+					// console
+
+					assert.argumentIsOptional(portfolio, 'portfolio', String);
+					assert.argumentIsOptional(position, 'position', String);
+
+					return Gateway.invoke(this._readPositionSummariesEndpoint, { portfolio: portfolio || '*', position: position || '*' });
+				});
+		}
+
+		/**
+		 * Deletes a position.
+		 *
+		 * @public
+		 * @param {String} portfolio
+		 * @param {String} position
+		 * @returns {Promise.<Position[]>}
+		 */
 		deletePosition(portfolio, position) {
 			return Promise.resolve()
 				.then(() => {
@@ -349,7 +393,7 @@ module.exports = (() => {
 					assert.argumentIsRequired(portfolio, 'portfolio', String);
 					assert.argumentIsRequired(position, 'position', String);
 
-					return Gateway.invoke(this._deletePortfoliosEndpoint, { portfolio: portfolio, position: position });
+					return Gateway.invoke(this._deletePositionEndpoint, { portfolio: portfolio, position: position });
 				});
 		}
 
@@ -357,21 +401,29 @@ module.exports = (() => {
 		 * Retrieves transactions for a portfolio, or a single position.
 		 *
 		 * @public
-		 * @param {String} portfolio
-		 * @param {String=} position
+		 * @param {Object} transaction
 		 * @returns {Promise.<Transaction[]>}
 		 */
-		createTransaction(portfolio, position, transaction) {
+		createTransaction(transaction) {
 			return Promise.resolve()
 				.then(() => {
 					checkStart.call(this);
 
-					assert.argumentIsRequired(portfolio, 'portfolio', String);
-					assert.argumentIsOptional(position, 'position', String);
-
 					assert.argumentIsRequired(transaction, 'transaction', Object);
+					assert.argumentIsRequired(transaction.portfolio, 'transaction.portfolio', String);
+					assert.argumentIsOptional(transaction.position, 'transaction.position', String);
+
+					if (transaction.type instanceof TransactionType) {
+						assert.argumentIsRequired(transaction.type, 'transaction.type', TransactionType, 'TransactionType');
+					} else {
+						assert.argumentIsRequired(transaction.type, 'transaction.type', String);
+					}
+
+					if (!transaction.position) {
+						transaction.position = 'new';
+					}
 
-					return Gateway.invoke(this._createTransactionEndpoint, { portfolio: portfolio, position: position || 'new', transaction: transaction });
+					return Gateway.invoke(this._createTransactionEndpoint, TransactionSchema.forCreate(transaction.type));
 				});
 		}
 

package/lib/index.js

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

package/package.json

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