wealthica-sdk-js 0.0.10 → 0.0.13

package/README.md

@@ -314,7 +314,7 @@ This method removes a single institution from the user.
 await user.institutions.remove('603522490d2b02001233a5d6');
 ```
 
-#### user.history.getList({ institutionId, from, to, investments })
+#### user.history.getList({ institutions, from, to, investments })
 
 This method retrieves the balance history for an institution.
 
@@ -322,10 +322,10 @@ Returns data within the last 1 year by default.
 
 ```javascript
 const history = await user.history.getList({
-  institutionId: '603522490d2b02001233a5d6',
+  institutions: ['603522490d2b02001233a5d6'],
   from: '2021-01-01',
   to: '2021-09-09',
-  investment: 'bitcoin:cash:usd',
+  investments: ['bitcoin:cash:usd'],
 });
 ```
 
@@ -342,13 +342,13 @@ Returns data within the last 1 year by default.
 
 ```javascript
 const transactions = await user.transactions.getList({
-  institutionId: '603522490d2b02001233a5d6',
-  ticker: 'BTC', // optional
+  institutions: ['603522490d2b02001233a5d6'],
   from: '2020-08-31', // optional
   to: '2021-08-31', // optional
-  investment: 'bitcoin:cash:usd', // optional
+  investment: 'wise:cash:usd', // optional
   last: '603522490d2b02001233a5d6', // optional, blank string is allowed
   limit: 10, // optional
+  institutionId: '603522490d2b02001233a5d6', // Deprecated, use institutions prop
 });
 ```
 
@@ -357,13 +357,12 @@ todo: add response example
 
 ```
 
-#### user.transactions.getOne({ institutionId, txId })
+#### user.transactions.getOne({ txId })
 
 This method retrieves a single transaction.
 
 ```javascript
 const transaction = await user.transactions.getOne({
-  institutionId: '603522490d2b02001233a5d6',
   txId: '603522490d2b02001233a5d6'
 });
 ```
@@ -373,6 +372,21 @@ todo: add response example
 
 ```
 
+#### user.positions.getList({ institutions })
+
+This method retrieves user positions.
+
+```javascript
+const positions = await user.positions.getList({
+  institutions: ['603522490d2b02001233a5d6']
+});
+```
+
+todo: add response example
+```json
+
+```
+
 ### Data APIs
 
 These methods provide general Wealthica information and do not require logging in a user.

package/dist/wealthica.d.ts

@@ -41,6 +41,7 @@ interface APIUserInterface extends APIInterface {
   institutions: InstitutionsInterface
   history: HistoryInterface
   transactions: TransactionsInterface
+  positions: PositionsInterface
 }
 
 interface InstitutionsInterface {
@@ -62,6 +63,11 @@ interface TransactionsInterface {
   getOne(options: TransactionOptions): Promise<Transactions> | Promise<never>
 }
 
+interface PositionsInterface {
+  constructor(api: APIUserInterface)
+  getList(options: PositionsOptions): Promise<Position[]> | Promise<never>
+}
+
 type APIConfig = {
   clientId: string;
   secret?: string;
@@ -98,19 +104,41 @@ type ConnectData = {
 }
 
 type TransactionsOptions = {
-  institutionId: string;
+  institutions?: Array<string>;
+  investments?: Array<string>;
+  groups?: Array<string>;
   from?: string;
   to?: string;
-  investments?: string;
+  assets?: boolean;
+  liabilities?: boolean;
+  banking?: boolean;
+  types?: Array<string>;
+  deleted?: Boolean;
+  invalid?: Boolean;
+  new?: Boolean;
+  peek?: Boolean;
+  missing?: Boolean;
   last?: string;
   limit?: number;
+  sort?: string;
+  security?: Boolean;
+  skip_date_filter?: Boolean;
+  institutionId?: string;
 }
 
 type TransactionOptions = {
-  institutionId: string;
   txId: string;
 }
 
+type PositionsOptions = {
+  groups?: Array<string>;
+  institutions?: Array<string>;
+  investments?: Array<string>;
+  assets?: Boolean;
+  liabilities?: Boolean;
+  banking?: Boolean;
+}
+
 type Part = {
   direction: string;
   ticker: string;
@@ -145,10 +173,10 @@ type Transactions = {
 }
 
 type HistoryListOptions = {
-  institutionId: string;
+  institutions: string[];
   from?: string;
   to?: string;
-  investments?: string;
+  investments?: string[];
 }
 
 type BalanceHistory = {
@@ -204,3 +232,49 @@ type Institution = {
   updated_at: number;
   resource_type: string;
 }
+
+type Position = {
+  _id: string;
+  class: string;
+  classes: {
+    class: string;
+    weight: number;
+  };
+  category: string;
+  categories: Array<string>;
+  security: Security;
+  investments: Array<PositionInvestment>
+  quantity: number;
+  book_value: number;
+  market_value: number;
+  gain_amount: number;
+  gain_percent: number;
+}
+
+type Security = {
+  _id: string;
+  currency: string;
+  symbol: string;
+  type: string;
+  name: string;
+  aliases: Array<string>;
+  last_price: number;
+  last_date: string;
+  high_price: number;
+  high_date: string;
+  low_price: number;
+  low_date: string;
+  cusip: string;
+}
+
+type PositionInvestment = {
+  institution: string;
+  investment: string;
+  currency: string;
+  quantity: number;
+  book_value: number;
+  market_value: number;
+  value: number;
+  gain_amount: number;
+  gain_percent: number;
+}

package/dist/wealthica.es5.d.ts

@@ -41,6 +41,7 @@ interface APIUserInterface extends APIInterface {
   institutions: InstitutionsInterface
   history: HistoryInterface
   transactions: TransactionsInterface
+  positions: PositionsInterface
 }
 
 interface InstitutionsInterface {
@@ -62,6 +63,11 @@ interface TransactionsInterface {
   getOne(options: TransactionOptions): Promise<Transactions> | Promise<never>
 }
 
+interface PositionsInterface {
+  constructor(api: APIUserInterface)
+  getList(options: PositionsOptions): Promise<Position[]> | Promise<never>
+}
+
 type APIConfig = {
   clientId: string;
   secret?: string;
@@ -98,19 +104,41 @@ type ConnectData = {
 }
 
 type TransactionsOptions = {
-  institutionId: string;
+  institutions?: Array<string>;
+  investments?: Array<string>;
+  groups?: Array<string>;
   from?: string;
   to?: string;
-  investments?: string;
+  assets?: boolean;
+  liabilities?: boolean;
+  banking?: boolean;
+  types?: Array<string>;
+  deleted?: Boolean;
+  invalid?: Boolean;
+  new?: Boolean;
+  peek?: Boolean;
+  missing?: Boolean;
   last?: string;
   limit?: number;
+  sort?: string;
+  security?: Boolean;
+  skip_date_filter?: Boolean;
+  institutionId?: string;
 }
 
 type TransactionOptions = {
-  institutionId: string;
   txId: string;
 }
 
+type PositionsOptions = {
+  groups?: Array<string>;
+  institutions?: Array<string>;
+  investments?: Array<string>;
+  assets?: Boolean;
+  liabilities?: Boolean;
+  banking?: Boolean;
+}
+
 type Part = {
   direction: string;
   ticker: string;
@@ -145,10 +173,10 @@ type Transactions = {
 }
 
 type HistoryListOptions = {
-  institutionId: string;
+  institutions: string[];
   from?: string;
   to?: string;
-  investments?: string;
+  investments?: string[];
 }
 
 type BalanceHistory = {
@@ -204,3 +232,49 @@ type Institution = {
   updated_at: number;
   resource_type: string;
 }
+
+type Position = {
+  _id: string;
+  class: string;
+  classes: {
+    class: string;
+    weight: number;
+  };
+  category: string;
+  categories: Array<string>;
+  security: Security;
+  investments: Array<PositionInvestment>
+  quantity: number;
+  book_value: number;
+  market_value: number;
+  gain_amount: number;
+  gain_percent: number;
+}
+
+type Security = {
+  _id: string;
+  currency: string;
+  symbol: string;
+  type: string;
+  name: string;
+  aliases: Array<string>;
+  last_price: number;
+  last_date: string;
+  high_price: number;
+  high_date: string;
+  low_price: number;
+  low_date: string;
+  cusip: string;
+}
+
+type PositionInvestment = {
+  institution: string;
+  investment: string;
+  currency: string;
+  quantity: number;
+  book_value: number;
+  market_value: number;
+  value: number;
+  gain_amount: number;
+  gain_percent: number;
+}

package/dist/wealthica.es5.js

@@ -6059,7 +6059,7 @@ var API = /*#__PURE__*/function () {
           return _ref.apply(this, arguments);
         };
       }());
-      var userResources = createResources(user, ['institutions', 'history', 'transactions']);
+      var userResources = createResources(user, ['institutions', 'history', 'transactions', 'positions']);
       Object.assign(user, userResources);
       user.config.loginName = loginName;
       return user;
@@ -6550,9 +6550,6 @@ module.exports = new Wealthica();
 /***/ ((module, __unused_webpack_exports, __webpack_require__) => {
 
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-var _excluded = ["institutionId"];
-function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
@@ -6572,8 +6569,6 @@ var History = /*#__PURE__*/function () {
     value: function () {
       var _getList = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
         var options,
-          institutionId,
-          params,
           url,
           query,
           response,
@@ -6583,28 +6578,21 @@ var History = /*#__PURE__*/function () {
             switch (_context.prev = _context.next) {
               case 0:
                 options = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
-                institutionId = options.institutionId, params = _objectWithoutProperties(options, _excluded);
-                if (!(!institutionId || typeof institutionId !== 'string')) {
-                  _context.next = 4;
-                  break;
-                }
-                throw new Error('Please provide a valid Wealthica institution id.');
-              case 4:
-                url = "/institutions/".concat(institutionId, "/history");
-                query = getQueryString(params);
+                url = '/history';
+                query = getQueryString(options);
                 if (query) url = "".concat(url, "?").concat(query);
-                _context.next = 9;
+                _context.next = 6;
                 return this.api.get(url);
-              case 9:
+              case 6:
                 response = _context.sent;
                 if (response.ok) {
-                  _context.next = 12;
+                  _context.next = 9;
                   break;
                 }
                 throw response.originalError;
-              case 12:
+              case 9:
                 return _context.abrupt("return", response.data);
-              case 13:
+              case 10:
               case "end":
                 return _context.stop();
             }
@@ -6632,7 +6620,8 @@ var RESOURCES = {
   history: __webpack_require__(55987),
   providers: __webpack_require__(95269),
   teams: __webpack_require__(67523),
-  transactions: __webpack_require__(46123)
+  transactions: __webpack_require__(46123),
+  positions: __webpack_require__(87334)
 };
 module.exports = function createResources(api, resources) {
   return resources.reduce(function (res, resource) {
@@ -6828,6 +6817,71 @@ module.exports = Institutions;
 
 /***/ }),
 
+/***/ 87334:
+/***/ ((module, __unused_webpack_exports, __webpack_require__) => {
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a 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, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+var _require = __webpack_require__(9853),
+  getQueryString = _require.getQueryString;
+var Positions = /*#__PURE__*/function () {
+  function Positions(api) {
+    _classCallCheck(this, Positions);
+    this.api = api.userApi;
+  }
+  _createClass(Positions, [{
+    key: "getList",
+    value: function () {
+      var _getList = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+        var options,
+          url,
+          query,
+          response,
+          _args = arguments;
+        return regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                options = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+                url = '/positions';
+                query = getQueryString(options);
+                if (query) url = "".concat(url, "?").concat(query);
+                _context.next = 6;
+                return this.api.get(url);
+              case 6:
+                response = _context.sent;
+                if (response.ok) {
+                  _context.next = 9;
+                  break;
+                }
+                throw response.originalError;
+              case 9:
+                return _context.abrupt("return", response.data);
+              case 10:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this);
+      }));
+      function getList() {
+        return _getList.apply(this, arguments);
+      }
+      return getList;
+    }()
+  }]);
+  return Positions;
+}();
+module.exports = Positions;
+
+/***/ }),
+
 /***/ 95269:
 /***/ ((module, __unused_webpack_exports, __webpack_require__) => {
 
@@ -6996,10 +7050,12 @@ module.exports = Teams;
 /***/ ((module, __unused_webpack_exports, __webpack_require__) => {
 
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-var _excluded = ["institutionId"],
-  _excluded2 = ["institutionId", "txId"];
+var _excluded = ["txId"];
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
@@ -7019,9 +7075,8 @@ var Transactions = /*#__PURE__*/function () {
     value: function () {
       var _getList = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
         var options,
-          institutionId,
-          params,
           url,
+          institutions,
           query,
           response,
           _args = arguments;
@@ -7030,15 +7085,17 @@ var Transactions = /*#__PURE__*/function () {
             switch (_context.prev = _context.next) {
               case 0:
                 options = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
-                institutionId = options.institutionId, params = _objectWithoutProperties(options, _excluded);
-                if (!(!institutionId || typeof institutionId !== 'string')) {
-                  _context.next = 4;
-                  break;
+                url = '/transactions';
+                institutions = options.institutions || []; // Add institutionId for backward compatibility
+                if (options.institutionId && !institutions.includes(options.institutionId)) {
+                  institutions.push(options.institutionId);
                 }
-                throw new Error('Please provide a valid Wealthica institution id.');
-              case 4:
-                url = "/transactions?institutions=".concat(institutionId);
-                query = getQueryString(params);
+
+                // eslint-disable-next-line no-param-reassign
+                delete options.institutionId;
+                query = getQueryString(_objectSpread(_objectSpread({}, options), {}, {
+                  institutions: institutions
+                }));
                 if (query) url = "".concat(url, "?").concat(query);
                 _context.next = 9;
                 return this.api.get(url);
@@ -7068,7 +7125,6 @@ var Transactions = /*#__PURE__*/function () {
     value: function () {
       var _getOne = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
         var options,
-          institutionId,
           txId,
           params,
           url,
@@ -7080,34 +7136,28 @@ var Transactions = /*#__PURE__*/function () {
             switch (_context2.prev = _context2.next) {
               case 0:
                 options = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
-                institutionId = options.institutionId, txId = options.txId, params = _objectWithoutProperties(options, _excluded2);
-                if (!(!institutionId || typeof institutionId !== 'string')) {
-                  _context2.next = 4;
-                  break;
-                }
-                throw new Error('Please provide a valid Wealthica institution id.');
-              case 4:
+                txId = options.txId, params = _objectWithoutProperties(options, _excluded);
                 if (!(!txId || typeof txId !== 'string')) {
-                  _context2.next = 6;
+                  _context2.next = 4;
                   break;
                 }
                 throw new Error('Please provide a valid Wealthica transaction id.');
-              case 6:
+              case 4:
                 url = "/transactions/".concat(txId);
                 query = getQueryString(params);
                 if (query) url = "".concat(url, "?").concat(query);
-                _context2.next = 11;
+                _context2.next = 9;
                 return this.api.get(url);
-              case 11:
+              case 9:
                 response = _context2.sent;
                 if (response.ok) {
-                  _context2.next = 14;
+                  _context2.next = 12;
                   break;
                 }
                 throw response.originalError;
-              case 14:
+              case 12:
                 return _context2.abrupt("return", response.data);
-              case 15:
+              case 13:
               case "end":
                 return _context2.stop();
             }