snaptrade-typescript-sdk 9.0.32 → 9.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/README.md +3 -1
  2. package/dist/api/account-information-api-generated.d.ts +4 -4
  3. package/dist/api/account-information-api-generated.js +4 -4
  4. package/dist/browser.js +1 -1
  5. package/dist/configuration.js +1 -1
  6. package/dist/models/account-holdings-account.d.ts +2 -2
  7. package/dist/models/account-order-record-option-symbol.d.ts +52 -0
  8. package/dist/models/account-order-record-status.d.ts +1 -1
  9. package/dist/models/account-order-record-universal-symbol.d.ts +73 -0
  10. package/dist/models/account-order-record.d.ts +26 -25
  11. package/dist/models/account.d.ts +4 -4
  12. package/dist/models/exchange.d.ts +9 -9
  13. package/dist/models/figi-instrument.d.ts +3 -3
  14. package/dist/models/index.d.ts +6 -32
  15. package/dist/models/index.js +6 -32
  16. package/dist/models/monthly-dividends.d.ts +1 -1
  17. package/dist/models/net-contributions.d.ts +1 -1
  18. package/dist/models/option-brokerage-symbol.d.ts +5 -3
  19. package/dist/models/options-position-currency.d.ts +1 -1
  20. package/dist/models/options-position.d.ts +2 -1
  21. package/dist/models/options-symbol.d.ts +7 -19
  22. package/dist/models/order-type-strict.d.ts +1 -1
  23. package/dist/models/past-value.d.ts +1 -1
  24. package/dist/models/position-symbol.d.ts +11 -6
  25. package/dist/models/security-type.d.ts +6 -5
  26. package/dist/models/snap-trade-holdings-account-account-id.d.ts +2 -3
  27. package/dist/models/strategy-order-record.d.ts +1 -1
  28. package/dist/models/sub-period-return-rate.d.ts +2 -2
  29. package/dist/models/symbol-figi-instrument.d.ts +2 -2
  30. package/dist/models/underlying-symbol-exchange.d.ts +61 -0
  31. package/dist/models/underlying-symbol-type.d.ts +32 -0
  32. package/dist/models/underlying-symbol.d.ts +22 -14
  33. package/dist/models/universal-symbol-currency.d.ts +25 -0
  34. package/dist/models/universal-symbol-exchange.d.ts +55 -0
  35. package/dist/models/universal-symbol.d.ts +14 -12
  36. package/package.json +1 -1
  37. package/dist/models/brokerage-authorization-type.d.ts +0 -16
  38. package/dist/models/brokerage-symbol-option-symbol.d.ts +0 -64
  39. package/dist/models/brokerage-symbol-symbol.d.ts +0 -71
  40. package/dist/models/brokerage-symbol.d.ts +0 -47
  41. package/dist/models/calculated-trade.d.ts +0 -21
  42. package/dist/models/cash-restriction.d.ts +0 -40
  43. package/dist/models/excluded-asset.d.ts +0 -15
  44. package/dist/models/excluded-asset.js +0 -2
  45. package/dist/models/jwt.d.ts +0 -14
  46. package/dist/models/jwt.js +0 -2
  47. package/dist/models/model-asset-class-details.d.ts +0 -22
  48. package/dist/models/model-asset-class-details.js +0 -2
  49. package/dist/models/model-asset-class-target.d.ts +0 -15
  50. package/dist/models/model-asset-class-target.js +0 -2
  51. package/dist/models/model-asset-class.d.ts +0 -20
  52. package/dist/models/model-asset-class.js +0 -2
  53. package/dist/models/model-portfolio-asset-class.d.ts +0 -21
  54. package/dist/models/model-portfolio-asset-class.js +0 -2
  55. package/dist/models/model-portfolio-details.d.ts +0 -29
  56. package/dist/models/model-portfolio-details.js +0 -2
  57. package/dist/models/model-portfolio-security.d.ts +0 -21
  58. package/dist/models/model-portfolio-security.js +0 -2
  59. package/dist/models/model-portfolio.d.ts +0 -28
  60. package/dist/models/model-portfolio.js +0 -2
  61. package/dist/models/portfolio-group-info.d.ts +0 -82
  62. package/dist/models/portfolio-group-info.js +0 -2
  63. package/dist/models/portfolio-group-position.d.ts +0 -27
  64. package/dist/models/portfolio-group-position.js +0 -2
  65. package/dist/models/portfolio-group-settings.d.ts +0 -39
  66. package/dist/models/portfolio-group-settings.js +0 -2
  67. package/dist/models/portfolio-group.d.ts +0 -20
  68. package/dist/models/portfolio-group.js +0 -2
  69. package/dist/models/redirect-tokenand-pin.d.ts +0 -20
  70. package/dist/models/redirect-tokenand-pin.js +0 -2
  71. package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +0 -20
  72. package/dist/models/snap-trade-apidisclaimer-accept-status.js +0 -2
  73. package/dist/models/strategy-impact-legs-inner.d.ts +0 -50
  74. package/dist/models/strategy-impact-legs-inner.js +0 -2
  75. package/dist/models/strategy-impact.d.ts +0 -75
  76. package/dist/models/strategy-impact.js +0 -2
  77. package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +0 -50
  78. package/dist/models/strategy-order-place-orders-inner-legs-inner.js +0 -2
  79. package/dist/models/strategy-order-place-orders-inner.d.ts +0 -267
  80. package/dist/models/strategy-order-place-orders-inner.js +0 -2
  81. package/dist/models/strategy-order-place.d.ts +0 -21
  82. package/dist/models/strategy-order-place.js +0 -2
  83. package/dist/models/target-asset.d.ts +0 -47
  84. package/dist/models/target-asset.js +0 -2
  85. package/dist/models/trade-execution-status.d.ts +0 -70
  86. package/dist/models/trade-execution-status.js +0 -2
  87. package/dist/models/trade-impact.d.ts +0 -40
  88. package/dist/models/trade-impact.js +0 -2
  89. package/dist/models/trade.d.ts +0 -61
  90. package/dist/models/trade.js +0 -2
  91. package/dist/models/user-error-log.d.ts +0 -44
  92. package/dist/models/user-error-log.js +0 -2
  93. package/dist/models/user-settings.d.ts +0 -69
  94. package/dist/models/user-settings.js +0 -2
  95. /package/dist/models/{brokerage-authorization-type.js → account-order-record-option-symbol.js} +0 -0
  96. /package/dist/models/{brokerage-symbol-option-symbol.js → account-order-record-universal-symbol.js} +0 -0
  97. /package/dist/models/{brokerage-symbol-symbol.js → underlying-symbol-exchange.js} +0 -0
  98. /package/dist/models/{brokerage-symbol.js → underlying-symbol-type.js} +0 -0
  99. /package/dist/models/{calculated-trade.js → universal-symbol-currency.js} +0 -0
  100. /package/dist/models/{cash-restriction.js → universal-symbol-exchange.js} +0 -0
@@ -32,7 +32,7 @@ class Configuration {
32
32
  this.accessToken = param.accessToken;
33
33
  this.basePath = param.basePath;
34
34
  this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
35
- this.userAgent = param.userAgent === undefined ? "Konfig/9.0.32/typescript" : param.userAgent;
35
+ this.userAgent = param.userAgent === undefined ? "Konfig/9.0.34/typescript" : param.userAgent;
36
36
  this.formDataCtor = param.formDataCtor;
37
37
  }
38
38
  /**
@@ -5,7 +5,7 @@ import { Position } from './position';
5
5
  import { SnapTradeHoldingsAccountAccountId } from './snap-trade-holdings-account-account-id';
6
6
  import { SnapTradeHoldingsTotalValue } from './snap-trade-holdings-total-value';
7
7
  /**
8
- * A wrapper object containing holdings information for a single account
8
+ * A wrapper object containing holdings information for a single account.
9
9
  * @export
10
10
  * @interface AccountHoldingsAccount
11
11
  */
@@ -36,7 +36,7 @@ export interface AccountHoldingsAccount {
36
36
  */
37
37
  'option_positions'?: Array<OptionsPosition> | null;
38
38
  /**
39
- * List of recent orders in the account, including both pending and executed orders.
39
+ * List of recent orders in the account, including both pending and executed orders. Note that option orders are included in this list. Option orders will have a null `universal_symbol` field and a non-null `option_symbol` field.
40
40
  * @type {Array<AccountOrderRecord>}
41
41
  * @memberof AccountHoldingsAccount
42
42
  */
@@ -0,0 +1,52 @@
1
+ import { UnderlyingSymbol } from './underlying-symbol';
2
+ /**
3
+ * Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated.
4
+ * @export
5
+ * @interface AccountOrderRecordOptionSymbol
6
+ */
7
+ export interface AccountOrderRecordOptionSymbol {
8
+ /**
9
+ * Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
10
+ * @type {string}
11
+ * @memberof AccountOrderRecordOptionSymbol
12
+ */
13
+ 'id': string;
14
+ /**
15
+ * The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
16
+ * @type {string}
17
+ * @memberof AccountOrderRecordOptionSymbol
18
+ */
19
+ 'ticker': string;
20
+ /**
21
+ * The type of option. Either \"CALL\" or \"PUT\".
22
+ * @type {string}
23
+ * @memberof AccountOrderRecordOptionSymbol
24
+ */
25
+ 'option_type': AccountOrderRecordOptionSymbolOptionTypeEnum;
26
+ /**
27
+ * The option strike price.
28
+ * @type {number}
29
+ * @memberof AccountOrderRecordOptionSymbol
30
+ */
31
+ 'strike_price': number;
32
+ /**
33
+ * The option expiration date.
34
+ * @type {string}
35
+ * @memberof AccountOrderRecordOptionSymbol
36
+ */
37
+ 'expiration_date': string;
38
+ /**
39
+ * Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
40
+ * @type {boolean}
41
+ * @memberof AccountOrderRecordOptionSymbol
42
+ */
43
+ 'is_mini_option'?: boolean;
44
+ /**
45
+ *
46
+ * @type {UnderlyingSymbol}
47
+ * @memberof AccountOrderRecordOptionSymbol
48
+ */
49
+ 'underlying_symbol': UnderlyingSymbol;
50
+ }
51
+ type AccountOrderRecordOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
52
+ export {};
@@ -1,5 +1,5 @@
1
1
  /**
2
- *
2
+ * Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
3
3
  * @export
4
4
  * @enum {string}
5
5
  */
@@ -0,0 +1,73 @@
1
+ import { Currency } from './currency';
2
+ import { SecurityType } from './security-type';
3
+ import { SymbolFigiInstrument } from './symbol-figi-instrument';
4
+ import { UniversalSymbolCurrency } from './universal-symbol-currency';
5
+ import { UniversalSymbolExchange } from './universal-symbol-exchange';
6
+ /**
7
+ * Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated.
8
+ * @export
9
+ * @interface AccountOrderRecordUniversalSymbol
10
+ */
11
+ export interface AccountOrderRecordUniversalSymbol {
12
+ /**
13
+ * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
14
+ * @type {string}
15
+ * @memberof AccountOrderRecordUniversalSymbol
16
+ */
17
+ 'id': string;
18
+ /**
19
+ * The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
20
+ * @type {string}
21
+ * @memberof AccountOrderRecordUniversalSymbol
22
+ */
23
+ 'symbol': string;
24
+ /**
25
+ * The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
26
+ * @type {string}
27
+ * @memberof AccountOrderRecordUniversalSymbol
28
+ */
29
+ 'raw_symbol': string;
30
+ /**
31
+ * A human-readable description of the security. This is usually the company name or ETF name.
32
+ * @type {string}
33
+ * @memberof AccountOrderRecordUniversalSymbol
34
+ */
35
+ 'description'?: string | null;
36
+ /**
37
+ *
38
+ * @type {UniversalSymbolCurrency}
39
+ * @memberof AccountOrderRecordUniversalSymbol
40
+ */
41
+ 'currency': UniversalSymbolCurrency;
42
+ /**
43
+ *
44
+ * @type {UniversalSymbolExchange}
45
+ * @memberof AccountOrderRecordUniversalSymbol
46
+ */
47
+ 'exchange'?: UniversalSymbolExchange;
48
+ /**
49
+ *
50
+ * @type {SecurityType}
51
+ * @memberof AccountOrderRecordUniversalSymbol
52
+ */
53
+ 'type': SecurityType;
54
+ /**
55
+ * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
56
+ * @type {Array<Currency>}
57
+ * @memberof AccountOrderRecordUniversalSymbol
58
+ * @deprecated
59
+ */
60
+ 'currencies': Array<Currency>;
61
+ /**
62
+ * This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
63
+ * @type {string}
64
+ * @memberof AccountOrderRecordUniversalSymbol
65
+ */
66
+ 'figi_code'?: string | null;
67
+ /**
68
+ *
69
+ * @type {SymbolFigiInstrument}
70
+ * @memberof AccountOrderRecordUniversalSymbol
71
+ */
72
+ 'figi_instrument'?: SymbolFigiInstrument | null;
73
+ }
@@ -1,125 +1,126 @@
1
+ import { AccountOrderRecordOptionSymbol } from './account-order-record-option-symbol';
1
2
  import { AccountOrderRecordStatus } from './account-order-record-status';
2
- import { OptionsSymbol } from './options-symbol';
3
- import { UniversalSymbol } from './universal-symbol';
3
+ import { AccountOrderRecordUniversalSymbol } from './account-order-record-universal-symbol';
4
4
  /**
5
- * Record of order in brokerageaccount
5
+ * Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records.
6
6
  * @export
7
7
  * @interface AccountOrderRecord
8
8
  */
9
9
  export interface AccountOrderRecord {
10
10
  [key: string]: any;
11
11
  /**
12
- * Order id returned by brokerage
12
+ * Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
13
13
  * @type {string}
14
14
  * @memberof AccountOrderRecord
15
15
  */
16
16
  'brokerage_order_id'?: string;
17
17
  /**
18
- *
18
+ * Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
19
19
  * @type {AccountOrderRecordStatus}
20
20
  * @memberof AccountOrderRecord
21
21
  */
22
22
  'status'?: AccountOrderRecordStatus;
23
23
  /**
24
- *
24
+ * A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
25
25
  * @type {string}
26
26
  * @memberof AccountOrderRecord
27
+ * @deprecated
27
28
  */
28
29
  'symbol'?: string;
29
30
  /**
30
31
  *
31
- * @type {UniversalSymbol}
32
+ * @type {AccountOrderRecordUniversalSymbol}
32
33
  * @memberof AccountOrderRecord
33
34
  */
34
- 'universal_symbol'?: UniversalSymbol;
35
+ 'universal_symbol'?: AccountOrderRecordUniversalSymbol;
35
36
  /**
36
37
  *
37
- * @type {OptionsSymbol}
38
+ * @type {AccountOrderRecordOptionSymbol}
38
39
  * @memberof AccountOrderRecord
39
40
  */
40
- 'option_symbol'?: OptionsSymbol;
41
+ 'option_symbol'?: AccountOrderRecordOptionSymbol;
41
42
  /**
42
- * Trade Action potential values include (but are not limited to) - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
43
+ * The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
43
44
  * @type {string}
44
45
  * @memberof AccountOrderRecord
45
46
  */
46
47
  'action'?: string;
47
48
  /**
48
- *
49
+ * The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
49
50
  * @type {number}
50
51
  * @memberof AccountOrderRecord
51
52
  */
52
53
  'total_quantity'?: number | null;
53
54
  /**
54
- * Trade Units
55
+ * The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
55
56
  * @type {number}
56
57
  * @memberof AccountOrderRecord
57
58
  */
58
59
  'open_quantity'?: number | null;
59
60
  /**
60
- * Trade Units
61
+ * The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
61
62
  * @type {number}
62
63
  * @memberof AccountOrderRecord
63
64
  */
64
65
  'canceled_quantity'?: number | null;
65
66
  /**
66
- * Trade Units
67
+ * The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
67
68
  * @type {number}
68
69
  * @memberof AccountOrderRecord
69
70
  */
70
71
  'filled_quantity'?: number | null;
71
72
  /**
72
- * Trade Price if limit or stop limit order
73
+ * The price at which the order was executed.
73
74
  * @type {number}
74
75
  * @memberof AccountOrderRecord
75
76
  */
76
77
  'execution_price'?: number | null;
77
78
  /**
78
- * Trade Price if limit or stop limit order
79
+ * The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders.
79
80
  * @type {number}
80
81
  * @memberof AccountOrderRecord
81
82
  */
82
83
  'limit_price'?: number | null;
83
84
  /**
84
- * Stop Price. If stop loss or stop limit order, the price to trigger the stop
85
+ * The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders.
85
86
  * @type {number}
86
87
  * @memberof AccountOrderRecord
87
88
  */
88
89
  'stop_price'?: number | null;
89
90
  /**
90
- * Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
91
+ * The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage\'s order type value.
91
92
  * @type {string}
92
93
  * @memberof AccountOrderRecord
93
94
  */
94
95
  'order_type'?: string | null;
95
96
  /**
96
- * Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled * GTD - Good Til Date
97
+ * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage\'s time in force value. - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. - `GTD` - Good Til Date. The order is valid until the specified date.
97
98
  * @type {string}
98
99
  * @memberof AccountOrderRecord
99
100
  */
100
101
  'time_in_force'?: string;
101
102
  /**
102
- * Time
103
+ * The time the order was placed. This is the time the order was submitted to the brokerage.
103
104
  * @type {string}
104
105
  * @memberof AccountOrderRecord
105
106
  */
106
107
  'time_placed'?: string;
107
108
  /**
108
- *
109
+ * The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
109
110
  * @type {string}
110
111
  * @memberof AccountOrderRecord
111
112
  */
112
113
  'time_updated'?: string | null;
113
114
  /**
114
- *
115
+ * The time the order was executed in the brokerage system. This value is not always available from the brokerage.
115
116
  * @type {string}
116
117
  * @memberof AccountOrderRecord
117
118
  */
118
119
  'time_executed'?: string | null;
119
120
  /**
120
- * Time
121
+ * The time the order expires. This value is not always available from the brokerage.
121
122
  * @type {string}
122
123
  * @memberof AccountOrderRecord
123
124
  */
124
- 'expiry_date'?: string;
125
+ 'expiry_date'?: string | null;
125
126
  }
@@ -1,6 +1,5 @@
1
1
  import { AccountBalance } from './account-balance';
2
2
  import { AccountSyncStatus } from './account-sync-status';
3
- import { CashRestriction } from './cash-restriction';
4
3
  /**
5
4
  * SnapTradeUser Investment Account
6
5
  * @export
@@ -59,11 +58,12 @@ export interface Account {
59
58
  [key: string]: any;
60
59
  };
61
60
  /**
62
- *
63
- * @type {Array<CashRestriction>}
61
+ * This field is deprecated.
62
+ * @type {Array<string>}
64
63
  * @memberof Account
64
+ * @deprecated
65
65
  */
66
- 'cash_restrictions'?: Array<CashRestriction>;
66
+ 'cash_restrictions'?: Array<string>;
67
67
  /**
68
68
  *
69
69
  * @type {AccountSyncStatus}
@@ -1,54 +1,54 @@
1
1
  /**
2
- * Stock Exchange
2
+ * Describes a single stock or crypto exchange.
3
3
  * @export
4
4
  * @interface Exchange
5
5
  */
6
6
  export interface Exchange {
7
7
  [key: string]: any;
8
8
  /**
9
- *
9
+ * Unique ID for the exchange in SnapTrade.
10
10
  * @type {string}
11
11
  * @memberof Exchange
12
12
  */
13
13
  'id'?: string;
14
14
  /**
15
- *
15
+ * A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
16
16
  * @type {string}
17
17
  * @memberof Exchange
18
18
  */
19
19
  'code'?: string;
20
20
  /**
21
- *
21
+ * The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
22
22
  * @type {string}
23
23
  * @memberof Exchange
24
24
  */
25
25
  'mic_code'?: string;
26
26
  /**
27
- *
27
+ * The full name of the exchange.
28
28
  * @type {string}
29
29
  * @memberof Exchange
30
30
  */
31
31
  'name'?: string;
32
32
  /**
33
- *
33
+ * The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
34
34
  * @type {string}
35
35
  * @memberof Exchange
36
36
  */
37
37
  'timezone'?: string;
38
38
  /**
39
- *
39
+ * The time when the exchange opens for trading.
40
40
  * @type {string}
41
41
  * @memberof Exchange
42
42
  */
43
43
  'start_time'?: string;
44
44
  /**
45
- *
45
+ * The time when the exchange closes for trading.
46
46
  * @type {string}
47
47
  * @memberof Exchange
48
48
  */
49
49
  'close_time'?: string;
50
50
  /**
51
- *
51
+ * The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
52
52
  * @type {string}
53
53
  * @memberof Exchange
54
54
  */
@@ -1,18 +1,18 @@
1
1
  /**
2
- * Open FIGI Identifiers
2
+ * Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information.
3
3
  * @export
4
4
  * @interface FigiInstrument
5
5
  */
6
6
  export interface FigiInstrument {
7
7
  [key: string]: any;
8
8
  /**
9
- *
9
+ * This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
10
10
  * @type {string}
11
11
  * @memberof FigiInstrument
12
12
  */
13
13
  'figi_code'?: string | null;
14
14
  /**
15
- *
15
+ * This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
16
16
  * @type {string}
17
17
  * @memberof FigiInstrument
18
18
  */
@@ -4,7 +4,9 @@ export * from './account-balance-total';
4
4
  export * from './account-holdings';
5
5
  export * from './account-holdings-account';
6
6
  export * from './account-order-record';
7
+ export * from './account-order-record-option-symbol';
7
8
  export * from './account-order-record-status';
9
+ export * from './account-order-record-universal-symbol';
8
10
  export * from './account-simple';
9
11
  export * from './account-sync-status';
10
12
  export * from './action-strict';
@@ -15,15 +17,9 @@ export * from './brokerage';
15
17
  export * from './brokerage-authorization';
16
18
  export * from './brokerage-authorization-disabled-confirmation';
17
19
  export * from './brokerage-authorization-refresh-confirmation';
18
- export * from './brokerage-authorization-type';
19
20
  export * from './brokerage-authorization-type-read-only';
20
21
  export * from './brokerage-authorization-type-read-only-brokerage';
21
- export * from './brokerage-symbol';
22
- export * from './brokerage-symbol-option-symbol';
23
- export * from './brokerage-symbol-symbol';
24
22
  export * from './brokerage-type';
25
- export * from './calculated-trade';
26
- export * from './cash-restriction';
27
23
  export * from './connections-session-events200-response-inner';
28
24
  export * from './currency';
29
25
  export * from './delete-user-response';
@@ -32,10 +28,8 @@ export * from './encrypted-response';
32
28
  export * from './encrypted-response-encrypted-message-data';
33
29
  export * from './exchange';
34
30
  export * from './exchange-rate-pairs';
35
- export * from './excluded-asset';
36
31
  export * from './figi-instrument';
37
32
  export * from './holdings-status';
38
- export * from './jwt';
39
33
  export * from './login-redirect-uri';
40
34
  export * from './manual-trade';
41
35
  export * from './manual-trade-and-impact';
@@ -51,13 +45,6 @@ export * from './model403-failed-request-response';
51
45
  export * from './model403-feature-not-enabled-response';
52
46
  export * from './model404-failed-request-response';
53
47
  export * from './model500-unexpected-exception-response';
54
- export * from './model-asset-class';
55
- export * from './model-asset-class-details';
56
- export * from './model-asset-class-target';
57
- export * from './model-portfolio';
58
- export * from './model-portfolio-asset-class';
59
- export * from './model-portfolio-details';
60
- export * from './model-portfolio-security';
61
48
  export * from './monthly-dividends';
62
49
  export * from './net-contributions';
63
50
  export * from './net-dividend';
@@ -78,16 +65,10 @@ export * from './order-type-strict';
78
65
  export * from './partner-data';
79
66
  export * from './past-value';
80
67
  export * from './performance-custom';
81
- export * from './portfolio-group';
82
- export * from './portfolio-group-info';
83
- export * from './portfolio-group-position';
84
- export * from './portfolio-group-settings';
85
68
  export * from './position';
86
69
  export * from './position-symbol';
87
- export * from './redirect-tokenand-pin';
88
70
  export * from './security-type';
89
71
  export * from './session-event';
90
- export * from './snap-trade-apidisclaimer-accept-status';
91
72
  export * from './snap-trade-holdings-account';
92
73
  export * from './snap-trade-holdings-account-account-id';
93
74
  export * from './snap-trade-holdings-account-account-id-balance';
@@ -95,11 +76,6 @@ export * from './snap-trade-holdings-total-value';
95
76
  export * from './snap-trade-login-user-request-body';
96
77
  export * from './snap-trade-register-user-request-body';
97
78
  export * from './status';
98
- export * from './strategy-impact';
99
- export * from './strategy-impact-legs-inner';
100
- export * from './strategy-order-place';
101
- export * from './strategy-order-place-orders-inner';
102
- export * from './strategy-order-place-orders-inner-legs-inner';
103
79
  export * from './strategy-order-record';
104
80
  export * from './strategy-quotes';
105
81
  export * from './strategy-quotes-greek';
@@ -108,18 +84,16 @@ export * from './symbol';
108
84
  export * from './symbol-figi-instrument';
109
85
  export * from './symbol-query';
110
86
  export * from './symbols-quotes-inner';
111
- export * from './target-asset';
112
87
  export * from './time-in-force-strict';
113
- export * from './trade';
114
- export * from './trade-execution-status';
115
- export * from './trade-impact';
116
88
  export * from './trading-cancel-user-account-order-request';
117
89
  export * from './transactions-status';
118
90
  export * from './usexchange';
119
91
  export * from './underlying-symbol';
92
+ export * from './underlying-symbol-exchange';
93
+ export * from './underlying-symbol-type';
120
94
  export * from './universal-activity';
121
95
  export * from './universal-symbol';
122
- export * from './user-error-log';
96
+ export * from './universal-symbol-currency';
97
+ export * from './universal-symbol-exchange';
123
98
  export * from './user-idand-secret';
124
- export * from './user-settings';
125
99
  export * from './validated-trade-body';
@@ -20,7 +20,9 @@ __exportStar(require("./account-balance-total"), exports);
20
20
  __exportStar(require("./account-holdings"), exports);
21
21
  __exportStar(require("./account-holdings-account"), exports);
22
22
  __exportStar(require("./account-order-record"), exports);
23
+ __exportStar(require("./account-order-record-option-symbol"), exports);
23
24
  __exportStar(require("./account-order-record-status"), exports);
25
+ __exportStar(require("./account-order-record-universal-symbol"), exports);
24
26
  __exportStar(require("./account-simple"), exports);
25
27
  __exportStar(require("./account-sync-status"), exports);
26
28
  __exportStar(require("./action-strict"), exports);
@@ -31,15 +33,9 @@ __exportStar(require("./brokerage"), exports);
31
33
  __exportStar(require("./brokerage-authorization"), exports);
32
34
  __exportStar(require("./brokerage-authorization-disabled-confirmation"), exports);
33
35
  __exportStar(require("./brokerage-authorization-refresh-confirmation"), exports);
34
- __exportStar(require("./brokerage-authorization-type"), exports);
35
36
  __exportStar(require("./brokerage-authorization-type-read-only"), exports);
36
37
  __exportStar(require("./brokerage-authorization-type-read-only-brokerage"), exports);
37
- __exportStar(require("./brokerage-symbol"), exports);
38
- __exportStar(require("./brokerage-symbol-option-symbol"), exports);
39
- __exportStar(require("./brokerage-symbol-symbol"), exports);
40
38
  __exportStar(require("./brokerage-type"), exports);
41
- __exportStar(require("./calculated-trade"), exports);
42
- __exportStar(require("./cash-restriction"), exports);
43
39
  __exportStar(require("./connections-session-events200-response-inner"), exports);
44
40
  __exportStar(require("./currency"), exports);
45
41
  __exportStar(require("./delete-user-response"), exports);
@@ -48,10 +44,8 @@ __exportStar(require("./encrypted-response"), exports);
48
44
  __exportStar(require("./encrypted-response-encrypted-message-data"), exports);
49
45
  __exportStar(require("./exchange"), exports);
50
46
  __exportStar(require("./exchange-rate-pairs"), exports);
51
- __exportStar(require("./excluded-asset"), exports);
52
47
  __exportStar(require("./figi-instrument"), exports);
53
48
  __exportStar(require("./holdings-status"), exports);
54
- __exportStar(require("./jwt"), exports);
55
49
  __exportStar(require("./login-redirect-uri"), exports);
56
50
  __exportStar(require("./manual-trade"), exports);
57
51
  __exportStar(require("./manual-trade-and-impact"), exports);
@@ -67,13 +61,6 @@ __exportStar(require("./model403-failed-request-response"), exports);
67
61
  __exportStar(require("./model403-feature-not-enabled-response"), exports);
68
62
  __exportStar(require("./model404-failed-request-response"), exports);
69
63
  __exportStar(require("./model500-unexpected-exception-response"), exports);
70
- __exportStar(require("./model-asset-class"), exports);
71
- __exportStar(require("./model-asset-class-details"), exports);
72
- __exportStar(require("./model-asset-class-target"), exports);
73
- __exportStar(require("./model-portfolio"), exports);
74
- __exportStar(require("./model-portfolio-asset-class"), exports);
75
- __exportStar(require("./model-portfolio-details"), exports);
76
- __exportStar(require("./model-portfolio-security"), exports);
77
64
  __exportStar(require("./monthly-dividends"), exports);
78
65
  __exportStar(require("./net-contributions"), exports);
79
66
  __exportStar(require("./net-dividend"), exports);
@@ -94,16 +81,10 @@ __exportStar(require("./order-type-strict"), exports);
94
81
  __exportStar(require("./partner-data"), exports);
95
82
  __exportStar(require("./past-value"), exports);
96
83
  __exportStar(require("./performance-custom"), exports);
97
- __exportStar(require("./portfolio-group"), exports);
98
- __exportStar(require("./portfolio-group-info"), exports);
99
- __exportStar(require("./portfolio-group-position"), exports);
100
- __exportStar(require("./portfolio-group-settings"), exports);
101
84
  __exportStar(require("./position"), exports);
102
85
  __exportStar(require("./position-symbol"), exports);
103
- __exportStar(require("./redirect-tokenand-pin"), exports);
104
86
  __exportStar(require("./security-type"), exports);
105
87
  __exportStar(require("./session-event"), exports);
106
- __exportStar(require("./snap-trade-apidisclaimer-accept-status"), exports);
107
88
  __exportStar(require("./snap-trade-holdings-account"), exports);
108
89
  __exportStar(require("./snap-trade-holdings-account-account-id"), exports);
109
90
  __exportStar(require("./snap-trade-holdings-account-account-id-balance"), exports);
@@ -111,11 +92,6 @@ __exportStar(require("./snap-trade-holdings-total-value"), exports);
111
92
  __exportStar(require("./snap-trade-login-user-request-body"), exports);
112
93
  __exportStar(require("./snap-trade-register-user-request-body"), exports);
113
94
  __exportStar(require("./status"), exports);
114
- __exportStar(require("./strategy-impact"), exports);
115
- __exportStar(require("./strategy-impact-legs-inner"), exports);
116
- __exportStar(require("./strategy-order-place"), exports);
117
- __exportStar(require("./strategy-order-place-orders-inner"), exports);
118
- __exportStar(require("./strategy-order-place-orders-inner-legs-inner"), exports);
119
95
  __exportStar(require("./strategy-order-record"), exports);
120
96
  __exportStar(require("./strategy-quotes"), exports);
121
97
  __exportStar(require("./strategy-quotes-greek"), exports);
@@ -124,18 +100,16 @@ __exportStar(require("./symbol"), exports);
124
100
  __exportStar(require("./symbol-figi-instrument"), exports);
125
101
  __exportStar(require("./symbol-query"), exports);
126
102
  __exportStar(require("./symbols-quotes-inner"), exports);
127
- __exportStar(require("./target-asset"), exports);
128
103
  __exportStar(require("./time-in-force-strict"), exports);
129
- __exportStar(require("./trade"), exports);
130
- __exportStar(require("./trade-execution-status"), exports);
131
- __exportStar(require("./trade-impact"), exports);
132
104
  __exportStar(require("./trading-cancel-user-account-order-request"), exports);
133
105
  __exportStar(require("./transactions-status"), exports);
134
106
  __exportStar(require("./usexchange"), exports);
135
107
  __exportStar(require("./underlying-symbol"), exports);
108
+ __exportStar(require("./underlying-symbol-exchange"), exports);
109
+ __exportStar(require("./underlying-symbol-type"), exports);
136
110
  __exportStar(require("./universal-activity"), exports);
137
111
  __exportStar(require("./universal-symbol"), exports);
138
- __exportStar(require("./user-error-log"), exports);
112
+ __exportStar(require("./universal-symbol-currency"), exports);
113
+ __exportStar(require("./universal-symbol-exchange"), exports);
139
114
  __exportStar(require("./user-idand-secret"), exports);
140
- __exportStar(require("./user-settings"), exports);
141
115
  __exportStar(require("./validated-trade-body"), exports);
@@ -7,7 +7,7 @@ import { DividendAtDate } from './dividend-at-date';
7
7
  export interface MonthlyDividends {
8
8
  [key: string]: any;
9
9
  /**
10
- * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
10
+ * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
11
11
  * @type {string}
12
12
  * @memberof MonthlyDividends
13
13
  */
@@ -6,7 +6,7 @@
6
6
  export interface NetContributions {
7
7
  [key: string]: any;
8
8
  /**
9
- * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
9
+ * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
10
10
  * @type {string}
11
11
  * @memberof NetContributions
12
12
  */