snaptrade-typescript-sdk 6.4.0 → 7.0.0

package/.konfig/generate-id.txt

@@ -1 +1 @@
-ef1bca40-b1e0-4bee-a0fc-3ad6bf8353b5
+4174766a-a000-448d-907d-7b028d62bca9

package/README.md

@@ -1,4 +1,4 @@
-## snaptrade-typescript-sdk@6.4.0
+## snaptrade-typescript-sdk@7.0.0
 Connect brokerage accounts to your app for live positions and trading
 
 

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

@@ -37,14 +37,14 @@ export const TransactionsAndReportingApiAxiosParamCreator = function (configurat
          * @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: async (userId: string, userSecret: string, startDate?: string, endDate?: string, accounts?: string, brokerageAuthorizations?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getActivities: async (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'userId' is not null or undefined
             assertParamExists('getActivities', 'userId', userId)
             // verify required parameter 'userSecret' is not null or undefined
@@ -68,11 +68,15 @@ export const TransactionsAndReportingApiAxiosParamCreator = function (configurat
             // authentication PartnerTimestamp required
             await setApiKeyToObject({object: localVarQueryParameter, keyParamName: "timestamp", configuration})
             if (startDate !== undefined) {
-                localVarQueryParameter['startDate'] = startDate;
+                localVarQueryParameter['startDate'] = (startDate as any instanceof Date) ?
+                    (startDate as any).toISOString().substr(0,10) :
+                    startDate;
             }
 
             if (endDate !== undefined) {
-                localVarQueryParameter['endDate'] = endDate;
+                localVarQueryParameter['endDate'] = (endDate as any instanceof Date) ?
+                    (endDate as any).toISOString().substr(0,10) :
+                    endDate;
             }
 
             if (accounts !== undefined) {
@@ -111,8 +115,8 @@ export const TransactionsAndReportingApiAxiosParamCreator = function (configurat
         /**
          * 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
@@ -121,7 +125,7 @@ export const TransactionsAndReportingApiAxiosParamCreator = function (configurat
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getReportingCustomRange: async (startDate: string, endDate: string, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getReportingCustomRange: async (startDate: string | Date, endDate: string | Date, userId: string, userSecret: string, accounts?: string, detailed?: boolean, frequency?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'startDate' is not null or undefined
             assertParamExists('getReportingCustomRange', 'startDate', startDate)
             // verify required parameter 'endDate' is not null or undefined
@@ -149,11 +153,15 @@ export const TransactionsAndReportingApiAxiosParamCreator = function (configurat
             // authentication PartnerTimestamp required
             await setApiKeyToObject({object: localVarQueryParameter, keyParamName: "timestamp", configuration})
             if (startDate !== undefined) {
-                localVarQueryParameter['startDate'] = startDate;
+                localVarQueryParameter['startDate'] = (startDate as any instanceof Date) ?
+                    (startDate as any).toISOString().substr(0,10) :
+                    startDate;
             }
 
             if (endDate !== undefined) {
-                localVarQueryParameter['endDate'] = endDate;
+                localVarQueryParameter['endDate'] = (endDate as any instanceof Date) ?
+                    (endDate as any).toISOString().substr(0,10) :
+                    endDate;
             }
 
             if (accounts !== undefined) {
@@ -281,17 +289,17 @@ export type TransactionsAndReportingApiGetActivitiesRequest = {
     
     /**
     * 
-    * @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
@@ -318,17 +326,17 @@ 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
     
     /**
     * 

package/configuration.ts

@@ -110,7 +110,7 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = param.baseOptions ?? {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/6.4.0/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/7.0.0/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
 

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

@@ -25,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
@@ -46,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
@@ -112,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}
@@ -143,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}

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

@@ -96,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.
@@ -142,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;
@@ -179,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
@@ -232,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;

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.4.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/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/package.json

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