@barchart/portfolio-client-js 9.0.0 → 9.1.0

package/lib/data/.meta.js

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