snaptrade-typescript-sdk 2.4.0 → 3.0.0

package/.konfig/generate-id.txt

@@ -1 +1 @@
-5fa8de97-71fe-4542-a787-6b5205a8c112
+b01b0b5a-207b-4bcc-872b-f039b191e11a

package/README.md

@@ -1,4 +1,4 @@
-## snaptrade-typescript-sdk@2.4.0
+## snaptrade-typescript-sdk@3.0.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -30,7 +30,7 @@ npm run build
 navigate to the folder of your consuming project and run the following command.
 
 ```
-npm install snaptrade-typescript-sdk@2.4.0 --save
+npm install snaptrade-typescript-sdk@3.0.0 --save
 ```
 
 ### Getting Started

package/api.ts

@@ -339,7 +339,7 @@ export interface Balance {
      * @type {number}
      * @memberof Balance
      */
-    'cash'?: number;
+    'cash'?: number | null;
 }
 /**
  * 
@@ -408,7 +408,7 @@ export interface Brokerage {
      * @type {boolean}
      * @memberof Brokerage
      */
-    'allows_fractional_units'?: boolean;
+    'allows_fractional_units'?: boolean | null;
     /**
      * 
      * @type {boolean}
@@ -432,7 +432,7 @@ export interface Brokerage {
      * @type {boolean}
      * @memberof Brokerage
      */
-    'allows_trading_through_snaptrade_api'?: boolean;
+    'allows_trading_through_snaptrade_api'?: boolean | null;
     /**
      * 
      * @type {boolean}
@@ -657,7 +657,7 @@ export interface BrokerageSymbol {
      * @type {boolean}
      * @memberof BrokerageSymbol
      */
-    'allows_fractional_units'?: boolean;
+    'allows_fractional_units'?: boolean | null;
 }
 /**
  * Type of brokerage
@@ -809,13 +809,13 @@ export interface DividendAtDate {
      * @type {string}
      * @memberof DividendAtDate
      */
-    'symbol'?: string;
+    'symbol'?: string | null;
     /**
      * The amount received from the dividend
      * @type {number}
      * @memberof DividendAtDate
      */
-    'amount'?: number;
+    'amount'?: number | null;
     /**
      * The currency of the amount
      * @type {string}
@@ -924,7 +924,7 @@ export interface Exchange {
      * @type {string}
      * @memberof Exchange
      */
-    'suffix'?: string;
+    'suffix'?: string | null;
 }
 /**
  * The exchange rate of a pair of currencies
@@ -1111,7 +1111,7 @@ export interface ManualTradeBalance {
      * @type {number}
      * @memberof ManualTradeBalance
      */
-    'cash'?: number;
+    'cash'?: number | null;
 }
 /**
  * Manual Trade Form
@@ -1148,7 +1148,7 @@ export interface ManualTradeForm {
      * @type {number}
      * @memberof ManualTradeForm
      */
-    'stop'?: number;
+    'stop'?: number | null;
     /**
      * 
      * @type {TimeInForce}
@@ -1205,7 +1205,7 @@ export interface ManualTradeSymbol {
      * @type {string}
      * @memberof ManualTradeSymbol
      */
-    'description'?: string;
+    'description'?: string | null;
     /**
      * 
      * @type {string}
@@ -1495,7 +1495,7 @@ export interface NetContributions {
      * @type {number}
      * @memberof NetContributions
      */
-    'contributions'?: number;
+    'contributions'?: number | null;
     /**
      * 
      * @type {string}
@@ -1522,7 +1522,7 @@ export interface NetDividend {
      * @type {number}
      * @memberof NetDividend
      */
-    'amount'?: number;
+    'amount'?: number | null;
     /**
      * 
      * @type {string}
@@ -1609,19 +1609,19 @@ export interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
      * @type {number}
      * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
      */
-    'strikePrice'?: number;
+    'strikePrice'?: number | null;
     /**
      * 
      * @type {number}
      * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
      */
-    'callSymbolId'?: number;
+    'callSymbolId'?: number | null;
     /**
      * 
      * @type {number}
      * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
      */
-    'putSymbolId'?: number;
+    'putSymbolId'?: number | null;
 }
 /**
  * Option Leg
@@ -2141,19 +2141,19 @@ export interface PerformanceCustom {
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'contributionStreak'?: number;
+    'contributionStreak'?: number | null;
     /**
      * Number of months in the timeframe with contributions
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'contributionMonthsContributed'?: number;
+    'contributionMonthsContributed'?: number | null;
     /**
      * Total months in timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'contributionTotalMonths'?: number;
+    'contributionTotalMonths'?: number | null;
     /**
      * 
      * @type {Array<NetDividend>}
@@ -2165,13 +2165,13 @@ export interface PerformanceCustom {
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'dividendIncome'?: number;
+    'dividendIncome'?: number | null;
     /**
      * Average dividends received per month over the timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'monthlyDividends'?: number;
+    'monthlyDividends'?: number | null;
     /**
      * list of tickers which may not be supported or may not have accurate price data
      * @type {Array<string>}
@@ -2189,25 +2189,25 @@ export interface PerformanceCustom {
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'commissions'?: number;
+    'commissions'?: number | null;
     /**
      * forex fees incurred during the timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'forexFees'?: number;
+    'forexFees'?: number | null;
     /**
      * other fees incurred during the timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'fees'?: number;
+    'fees'?: number | null;
     /**
      * The return rate over the timeframe. Annualized if timeframe is longer than 1 year
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'rateOfReturn'?: number;
+    'rateOfReturn'?: number | null;
     /**
      * 
      * @type {Array<SubPeriodReturnRate>}
@@ -2336,7 +2336,7 @@ export interface PortfolioGroupPosition {
      * @type {number}
      * @memberof PortfolioGroupPosition
      */
-    'price'?: number;
+    'price'?: number | null;
     /**
      * 
      * @type {number}
@@ -2402,19 +2402,19 @@ export interface Position {
      * @type {number}
      * @memberof Position
      */
-    'units'?: number;
+    'units'?: number | null;
     /**
      * Last known market price for the symbol
      * @type {number}
      * @memberof Position
      */
-    'price'?: number;
+    'price'?: number | null;
     /**
      * 
      * @type {number}
      * @memberof Position
      */
-    'open_pnl'?: number;
+    'open_pnl'?: number | null;
     /**
      * Deprecated, use the units field for both fractional and integer units going forward
      * @type {number}
@@ -2459,7 +2459,7 @@ export interface PositionSymbol {
      * @type {string}
      * @memberof PositionSymbol
      */
-    'local_id'?: string;
+    'local_id'?: string | null;
     /**
      * 
      * @type {boolean}
@@ -2579,7 +2579,7 @@ export interface SnapTradeHoldingsAccount {
      * @type {string}
      * @memberof SnapTradeHoldingsAccount
      */
-    'name'?: string;
+    'name'?: string | null;
     /**
      * 
      * @type {string}
@@ -3399,7 +3399,7 @@ export interface SubPeriodReturnRate {
      * @type {number}
      * @memberof SubPeriodReturnRate
      */
-    'rateOfReturn'?: number;
+    'rateOfReturn'?: number | null;
 }
 /**
  * Symbol
@@ -3539,7 +3539,7 @@ export interface TargetAsset {
      * @type {object}
      * @memberof TargetAsset
      */
-    'meta'?: object;
+    'meta'?: object | null;
 }
 /**
  * Trade time in force:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled 
@@ -3812,7 +3812,7 @@ export interface USExchange {
      * @type {string}
      * @memberof USExchange
      */
-    'suffix'?: string;
+    'suffix'?: string | null;
     /**
      * 
      * @type {boolean}
@@ -3845,7 +3845,7 @@ export interface UnderlyingSymbol {
      * @type {string}
      * @memberof UnderlyingSymbol
      */
-    'description'?: string;
+    'description'?: string | null;
     /**
      * 
      * @type {Currency}
@@ -3896,7 +3896,7 @@ export interface UniversalActivity {
      * @type {number}
      * @memberof UniversalActivity
      */
-    'amount'?: number;
+    'amount'?: number | null;
     /**
      * 
      * @type {Currency}
@@ -3956,7 +3956,7 @@ export interface UniversalActivity {
      * @type {string}
      * @memberof UniversalActivity
      */
-    'trade_date'?: string;
+    'trade_date'?: string | null;
     /**
      * 
      * @type {string}
@@ -4023,7 +4023,7 @@ export interface UniversalSymbol {
      * @type {string}
      * @memberof UniversalSymbol
      */
-    'description'?: string;
+    'description'?: string | null;
     /**
      * 
      * @type {Currency}

package/dist/api.d.ts

@@ -318,7 +318,7 @@ export interface Balance {
      * @type {number}
      * @memberof Balance
      */
-    'cash'?: number;
+    'cash'?: number | null;
 }
 /**
  *
@@ -386,7 +386,7 @@ export interface Brokerage {
      * @type {boolean}
      * @memberof Brokerage
      */
-    'allows_fractional_units'?: boolean;
+    'allows_fractional_units'?: boolean | null;
     /**
      *
      * @type {boolean}
@@ -410,7 +410,7 @@ export interface Brokerage {
      * @type {boolean}
      * @memberof Brokerage
      */
-    'allows_trading_through_snaptrade_api'?: boolean;
+    'allows_trading_through_snaptrade_api'?: boolean | null;
     /**
      *
      * @type {boolean}
@@ -625,7 +625,7 @@ export interface BrokerageSymbol {
      * @type {boolean}
      * @memberof BrokerageSymbol
      */
-    'allows_fractional_units'?: boolean;
+    'allows_fractional_units'?: boolean | null;
 }
 /**
  * Type of brokerage
@@ -768,13 +768,13 @@ export interface DividendAtDate {
      * @type {string}
      * @memberof DividendAtDate
      */
-    'symbol'?: string;
+    'symbol'?: string | null;
     /**
      * The amount received from the dividend
      * @type {number}
      * @memberof DividendAtDate
      */
-    'amount'?: number;
+    'amount'?: number | null;
     /**
      * The currency of the amount
      * @type {string}
@@ -881,7 +881,7 @@ export interface Exchange {
      * @type {string}
      * @memberof Exchange
      */
-    'suffix'?: string;
+    'suffix'?: string | null;
 }
 /**
  * The exchange rate of a pair of currencies
@@ -1062,7 +1062,7 @@ export interface ManualTradeBalance {
      * @type {number}
      * @memberof ManualTradeBalance
      */
-    'cash'?: number;
+    'cash'?: number | null;
 }
 /**
  * Manual Trade Form
@@ -1099,7 +1099,7 @@ export interface ManualTradeForm {
      * @type {number}
      * @memberof ManualTradeForm
      */
-    'stop'?: number;
+    'stop'?: number | null;
     /**
      *
      * @type {TimeInForce}
@@ -1155,7 +1155,7 @@ export interface ManualTradeSymbol {
      * @type {string}
      * @memberof ManualTradeSymbol
      */
-    'description'?: string;
+    'description'?: string | null;
     /**
      *
      * @type {string}
@@ -1431,7 +1431,7 @@ export interface NetContributions {
      * @type {number}
      * @memberof NetContributions
      */
-    'contributions'?: number;
+    'contributions'?: number | null;
     /**
      *
      * @type {string}
@@ -1457,7 +1457,7 @@ export interface NetDividend {
      * @type {number}
      * @memberof NetDividend
      */
-    'amount'?: number;
+    'amount'?: number | null;
     /**
      *
      * @type {string}
@@ -1541,19 +1541,19 @@ export interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
      * @type {number}
      * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
      */
-    'strikePrice'?: number;
+    'strikePrice'?: number | null;
     /**
      *
      * @type {number}
      * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
      */
-    'callSymbolId'?: number;
+    'callSymbolId'?: number | null;
     /**
      *
      * @type {number}
      * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
      */
-    'putSymbolId'?: number;
+    'putSymbolId'?: number | null;
 }
 /**
  * Option Leg
@@ -2051,19 +2051,19 @@ export interface PerformanceCustom {
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'contributionStreak'?: number;
+    'contributionStreak'?: number | null;
     /**
      * Number of months in the timeframe with contributions
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'contributionMonthsContributed'?: number;
+    'contributionMonthsContributed'?: number | null;
     /**
      * Total months in timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'contributionTotalMonths'?: number;
+    'contributionTotalMonths'?: number | null;
     /**
      *
      * @type {Array<NetDividend>}
@@ -2075,13 +2075,13 @@ export interface PerformanceCustom {
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'dividendIncome'?: number;
+    'dividendIncome'?: number | null;
     /**
      * Average dividends received per month over the timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'monthlyDividends'?: number;
+    'monthlyDividends'?: number | null;
     /**
      * list of tickers which may not be supported or may not have accurate price data
      * @type {Array<string>}
@@ -2099,25 +2099,25 @@ export interface PerformanceCustom {
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'commissions'?: number;
+    'commissions'?: number | null;
     /**
      * forex fees incurred during the timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'forexFees'?: number;
+    'forexFees'?: number | null;
     /**
      * other fees incurred during the timeframe
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'fees'?: number;
+    'fees'?: number | null;
     /**
      * The return rate over the timeframe. Annualized if timeframe is longer than 1 year
      * @type {number}
      * @memberof PerformanceCustom
      */
-    'rateOfReturn'?: number;
+    'rateOfReturn'?: number | null;
     /**
      *
      * @type {Array<SubPeriodReturnRate>}
@@ -2243,7 +2243,7 @@ export interface PortfolioGroupPosition {
      * @type {number}
      * @memberof PortfolioGroupPosition
      */
-    'price'?: number;
+    'price'?: number | null;
     /**
      *
      * @type {number}
@@ -2307,19 +2307,19 @@ export interface Position {
      * @type {number}
      * @memberof Position
      */
-    'units'?: number;
+    'units'?: number | null;
     /**
      * Last known market price for the symbol
      * @type {number}
      * @memberof Position
      */
-    'price'?: number;
+    'price'?: number | null;
     /**
      *
      * @type {number}
      * @memberof Position
      */
-    'open_pnl'?: number;
+    'open_pnl'?: number | null;
     /**
      * Deprecated, use the units field for both fractional and integer units going forward
      * @type {number}
@@ -2363,7 +2363,7 @@ export interface PositionSymbol {
      * @type {string}
      * @memberof PositionSymbol
      */
-    'local_id'?: string;
+    'local_id'?: string | null;
     /**
      *
      * @type {boolean}
@@ -2479,7 +2479,7 @@ export interface SnapTradeHoldingsAccount {
      * @type {string}
      * @memberof SnapTradeHoldingsAccount
      */
-    'name'?: string;
+    'name'?: string | null;
     /**
      *
      * @type {string}
@@ -3282,7 +3282,7 @@ export interface SubPeriodReturnRate {
      * @type {number}
      * @memberof SubPeriodReturnRate
      */
-    'rateOfReturn'?: number;
+    'rateOfReturn'?: number | null;
 }
 /**
  * Symbol
@@ -3420,7 +3420,7 @@ export interface TargetAsset {
      * @type {object}
      * @memberof TargetAsset
      */
-    'meta'?: object;
+    'meta'?: object | null;
 }
 /**
  * Trade time in force:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled
@@ -3681,7 +3681,7 @@ export interface USExchange {
      * @type {string}
      * @memberof USExchange
      */
-    'suffix'?: string;
+    'suffix'?: string | null;
     /**
      *
      * @type {boolean}
@@ -3713,7 +3713,7 @@ export interface UnderlyingSymbol {
      * @type {string}
      * @memberof UnderlyingSymbol
      */
-    'description'?: string;
+    'description'?: string | null;
     /**
      *
      * @type {Currency}
@@ -3763,7 +3763,7 @@ export interface UniversalActivity {
      * @type {number}
      * @memberof UniversalActivity
      */
-    'amount'?: number;
+    'amount'?: number | null;
     /**
      *
      * @type {Currency}
@@ -3823,7 +3823,7 @@ export interface UniversalActivity {
      * @type {string}
      * @memberof UniversalActivity
      */
-    'trade_date'?: string;
+    'trade_date'?: string | null;
     /**
      *
      * @type {string}
@@ -3887,7 +3887,7 @@ export interface UniversalSymbol {
      * @type {string}
      * @memberof UniversalSymbol
      */
-    'description'?: string;
+    'description'?: string | null;
     /**
      *
      * @type {Currency}

package/package.json

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

package/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="passiv"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="snaptrade-sdks/tree/master/sdks/typescript"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'