snaptrade 2.0.31 → 2.0.33

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +31 -29
  3. data/README.md +4 -2
  4. data/lib/snaptrade/api/account_information_api.rb +6 -2
  5. data/lib/snaptrade/models/account.rb +2 -1
  6. data/lib/snaptrade/models/account_holdings_account.rb +2 -2
  7. data/lib/snaptrade/models/account_order_record.rb +25 -19
  8. data/lib/snaptrade/models/{brokerage_symbol_option_symbol.rb → account_order_record_option_symbol.rb} +15 -26
  9. data/lib/snaptrade/models/{brokerage_symbol_symbol.rb → account_order_record_universal_symbol.rb} +12 -5
  10. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +1 -1
  11. data/lib/snaptrade/models/exchange.rb +9 -1
  12. data/lib/snaptrade/models/figi_instrument.rb +3 -1
  13. data/lib/snaptrade/models/monthly_dividends.rb +1 -1
  14. data/lib/snaptrade/models/net_contributions.rb +1 -1
  15. data/lib/snaptrade/models/option_brokerage_symbol.rb +3 -1
  16. data/lib/snaptrade/models/options_position.rb +1 -1
  17. data/lib/snaptrade/models/options_position_currency.rb +1 -0
  18. data/lib/snaptrade/models/options_symbol.rb +12 -24
  19. data/lib/snaptrade/models/order_type_strict.rb +2 -2
  20. data/lib/snaptrade/models/past_value.rb +1 -1
  21. data/lib/snaptrade/models/position_symbol.rb +6 -1
  22. data/lib/snaptrade/models/security_type.rb +5 -1
  23. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +1 -1
  24. data/lib/snaptrade/models/strategy_order_record.rb +1 -1
  25. data/lib/snaptrade/models/sub_period_return_rate.rb +2 -2
  26. data/lib/snaptrade/models/symbol_figi_instrument.rb +2 -0
  27. data/lib/snaptrade/models/type.rb +3 -3
  28. data/lib/snaptrade/models/underlying_symbol.rb +20 -5
  29. data/lib/snaptrade/models/{model_portfolio.rb → underlying_symbol_exchange.rb} +73 -12
  30. data/lib/snaptrade/models/{brokerage_symbol.rb → underlying_symbol_type.rb} +28 -38
  31. data/lib/snaptrade/models/universal_symbol.rb +9 -3
  32. data/lib/snaptrade/models/{portfolio_group.rb → universal_symbol_currency.rb} +24 -4
  33. data/lib/snaptrade/models/{model_asset_class.rb → universal_symbol_exchange.rb} +78 -7
  34. data/lib/snaptrade/version.rb +1 -1
  35. data/lib/snaptrade.rb +6 -38
  36. data/spec/api/account_information_api_spec.rb +1 -1
  37. data/spec/models/{strategy_impact_legs_inner_spec.rb → account_order_record_option_symbol_spec.rb} +13 -13
  38. data/spec/models/{brokerage_symbol_symbol_spec.rb → account_order_record_universal_symbol_spec.rb} +6 -6
  39. data/spec/models/options_symbol_spec.rb +0 -12
  40. data/spec/models/{brokerage_symbol_option_symbol_spec.rb → underlying_symbol_exchange_spec.rb} +14 -14
  41. data/spec/models/underlying_symbol_spec.rb +6 -0
  42. data/spec/models/{cash_restriction_spec.rb → underlying_symbol_type_spec.rb} +9 -15
  43. data/spec/models/{model_portfolio_spec.rb → universal_symbol_currency_spec.rb} +8 -8
  44. data/spec/models/{trade_spec.rb → universal_symbol_exchange_spec.rb} +13 -13
  45. metadata +117 -213
  46. data/lib/snaptrade/models/brokerage_authorization_type.rb +0 -216
  47. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +0 -37
  48. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +0 -37
  49. data/lib/snaptrade/models/calculated_trade.rb +0 -228
  50. data/lib/snaptrade/models/cash_restriction.rb +0 -253
  51. data/lib/snaptrade/models/excluded_asset.rb +0 -217
  52. data/lib/snaptrade/models/jwt.rb +0 -217
  53. data/lib/snaptrade/models/model_asset_class_details.rb +0 -227
  54. data/lib/snaptrade/models/model_asset_class_target.rb +0 -216
  55. data/lib/snaptrade/models/model_portfolio_asset_class.rb +0 -249
  56. data/lib/snaptrade/models/model_portfolio_details.rb +0 -238
  57. data/lib/snaptrade/models/model_portfolio_security.rb +0 -249
  58. data/lib/snaptrade/models/model_type.rb +0 -38
  59. data/lib/snaptrade/models/portfolio_group_info.rb +0 -325
  60. data/lib/snaptrade/models/portfolio_group_position.rb +0 -237
  61. data/lib/snaptrade/models/portfolio_group_settings.rb +0 -276
  62. data/lib/snaptrade/models/redirect_tokenand_pin.rb +0 -226
  63. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +0 -226
  64. data/lib/snaptrade/models/state.rb +0 -40
  65. data/lib/snaptrade/models/strategy_impact.rb +0 -309
  66. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +0 -270
  67. data/lib/snaptrade/models/strategy_order_place.rb +0 -228
  68. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +0 -596
  69. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +0 -270
  70. data/lib/snaptrade/models/target_asset.rb +0 -289
  71. data/lib/snaptrade/models/trade.rb +0 -280
  72. data/lib/snaptrade/models/trade_action.rb +0 -37
  73. data/lib/snaptrade/models/trade_execution_status.rb +0 -297
  74. data/lib/snaptrade/models/trade_execution_status_action.rb +0 -37
  75. data/lib/snaptrade/models/trade_impact.rb +0 -256
  76. data/lib/snaptrade/models/user_error_log.rb +0 -262
  77. data/lib/snaptrade/models/user_settings.rb +0 -298
  78. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +0 -23
  79. data/spec/models/brokerage_authorization_type_spec.rb +0 -29
  80. data/spec/models/brokerage_authorization_type_type_spec.rb +0 -23
  81. data/spec/models/brokerage_symbol_spec.rb +0 -59
  82. data/spec/models/calculated_trade_spec.rb +0 -35
  83. data/spec/models/excluded_asset_spec.rb +0 -29
  84. data/spec/models/jwt_spec.rb +0 -29
  85. data/spec/models/model_asset_class_details_spec.rb +0 -35
  86. data/spec/models/model_asset_class_spec.rb +0 -35
  87. data/spec/models/model_asset_class_target_spec.rb +0 -29
  88. data/spec/models/model_portfolio_asset_class_spec.rb +0 -35
  89. data/spec/models/model_portfolio_details_spec.rb +0 -41
  90. data/spec/models/model_portfolio_security_spec.rb +0 -35
  91. data/spec/models/model_type_spec.rb +0 -23
  92. data/spec/models/portfolio_group_info_spec.rb +0 -89
  93. data/spec/models/portfolio_group_position_spec.rb +0 -41
  94. data/spec/models/portfolio_group_settings_spec.rb +0 -53
  95. data/spec/models/portfolio_group_spec.rb +0 -35
  96. data/spec/models/redirect_tokenand_pin_spec.rb +0 -35
  97. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +0 -35
  98. data/spec/models/state_spec.rb +0 -23
  99. data/spec/models/strategy_impact_spec.rb +0 -89
  100. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +0 -65
  101. data/spec/models/strategy_order_place_orders_inner_spec.rb +0 -281
  102. data/spec/models/strategy_order_place_spec.rb +0 -35
  103. data/spec/models/target_asset_spec.rb +0 -59
  104. data/spec/models/trade_action_spec.rb +0 -23
  105. data/spec/models/trade_execution_status_action_spec.rb +0 -23
  106. data/spec/models/trade_execution_status_spec.rb +0 -77
  107. data/spec/models/trade_impact_spec.rb +0 -53
  108. data/spec/models/user_error_log_spec.rb +0 -59
  109. data/spec/models/user_settings_spec.rb +0 -83
@@ -11,26 +11,28 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- # Options Symbol
14
+ # Uniquely describes an option security + exchange combination across all brokerages.
15
15
  class OptionsSymbol
16
+ # Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
16
17
  attr_accessor :id
17
18
 
19
+ # The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
18
20
  attr_accessor :ticker
19
21
 
22
+ # The type of option. Either \"CALL\" or \"PUT\".
20
23
  attr_accessor :option_type
21
24
 
25
+ # The option strike price.
22
26
  attr_accessor :strike_price
23
27
 
28
+ # The option expiration date.
24
29
  attr_accessor :expiration_date
25
30
 
31
+ # Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
26
32
  attr_accessor :is_mini_option
27
33
 
28
34
  attr_accessor :underlying_symbol
29
35
 
30
- attr_accessor :local_id
31
-
32
- attr_accessor :exchange_id
33
-
34
36
  # Attribute mapping from ruby-style variable name to JSON key.
35
37
  def self.attribute_map
36
38
  {
@@ -40,9 +42,7 @@ module SnapTrade
40
42
  :'strike_price' => :'strike_price',
41
43
  :'expiration_date' => :'expiration_date',
42
44
  :'is_mini_option' => :'is_mini_option',
43
- :'underlying_symbol' => :'underlying_symbol',
44
- :'local_id' => :'local_id',
45
- :'exchange_id' => :'exchange_id'
45
+ :'underlying_symbol' => :'underlying_symbol'
46
46
  }
47
47
  end
48
48
 
@@ -58,11 +58,9 @@ module SnapTrade
58
58
  :'ticker' => :'String',
59
59
  :'option_type' => :'OptionType',
60
60
  :'strike_price' => :'Float',
61
- :'expiration_date' => :'String',
61
+ :'expiration_date' => :'Date',
62
62
  :'is_mini_option' => :'Boolean',
63
- :'underlying_symbol' => :'UnderlyingSymbol',
64
- :'local_id' => :'String',
65
- :'exchange_id' => :'String'
63
+ :'underlying_symbol' => :'UnderlyingSymbol'
66
64
  }
67
65
  end
68
66
 
@@ -114,14 +112,6 @@ module SnapTrade
114
112
  if attributes.key?(:'underlying_symbol')
115
113
  self.underlying_symbol = attributes[:'underlying_symbol']
116
114
  end
117
-
118
- if attributes.key?(:'local_id')
119
- self.local_id = attributes[:'local_id']
120
- end
121
-
122
- if attributes.key?(:'exchange_id')
123
- self.exchange_id = attributes[:'exchange_id']
124
- end
125
115
  end
126
116
 
127
117
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -178,9 +168,7 @@ module SnapTrade
178
168
  strike_price == o.strike_price &&
179
169
  expiration_date == o.expiration_date &&
180
170
  is_mini_option == o.is_mini_option &&
181
- underlying_symbol == o.underlying_symbol &&
182
- local_id == o.local_id &&
183
- exchange_id == o.exchange_id
171
+ underlying_symbol == o.underlying_symbol
184
172
  end
185
173
 
186
174
  # @see the `==` method
@@ -192,7 +180,7 @@ module SnapTrade
192
180
  # Calculates hash code according to all attributes.
193
181
  # @return [Integer] Hash code
194
182
  def hash
195
- [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol, local_id, exchange_id].hash
183
+ [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol].hash
196
184
  end
197
185
 
198
186
  # Builds the object from hash
@@ -15,10 +15,10 @@ module SnapTrade
15
15
  LIMIT = "Limit".freeze
16
16
  MARKET = "Market".freeze
17
17
  STOP_LIMIT = "StopLimit".freeze
18
- STOP_LOSS = "StopLoss".freeze
18
+ STOP = "Stop".freeze
19
19
 
20
20
  def self.all_vars
21
- @all_vars ||= [LIMIT, MARKET, STOP_LIMIT, STOP_LOSS].freeze
21
+ @all_vars ||= [LIMIT, MARKET, STOP_LIMIT, STOP].freeze
22
22
  end
23
23
 
24
24
  # Builds the enum from string
@@ -12,7 +12,7 @@ require 'time'
12
12
 
13
13
  module SnapTrade
14
14
  class PastValue
15
- # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
15
+ # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
16
16
  attr_accessor :date
17
17
 
18
18
  attr_accessor :value
@@ -11,18 +11,23 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- # Symbol returned in position object
14
+ # Uniquely describes a security for the position within an account. The distinction between this and the `symbol` child property is that this object is specific to a position within an account, while the `symbol` child property is universal across all brokerage accounts. The caller should rely on the `symbol` child property for most use cases.
15
15
  class PositionSymbol
16
+ # 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.
16
17
  attr_accessor :id
17
18
 
19
+ # This field is deprecated and the caller should use the `symbol` child property's `description` instead.
18
20
  attr_accessor :description
19
21
 
20
22
  attr_accessor :symbol
21
23
 
24
+ # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
22
25
  attr_accessor :local_id
23
26
 
27
+ # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
24
28
  attr_accessor :is_quotable
25
29
 
30
+ # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
26
31
  attr_accessor :is_tradable
27
32
 
28
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -11,14 +11,18 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- # Security Type
14
+ # The type of security. For example, \"Common Stock\" or \"ETF\".
15
15
  class SecurityType
16
+ # Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
16
17
  attr_accessor :id
17
18
 
19
+ # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values: ad - ADR bnd - Bond cs - Common Stock cef - Closed End Fund et - ETF oef - Open Ended Fund ps - Preferred Stock rt - Right struct - Structured Product ut - Unit wi - When Issued wt - Warrant
18
20
  attr_accessor :code
19
21
 
22
+ # A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".
20
23
  attr_accessor :description
21
24
 
25
+ # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
22
26
  attr_accessor :is_supported
23
27
 
24
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -74,7 +74,7 @@ module SnapTrade
74
74
  :'institution_name' => :'String',
75
75
  :'balance' => :'SnapTradeHoldingsAccountAccountIdBalance',
76
76
  :'meta' => :'Hash<String, Object>',
77
- :'cash_restrictions' => :'Array<CashRestriction>',
77
+ :'cash_restrictions' => :'Array<String>',
78
78
  :'created_date' => :'Time'
79
79
  }
80
80
  end
@@ -23,7 +23,7 @@ module SnapTrade
23
23
 
24
24
  attr_accessor :closed_quantity
25
25
 
26
- # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
26
+ # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - Stop
27
27
  attr_accessor :order_type
28
28
 
29
29
  # Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled * GTD - Good Til Date
@@ -12,10 +12,10 @@ require 'time'
12
12
 
13
13
  module SnapTrade
14
14
  class SubPeriodReturnRate
15
- # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
15
+ # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
16
16
  attr_accessor :period_start
17
17
 
18
- # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
18
+ # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
19
19
  attr_accessor :period_end
20
20
 
21
21
  # The return rate for the given period
@@ -12,8 +12,10 @@ require 'time'
12
12
 
13
13
  module SnapTrade
14
14
  class SymbolFigiInstrument
15
+ # 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.
15
16
  attr_accessor :figi_code
16
17
 
18
+ # 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.
17
19
  attr_accessor :figi_share_class
18
20
 
19
21
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -12,11 +12,11 @@ require 'time'
12
12
 
13
13
  module SnapTrade
14
14
  class Type
15
- ALLOCATE_MAX = "ALLOCATE_MAX".freeze
16
- RETAIN_MIN = "RETAIN_MIN".freeze
15
+ READ = "read".freeze
16
+ TRADE = "trade".freeze
17
17
 
18
18
  def self.all_vars
19
- @all_vars ||= [ALLOCATE_MAX, RETAIN_MIN].freeze
19
+ @all_vars ||= [READ, TRADE].freeze
20
20
  end
21
21
 
22
22
  # Builds the enum from string
@@ -11,12 +11,18 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- # Underlying Symbol
14
+ # Symbol object for the underlying security of an option.
15
15
  class UnderlyingSymbol
16
+ # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
16
17
  attr_accessor :id
17
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.
18
20
  attr_accessor :symbol
19
21
 
22
+ # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
23
+ attr_accessor :raw_symbol
24
+
25
+ # A human-readable description of the security. This is usually the company name or ETF name.
20
26
  attr_accessor :description
21
27
 
22
28
  attr_accessor :currency
@@ -25,8 +31,10 @@ module SnapTrade
25
31
 
26
32
  attr_accessor :type
27
33
 
34
+ # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
28
35
  attr_accessor :currencies
29
36
 
37
+ # 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.
30
38
  attr_accessor :figi_code
31
39
 
32
40
  attr_accessor :figi_instrument
@@ -36,6 +44,7 @@ module SnapTrade
36
44
  {
37
45
  :'id' => :'id',
38
46
  :'symbol' => :'symbol',
47
+ :'raw_symbol' => :'raw_symbol',
39
48
  :'description' => :'description',
40
49
  :'currency' => :'currency',
41
50
  :'exchange' => :'exchange',
@@ -56,10 +65,11 @@ module SnapTrade
56
65
  {
57
66
  :'id' => :'String',
58
67
  :'symbol' => :'String',
68
+ :'raw_symbol' => :'String',
59
69
  :'description' => :'String',
60
- :'currency' => :'Currency',
61
- :'exchange' => :'USExchange',
62
- :'type' => :'SecurityType',
70
+ :'currency' => :'UniversalSymbolCurrency',
71
+ :'exchange' => :'UnderlyingSymbolExchange',
72
+ :'type' => :'UnderlyingSymbolType',
63
73
  :'currencies' => :'Array<Currency>',
64
74
  :'figi_code' => :'String',
65
75
  :'figi_instrument' => :'SymbolFigiInstrument'
@@ -98,6 +108,10 @@ module SnapTrade
98
108
  self.symbol = attributes[:'symbol']
99
109
  end
100
110
 
111
+ if attributes.key?(:'raw_symbol')
112
+ self.raw_symbol = attributes[:'raw_symbol']
113
+ end
114
+
101
115
  if attributes.key?(:'description')
102
116
  self.description = attributes[:'description']
103
117
  end
@@ -149,6 +163,7 @@ module SnapTrade
149
163
  self.class == o.class &&
150
164
  id == o.id &&
151
165
  symbol == o.symbol &&
166
+ raw_symbol == o.raw_symbol &&
152
167
  description == o.description &&
153
168
  currency == o.currency &&
154
169
  exchange == o.exchange &&
@@ -167,7 +182,7 @@ module SnapTrade
167
182
  # Calculates hash code according to all attributes.
168
183
  # @return [Integer] Hash code
169
184
  def hash
170
- [id, symbol, description, currency, exchange, type, currencies, figi_code, figi_instrument].hash
185
+ [id, symbol, raw_symbol, description, currency, exchange, type, currencies, figi_code, figi_instrument].hash
171
186
  end
172
187
 
173
188
  # Builds the object from hash
@@ -11,19 +11,38 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- class ModelPortfolio
14
+ # The exchange on which the security is listed and traded.
15
+ class UnderlyingSymbolExchange
15
16
  attr_accessor :id
16
17
 
18
+ attr_accessor :code
19
+
20
+ attr_accessor :mic_code
21
+
17
22
  attr_accessor :name
18
23
 
19
- attr_accessor :model_type
24
+ attr_accessor :timezone
25
+
26
+ attr_accessor :start_time
27
+
28
+ attr_accessor :close_time
29
+
30
+ attr_accessor :suffix
31
+
32
+ attr_accessor :allows_cryptocurrency_symbols
20
33
 
21
34
  # Attribute mapping from ruby-style variable name to JSON key.
22
35
  def self.attribute_map
23
36
  {
24
37
  :'id' => :'id',
38
+ :'code' => :'code',
39
+ :'mic_code' => :'mic_code',
25
40
  :'name' => :'name',
26
- :'model_type' => :'model_type'
41
+ :'timezone' => :'timezone',
42
+ :'start_time' => :'start_time',
43
+ :'close_time' => :'close_time',
44
+ :'suffix' => :'suffix',
45
+ :'allows_cryptocurrency_symbols' => :'allows_cryptocurrency_symbols'
27
46
  }
28
47
  end
29
48
 
@@ -36,28 +55,42 @@ module SnapTrade
36
55
  def self.openapi_types
37
56
  {
38
57
  :'id' => :'String',
58
+ :'code' => :'String',
59
+ :'mic_code' => :'String',
39
60
  :'name' => :'String',
40
- :'model_type' => :'ModelType'
61
+ :'timezone' => :'String',
62
+ :'start_time' => :'String',
63
+ :'close_time' => :'String',
64
+ :'suffix' => :'String',
65
+ :'allows_cryptocurrency_symbols' => :'Boolean'
41
66
  }
42
67
  end
43
68
 
44
69
  # List of attributes with nullable: true
45
70
  def self.openapi_nullable
46
71
  Set.new([
72
+ :'suffix',
47
73
  ])
48
74
  end
49
75
 
76
+ # List of class defined in allOf (OpenAPI v3)
77
+ def self.openapi_all_of
78
+ [
79
+ :'USExchange'
80
+ ]
81
+ end
82
+
50
83
  # Initializes the object
51
84
  # @param [Hash] attributes Model attributes in the form of hash
52
85
  def initialize(attributes = {})
53
86
  if (!attributes.is_a?(Hash))
54
- fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::ModelPortfolio` initialize method"
87
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::UnderlyingSymbolExchange` initialize method"
55
88
  end
56
89
 
57
90
  # check to see if the attribute exists and convert string to symbol for hash key
58
91
  attributes = attributes.each_with_object({}) { |(k, v), h|
59
92
  if (!self.class.attribute_map.key?(k.to_sym))
60
- fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::ModelPortfolio`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
93
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::UnderlyingSymbolExchange`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
61
94
  end
62
95
  h[k.to_sym] = v
63
96
  }
@@ -66,14 +99,36 @@ module SnapTrade
66
99
  self.id = attributes[:'id']
67
100
  end
68
101
 
102
+ if attributes.key?(:'code')
103
+ self.code = attributes[:'code']
104
+ end
105
+
106
+ if attributes.key?(:'mic_code')
107
+ self.mic_code = attributes[:'mic_code']
108
+ end
109
+
69
110
  if attributes.key?(:'name')
70
111
  self.name = attributes[:'name']
71
112
  end
72
113
 
73
- if attributes.key?(:'model_type')
74
- self.model_type = attributes[:'model_type']
75
- else
76
- self.model_type = ModelType::NMINUS_1
114
+ if attributes.key?(:'timezone')
115
+ self.timezone = attributes[:'timezone']
116
+ end
117
+
118
+ if attributes.key?(:'start_time')
119
+ self.start_time = attributes[:'start_time']
120
+ end
121
+
122
+ if attributes.key?(:'close_time')
123
+ self.close_time = attributes[:'close_time']
124
+ end
125
+
126
+ if attributes.key?(:'suffix')
127
+ self.suffix = attributes[:'suffix']
128
+ end
129
+
130
+ if attributes.key?(:'allows_cryptocurrency_symbols')
131
+ self.allows_cryptocurrency_symbols = attributes[:'allows_cryptocurrency_symbols']
77
132
  end
78
133
  end
79
134
 
@@ -96,8 +151,14 @@ module SnapTrade
96
151
  return true if self.equal?(o)
97
152
  self.class == o.class &&
98
153
  id == o.id &&
154
+ code == o.code &&
155
+ mic_code == o.mic_code &&
99
156
  name == o.name &&
100
- model_type == o.model_type
157
+ timezone == o.timezone &&
158
+ start_time == o.start_time &&
159
+ close_time == o.close_time &&
160
+ suffix == o.suffix &&
161
+ allows_cryptocurrency_symbols == o.allows_cryptocurrency_symbols
101
162
  end
102
163
 
103
164
  # @see the `==` method
@@ -109,7 +170,7 @@ module SnapTrade
109
170
  # Calculates hash code according to all attributes.
110
171
  # @return [Integer] Hash code
111
172
  def hash
112
- [id, name, model_type].hash
173
+ [id, code, mic_code, name, timezone, start_time, close_time, suffix, allows_cryptocurrency_symbols].hash
113
174
  end
114
175
 
115
176
  # Builds the object from hash
@@ -11,29 +11,27 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- # Brokerage symbol
15
- class BrokerageSymbol
14
+ # The type of security. For example, \"Common Stock\" or \"ETF\".
15
+ class UnderlyingSymbolType
16
+ # Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
16
17
  attr_accessor :id
17
18
 
18
- attr_accessor :symbol
19
-
20
- attr_accessor :brokerage_authorization
19
+ # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values: ad - ADR bnd - Bond cs - Common Stock cef - Closed End Fund et - ETF oef - Open Ended Fund ps - Preferred Stock rt - Right struct - Structured Product ut - Unit wi - When Issued wt - Warrant
20
+ attr_accessor :code
21
21
 
22
+ # A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".
22
23
  attr_accessor :description
23
24
 
24
- attr_accessor :allows_fractional_units
25
-
26
- attr_accessor :option_symbol
25
+ # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
26
+ attr_accessor :is_supported
27
27
 
28
28
  # Attribute mapping from ruby-style variable name to JSON key.
29
29
  def self.attribute_map
30
30
  {
31
31
  :'id' => :'id',
32
- :'symbol' => :'symbol',
33
- :'brokerage_authorization' => :'brokerage_authorization',
32
+ :'code' => :'code',
34
33
  :'description' => :'description',
35
- :'allows_fractional_units' => :'allows_fractional_units',
36
- :'option_symbol' => :'option_symbol'
34
+ :'is_supported' => :'is_supported'
37
35
  }
38
36
  end
39
37
 
@@ -46,34 +44,36 @@ module SnapTrade
46
44
  def self.openapi_types
47
45
  {
48
46
  :'id' => :'String',
49
- :'symbol' => :'BrokerageSymbolSymbol',
50
- :'brokerage_authorization' => :'BrokerageAuthorization',
47
+ :'code' => :'String',
51
48
  :'description' => :'String',
52
- :'allows_fractional_units' => :'Boolean',
53
- :'option_symbol' => :'BrokerageSymbolOptionSymbol'
49
+ :'is_supported' => :'Boolean'
54
50
  }
55
51
  end
56
52
 
57
53
  # List of attributes with nullable: true
58
54
  def self.openapi_nullable
59
55
  Set.new([
60
- :'symbol',
61
- :'allows_fractional_units',
62
- :'option_symbol'
63
56
  ])
64
57
  end
65
58
 
59
+ # List of class defined in allOf (OpenAPI v3)
60
+ def self.openapi_all_of
61
+ [
62
+ :'SecurityType'
63
+ ]
64
+ end
65
+
66
66
  # Initializes the object
67
67
  # @param [Hash] attributes Model attributes in the form of hash
68
68
  def initialize(attributes = {})
69
69
  if (!attributes.is_a?(Hash))
70
- fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BrokerageSymbol` initialize method"
70
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::UnderlyingSymbolType` initialize method"
71
71
  end
72
72
 
73
73
  # check to see if the attribute exists and convert string to symbol for hash key
74
74
  attributes = attributes.each_with_object({}) { |(k, v), h|
75
75
  if (!self.class.attribute_map.key?(k.to_sym))
76
- fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::BrokerageSymbol`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
76
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::UnderlyingSymbolType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
77
  end
78
78
  h[k.to_sym] = v
79
79
  }
@@ -82,24 +82,16 @@ module SnapTrade
82
82
  self.id = attributes[:'id']
83
83
  end
84
84
 
85
- if attributes.key?(:'symbol')
86
- self.symbol = attributes[:'symbol']
87
- end
88
-
89
- if attributes.key?(:'brokerage_authorization')
90
- self.brokerage_authorization = attributes[:'brokerage_authorization']
85
+ if attributes.key?(:'code')
86
+ self.code = attributes[:'code']
91
87
  end
92
88
 
93
89
  if attributes.key?(:'description')
94
90
  self.description = attributes[:'description']
95
91
  end
96
92
 
97
- if attributes.key?(:'allows_fractional_units')
98
- self.allows_fractional_units = attributes[:'allows_fractional_units']
99
- end
100
-
101
- if attributes.key?(:'option_symbol')
102
- self.option_symbol = attributes[:'option_symbol']
93
+ if attributes.key?(:'is_supported')
94
+ self.is_supported = attributes[:'is_supported']
103
95
  end
104
96
  end
105
97
 
@@ -122,11 +114,9 @@ module SnapTrade
122
114
  return true if self.equal?(o)
123
115
  self.class == o.class &&
124
116
  id == o.id &&
125
- symbol == o.symbol &&
126
- brokerage_authorization == o.brokerage_authorization &&
117
+ code == o.code &&
127
118
  description == o.description &&
128
- allows_fractional_units == o.allows_fractional_units &&
129
- option_symbol == o.option_symbol
119
+ is_supported == o.is_supported
130
120
  end
131
121
 
132
122
  # @see the `==` method
@@ -138,7 +128,7 @@ module SnapTrade
138
128
  # Calculates hash code according to all attributes.
139
129
  # @return [Integer] Hash code
140
130
  def hash
141
- [id, symbol, brokerage_authorization, description, allows_fractional_units, option_symbol].hash
131
+ [id, code, description, is_supported].hash
142
132
  end
143
133
 
144
134
  # Builds the object from hash
@@ -11,14 +11,18 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- # Universal symbol
14
+ # Uniquely describes a single security + exchange combination across all brokerages.
15
15
  class UniversalSymbol
16
+ # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
16
17
  attr_accessor :id
17
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.
18
20
  attr_accessor :symbol
19
21
 
22
+ # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
20
23
  attr_accessor :raw_symbol
21
24
 
25
+ # A human-readable description of the security. This is usually the company name or ETF name.
22
26
  attr_accessor :description
23
27
 
24
28
  attr_accessor :currency
@@ -27,8 +31,10 @@ module SnapTrade
27
31
 
28
32
  attr_accessor :type
29
33
 
34
+ # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
30
35
  attr_accessor :currencies
31
36
 
37
+ # 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.
32
38
  attr_accessor :figi_code
33
39
 
34
40
  attr_accessor :figi_instrument
@@ -61,8 +67,8 @@ module SnapTrade
61
67
  :'symbol' => :'String',
62
68
  :'raw_symbol' => :'String',
63
69
  :'description' => :'String',
64
- :'currency' => :'Currency',
65
- :'exchange' => :'Exchange',
70
+ :'currency' => :'UniversalSymbolCurrency',
71
+ :'exchange' => :'UniversalSymbolExchange',
66
72
  :'type' => :'SecurityType',
67
73
  :'currencies' => :'Array<Currency>',
68
74
  :'figi_code' => :'String',