snaptrade-typescript-sdk 6.3.0 → 7.0.0

package/dist/api/transactions-and-reporting-api.d.ts

@@ -11,9 +11,10 @@
  */
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
-import { RequestArgs, BaseAPI } from '../base';
+import { RequestArgs } from '../base';
 import { PerformanceCustom } from '../models';
 import { UniversalActivity } from '../models';
+import { TransactionsAndReportingApiCustom } from "./transactions-and-reporting-api-custom";
 /**
  * TransactionsAndReportingApi - axios parameter creator
  * @export
@@ -24,19 +25,19 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
      * @summary Get transaction history for a user
      * @param {string} userId
      * @param {string} userSecret
-     * @param {string} [startDate]
-     * @param {string} [endDate]
+     * @param {string | Date} [startDate]
+     * @param {string | Date} [endDate]
      * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
      * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getActivities: (userId: string, userSecret: string, startDate?: string, endDate?: string, accounts?: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
      * @summary Get performance information for a specific timeframe
-     * @param {string} startDate
-     * @param {string} endDate
+     * @param {string | Date} startDate
+     * @param {string | Date} endDate
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
@@ -45,7 +46,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getReportingCustomRange: (startDate: string, endDate: string, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getReportingCustomRange: (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * TransactionsAndReportingApi - functional programming interface
@@ -111,16 +112,16 @@ export type TransactionsAndReportingApiGetActivitiesRequest = {
     readonly userSecret: string;
     /**
     *
-    * @type {string}
+    * @type {string | Date}
     * @memberof TransactionsAndReportingApiGetActivities
     */
-    readonly startDate?: string;
+    readonly startDate?: string | Date;
     /**
     *
-    * @type {string}
+    * @type {string | Date}
     * @memberof TransactionsAndReportingApiGetActivities
     */
-    readonly endDate?: string;
+    readonly endDate?: string | Date;
     /**
     * Optional comma seperated list of account IDs used to filter the request on specific accounts
     * @type {string}
@@ -142,16 +143,16 @@ export type TransactionsAndReportingApiGetActivitiesRequest = {
 export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
     /**
     *
-    * @type {string}
+    * @type {string | Date}
     * @memberof TransactionsAndReportingApiGetReportingCustomRange
     */
-    readonly startDate: string;
+    readonly startDate: string | Date;
     /**
     *
-    * @type {string}
+    * @type {string | Date}
     * @memberof TransactionsAndReportingApiGetReportingCustomRange
     */
-    readonly endDate: string;
+    readonly endDate: string | Date;
     /**
     *
     * @type {string}
@@ -189,7 +190,7 @@ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
  * @class TransactionsAndReportingApi
  * @extends {BaseAPI}
  */
-export declare class TransactionsAndReportingApi extends BaseAPI {
+export declare class TransactionsAndReportingApi extends TransactionsAndReportingApiCustom {
     /**
      * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
      * @summary Get transaction history for a user

package/dist/api/transactions-and-reporting-api.js

@@ -83,6 +83,7 @@ var common_1 = require("../common");
 // @ts-ignore
 var base_1 = require("../base");
 var requestBeforeHook_1 = require("../requestBeforeHook");
+var transactions_and_reporting_api_custom_1 = require("./transactions-and-reporting-api-custom");
 /**
  * TransactionsAndReportingApi - axios parameter creator
  * @export
@@ -95,8 +96,8 @@ var TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
          * @summary Get transaction history for a user
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} [startDate]
-         * @param {string} [endDate]
+         * @param {string | Date} [startDate]
+         * @param {string | Date} [endDate]
          * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
          * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
          * @param {*} [options] Override http request option.
@@ -141,10 +142,14 @@ var TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
                             // authentication PartnerTimestamp required
                             _a.sent();
                             if (startDate !== undefined) {
-                                localVarQueryParameter['startDate'] = startDate;
+                                localVarQueryParameter['startDate'] = (startDate instanceof Date) ?
+                                    startDate.toISOString().substr(0, 10) :
+                                    startDate;
                             }
                             if (endDate !== undefined) {
-                                localVarQueryParameter['endDate'] = endDate;
+                                localVarQueryParameter['endDate'] = (endDate instanceof Date) ?
+                                    endDate.toISOString().substr(0, 10) :
+                                    endDate;
                             }
                             if (accounts !== undefined) {
                                 localVarQueryParameter['accounts'] = accounts;
@@ -178,8 +183,8 @@ var TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
         /**
          * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
          * @summary Get performance information for a specific timeframe
-         * @param {string} startDate
-         * @param {string} endDate
+         * @param {string | Date} startDate
+         * @param {string | Date} endDate
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
@@ -231,10 +236,14 @@ var TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
                             // authentication PartnerTimestamp required
                             _a.sent();
                             if (startDate !== undefined) {
-                                localVarQueryParameter['startDate'] = startDate;
+                                localVarQueryParameter['startDate'] = (startDate instanceof Date) ?
+                                    startDate.toISOString().substr(0, 10) :
+                                    startDate;
                             }
                             if (endDate !== undefined) {
-                                localVarQueryParameter['endDate'] = endDate;
+                                localVarQueryParameter['endDate'] = (endDate instanceof Date) ?
+                                    endDate.toISOString().substr(0, 10) :
+                                    endDate;
                             }
                             if (accounts !== undefined) {
                                 localVarQueryParameter['accounts'] = accounts;
@@ -387,5 +396,5 @@ var TransactionsAndReportingApi = /** @class */ (function (_super) {
         return (0, exports.TransactionsAndReportingApiFp)(this.configuration).getReportingCustomRange(requestParameters, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     return TransactionsAndReportingApi;
-}(base_1.BaseAPI));
+}(transactions_and_reporting_api_custom_1.TransactionsAndReportingApiCustom));
 exports.TransactionsAndReportingApi = TransactionsAndReportingApi;

package/dist/client-custom.d.ts

@@ -0,0 +1,4 @@
+import { ConfigurationParameters } from "./configuration";
+export declare class SnaptradeCustom {
+    constructor(configurationParameters: ConfigurationParameters);
+}

package/dist/client-custom.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnaptradeCustom = void 0;
+var SnaptradeCustom = /** @class */ (function () {
+    function SnaptradeCustom(configurationParameters) {
+    }
+    return SnaptradeCustom;
+}());
+exports.SnaptradeCustom = SnaptradeCustom;

package/dist/client.d.ts

@@ -11,7 +11,8 @@
  */
 import { AccountInformationApi, ApiDisclaimerApi, ApiStatusApi, AuthenticationApi, ConnectionsApi, ErrorLogsApi, OptionsApi, PortfolioManagementApi, ReferenceDataApi, TradingApi, TransactionsAndReportingApi } from "./api";
 import { ConfigurationParameters } from "./configuration";
-export declare class Snaptrade {
+import { SnaptradeCustom } from "./client-custom";
+export declare class Snaptrade extends SnaptradeCustom {
     readonly accountInformation: AccountInformationApi;
     readonly apiDisclaimer: ApiDisclaimerApi;
     readonly apiStatus: ApiStatusApi;

package/dist/client.js

@@ -10,25 +10,44 @@
  * https://konfigthis.com
  * Do not edit the class manually.
  */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Snaptrade = void 0;
 var api_1 = require("./api");
 var configuration_1 = require("./configuration");
-var Snaptrade = /** @class */ (function () {
+var client_custom_1 = require("./client-custom");
+var Snaptrade = /** @class */ (function (_super) {
+    __extends(Snaptrade, _super);
     function Snaptrade(configurationParameters) {
+        var _this = _super.call(this, configurationParameters) || this;
         var configuration = new configuration_1.Configuration(configurationParameters);
-        this.accountInformation = new api_1.AccountInformationApi(configuration);
-        this.apiDisclaimer = new api_1.ApiDisclaimerApi(configuration);
-        this.apiStatus = new api_1.ApiStatusApi(configuration);
-        this.authentication = new api_1.AuthenticationApi(configuration);
-        this.connections = new api_1.ConnectionsApi(configuration);
-        this.errorLogs = new api_1.ErrorLogsApi(configuration);
-        this.options = new api_1.OptionsApi(configuration);
-        this.portfolioManagement = new api_1.PortfolioManagementApi(configuration);
-        this.referenceData = new api_1.ReferenceDataApi(configuration);
-        this.trading = new api_1.TradingApi(configuration);
-        this.transactionsAndReporting = new api_1.TransactionsAndReportingApi(configuration);
+        _this.accountInformation = new api_1.AccountInformationApi(configuration);
+        _this.apiDisclaimer = new api_1.ApiDisclaimerApi(configuration);
+        _this.apiStatus = new api_1.ApiStatusApi(configuration);
+        _this.authentication = new api_1.AuthenticationApi(configuration);
+        _this.connections = new api_1.ConnectionsApi(configuration);
+        _this.errorLogs = new api_1.ErrorLogsApi(configuration);
+        _this.options = new api_1.OptionsApi(configuration);
+        _this.portfolioManagement = new api_1.PortfolioManagementApi(configuration);
+        _this.referenceData = new api_1.ReferenceDataApi(configuration);
+        _this.trading = new api_1.TradingApi(configuration);
+        _this.transactionsAndReporting = new api_1.TransactionsAndReportingApi(configuration);
+        return _this;
     }
     return Snaptrade;
-}());
+}(client_custom_1.SnaptradeCustom));
 exports.Snaptrade = Snaptrade;

package/dist/configuration.js

@@ -34,7 +34,7 @@ var Configuration = /** @class */ (function () {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/6.3.0/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/7.0.0/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/snap-trade-holdings-account.d.ts

@@ -9,7 +9,6 @@
  * https://konfigthis.com
  * Do not edit the class manually.
  */
-import { BrokerageAuthorization } from './brokerage-authorization';
 /**
  * SnapTradeUser Investment Account
  * @export
@@ -25,10 +24,10 @@ export interface SnapTradeHoldingsAccount {
     'id'?: string;
     /**
      *
-     * @type {BrokerageAuthorization}
+     * @type {string}
      * @memberof SnapTradeHoldingsAccount
      */
-    'brokerage_authorization'?: BrokerageAuthorization;
+    'brokerage_authorization'?: string;
     /**
      *
      * @type {string}

package/dist/models/symbol.d.ts

@@ -18,6 +18,12 @@ import { Exchange } from './exchange';
  */
 export interface Symbol {
     [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof Symbol
+     */
+    'id'?: string;
     /**
      *
      * @type {string}

package/docs/TransactionsAndReportingApi.md

@@ -48,8 +48,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **userId** | [**string**] |  | defaults to undefined
  **userSecret** | [**string**] |  | defaults to undefined
- **startDate** | [**string**] |  | (optional) defaults to undefined
- **endDate** | [**string**] |  | (optional) defaults to undefined
+ **startDate** | [**string | Date**] |  | (optional) defaults to undefined
+ **endDate** | [**string | Date**] |  | (optional) defaults to undefined
  **accounts** | [**string**] | Optional comma seperated list of account IDs used to filter the request on specific accounts | (optional) defaults to undefined
  **brokerageAuthorizations** | [**string**] | Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations | (optional) defaults to undefined
 
@@ -111,8 +111,8 @@ console.log(getReportingCustomRangeResponse)
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **startDate** | [**string**] |  | defaults to undefined
- **endDate** | [**string**] |  | defaults to undefined
+ **startDate** | [**string | Date**] |  | defaults to undefined
+ **endDate** | [**string | Date**] |  | defaults to undefined
  **userId** | [**string**] |  | defaults to undefined
  **userSecret** | [**string**] |  | defaults to undefined
  **accounts** | [**string**] | Optional comma seperated list of account IDs used to filter the request on specific accounts | (optional) defaults to undefined

package/index.test.ts

@@ -88,6 +88,66 @@ it("getUserAccountBalance", async () => {
   console.log(response.data);
 });
 
+it("getActivities", async () => {
+  const snaptrade = new Snaptrade({
+    consumerKey: process.env.SNAPTRADE_CONSUMER_KEY,
+    clientId: process.env.SNAPTRADE_CLIENT_ID,
+  });
+  const userId = process.env.SNAPTRADE_TEST_USER_ID;
+  const userSecret = process.env.SNAPTRADE_TEST_USER_SECRET;
+  let activities = await snaptrade.transactionsAndReporting.getActivities({
+    userId,
+    userSecret,
+  });
+  console.log(activities.data);
+  expect(activities).not.toBeNull();
+  // create two variables "startDate" and "endDate" that are strings representing 1 year ago and today in yyyy-mm-dd format using today's date
+  const startDate = "2020-01-01";
+  const endDate = "2020-12-31";
+  activities = await snaptrade.transactionsAndReporting.getActivities({
+    userId,
+    userSecret,
+    startDate,
+    endDate,
+  });
+  console.log(activities.data);
+  expect(activities).not.toBeNull();
+  // create two variables "startDate" and "endDate" that are Date instances representing 1 year ago and today
+  const endDate2 = new Date();
+  // create variable startDate2 which is 1 year before endDate2
+  const startDate2 = new Date(endDate2);
+  startDate2.setFullYear(startDate2.getFullYear() - 1);
+  activities = await snaptrade.transactionsAndReporting.getActivities({
+    userId,
+    userSecret,
+    startDate: startDate2,
+    endDate: endDate2,
+  });
+  console.log(activities.data);
+  expect(activities).not.toBeNull();
+});
+
+it("getUserHoldings", async () => {
+  const snaptrade = new Snaptrade({
+    consumerKey: process.env.SNAPTRADE_CONSUMER_KEY,
+    clientId: process.env.SNAPTRADE_CLIENT_ID,
+  });
+  const userId = process.env.SNAPTRADE_TEST_USER_ID;
+  const userSecret = process.env.SNAPTRADE_TEST_USER_SECRET;
+  const accounts = await snaptrade.accountInformation.listUserAccounts({
+    userId,
+    userSecret,
+  });
+  const holdings = await snaptrade.accountInformation.getUserHoldings({
+    userId,
+    userSecret,
+    accountId: accounts.data[0].id,
+  });
+  // assert holdings is not null with jest
+  expect(holdings).not.toBeNull();
+  console.log(holdings.data);
+});
+
 it.skip("getOptionsChain", async () => {
   const snaptrade = new Snaptrade({
     consumerKey: process.env.SNAPTRADE_CONSUMER_KEY,

package/models/snap-trade-holdings-account.ts

@@ -12,9 +12,6 @@
  * Do not edit the class manually.
  */
 
-// May contain unused imports in some cases
-// @ts-ignore
-import { BrokerageAuthorization } from './brokerage-authorization';
 
 /**
  * SnapTradeUser Investment Account
@@ -32,10 +29,10 @@ export interface SnapTradeHoldingsAccount {
     'id'?: string;
     /**
      * 
-     * @type {BrokerageAuthorization}
+     * @type {string}
      * @memberof SnapTradeHoldingsAccount
      */
-    'brokerage_authorization'?: BrokerageAuthorization;
+    'brokerage_authorization'?: string;
     /**
      * 
      * @type {string}

package/models/symbol.ts

@@ -27,6 +27,12 @@ import { Exchange } from './exchange';
 export interface Symbol {
     [key: string]: any;
 
+    /**
+     * 
+     * @type {string}
+     * @memberof Symbol
+     */
+    'id'?: string;
     /**
      * 
      * @type {string}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "6.3.0",
+  "version": "7.0.0",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "repository": {