snaptrade 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (422) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +10 -0
  3. data/Gemfile.lock +84 -0
  4. data/README.md +254 -0
  5. data/Rakefile +10 -0
  6. data/docs/APIStatusApi.md +57 -0
  7. data/docs/Account.md +36 -0
  8. data/docs/AccountHoldings.md +24 -0
  9. data/docs/AccountHoldingsAccount.md +26 -0
  10. data/docs/AccountInformationApi.md +535 -0
  11. data/docs/AccountOrderRecord.md +52 -0
  12. data/docs/AccountOrderRecordStatus.md +15 -0
  13. data/docs/AccountSimple.md +24 -0
  14. data/docs/AccountSyncStatus.md +18 -0
  15. data/docs/Action.md +15 -0
  16. data/docs/AuthType.md +15 -0
  17. data/docs/AuthenticationApi.md +314 -0
  18. data/docs/AuthenticationLoginSnapTradeUser200Response.md +49 -0
  19. data/docs/Balance.md +20 -0
  20. data/docs/Brokerage.md +52 -0
  21. data/docs/BrokerageAuthorization.md +34 -0
  22. data/docs/BrokerageAuthorizationType.md +18 -0
  23. data/docs/BrokerageAuthorizationTypeReadOnly.md +24 -0
  24. data/docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md +22 -0
  25. data/docs/BrokerageAuthorizationTypeReadOnlyType.md +15 -0
  26. data/docs/BrokerageAuthorizationTypeType.md +15 -0
  27. data/docs/BrokerageSymbol.md +26 -0
  28. data/docs/BrokerageType.md +20 -0
  29. data/docs/CalculatedTrade.md +20 -0
  30. data/docs/CashRestriction.md +26 -0
  31. data/docs/ConnectionType.md +15 -0
  32. data/docs/ConnectionsApi.md +265 -0
  33. data/docs/ConnectionsSessionEvents200ResponseInner.md +30 -0
  34. data/docs/Currency.md +22 -0
  35. data/docs/DeleteUserResponse.md +20 -0
  36. data/docs/DividendAtDate.md +22 -0
  37. data/docs/EncryptedResponse.md +20 -0
  38. data/docs/EncryptedResponseEncryptedMessageData.md +22 -0
  39. data/docs/ErrorLogsApi.md +68 -0
  40. data/docs/Exchange.md +32 -0
  41. data/docs/ExchangeRatePairs.md +22 -0
  42. data/docs/ExcludedAsset.md +18 -0
  43. data/docs/JWT.md +18 -0
  44. data/docs/LoginRedirectURI.md +20 -0
  45. data/docs/ManualTrade.md +32 -0
  46. data/docs/ManualTradeAndImpact.md +22 -0
  47. data/docs/ManualTradeBalance.md +22 -0
  48. data/docs/ManualTradeForm.md +32 -0
  49. data/docs/ManualTradeSymbol.md +28 -0
  50. data/docs/Model400FailedRequestResponse.md +20 -0
  51. data/docs/Model401FailedRequestResponse.md +20 -0
  52. data/docs/Model403FailedRequestResponse.md +20 -0
  53. data/docs/Model404FailedRequestResponse.md +20 -0
  54. data/docs/ModelAssetClass.md +20 -0
  55. data/docs/ModelAssetClassDetails.md +20 -0
  56. data/docs/ModelAssetClassTarget.md +18 -0
  57. data/docs/ModelPortfolio.md +22 -0
  58. data/docs/ModelPortfolioAssetClass.md +20 -0
  59. data/docs/ModelPortfolioDetails.md +22 -0
  60. data/docs/ModelPortfolioSecurity.md +20 -0
  61. data/docs/ModelType.md +15 -0
  62. data/docs/MonthlyDividends.md +20 -0
  63. data/docs/NetContributions.md +22 -0
  64. data/docs/NetDividend.md +22 -0
  65. data/docs/OptionChainInner.md +26 -0
  66. data/docs/OptionChainInnerChainPerRootInner.md +22 -0
  67. data/docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md +22 -0
  68. data/docs/OptionLeg.md +22 -0
  69. data/docs/OptionLegAction.md +15 -0
  70. data/docs/OptionStrategy.md +26 -0
  71. data/docs/OptionStrategyLegsInner.md +24 -0
  72. data/docs/OptionsApi.md +390 -0
  73. data/docs/OptionsGetOptionStrategyRequest.md +22 -0
  74. data/docs/OptionsHoldings.md +28 -0
  75. data/docs/OptionsPlaceOptionStrategyRequest.md +22 -0
  76. data/docs/OptionsPosition.md +30 -0
  77. data/docs/OptionsSymbol.md +38 -0
  78. data/docs/OrderStrategyExecuteBodyOrderType.md +15 -0
  79. data/docs/OrderStrategyExecuteBodyTimeInForce.md +15 -0
  80. data/docs/OrderType.md +15 -0
  81. data/docs/PartnerData.md +40 -0
  82. data/docs/PastValue.md +22 -0
  83. data/docs/PerformanceCustom.md +54 -0
  84. data/docs/PortfolioGroup.md +20 -0
  85. data/docs/PortfolioGroupInfo.md +38 -0
  86. data/docs/PortfolioGroupPosition.md +22 -0
  87. data/docs/PortfolioGroupSettings.md +26 -0
  88. data/docs/PortfolioManagementApi.md +2014 -0
  89. data/docs/Position.md +28 -0
  90. data/docs/PositionSymbol.md +28 -0
  91. data/docs/RedirectTokenandPin.md +20 -0
  92. data/docs/ReferenceDataApi.md +595 -0
  93. data/docs/SecurityType.md +24 -0
  94. data/docs/SessionEvent.md +30 -0
  95. data/docs/SessionEventType.md +15 -0
  96. data/docs/SnapTradeAPIDisclaimerAcceptStatus.md +20 -0
  97. data/docs/SnapTradeHoldingsAccount.md +32 -0
  98. data/docs/SnapTradeHoldingsAccountAccountId.md +34 -0
  99. data/docs/SnapTradeHoldingsTotalValue.md +20 -0
  100. data/docs/SnapTradeLoginUserRequestBody.md +26 -0
  101. data/docs/SnapTradeRegisterUserRequestBody.md +20 -0
  102. data/docs/State.md +15 -0
  103. data/docs/Status.md +22 -0
  104. data/docs/StrategyImpact.md +38 -0
  105. data/docs/StrategyImpactLegsInner.md +30 -0
  106. data/docs/StrategyOrderPlace.md +20 -0
  107. data/docs/StrategyOrderPlaceOrdersInner.md +102 -0
  108. data/docs/StrategyOrderPlaceOrdersInnerLegsInner.md +30 -0
  109. data/docs/StrategyOrderRecord.md +38 -0
  110. data/docs/StrategyOrderRecordOrderType.md +15 -0
  111. data/docs/StrategyOrderRecordStatus.md +15 -0
  112. data/docs/StrategyOrderRecordTimeInForce.md +15 -0
  113. data/docs/StrategyQuotes.md +28 -0
  114. data/docs/StrategyQuotesGreek.md +26 -0
  115. data/docs/StrategyType.md +15 -0
  116. data/docs/SubPeriodReturnRate.md +22 -0
  117. data/docs/Symbol.md +30 -0
  118. data/docs/SymbolQuery.md +18 -0
  119. data/docs/SymbolsQuotes.md +28 -0
  120. data/docs/TargetAsset.md +28 -0
  121. data/docs/TimeInForce.md +15 -0
  122. data/docs/Trade.md +32 -0
  123. data/docs/TradeAction.md +15 -0
  124. data/docs/TradeExecutionStatus.md +34 -0
  125. data/docs/TradeExecutionStatusAction.md +15 -0
  126. data/docs/TradeImpact.md +26 -0
  127. data/docs/TradingApi.md +799 -0
  128. data/docs/TradingCancelUserAccountOrderRequest.md +18 -0
  129. data/docs/TradingPlaceOCOOrderRequest.md +20 -0
  130. data/docs/TransactionsAndReportingApi.md +183 -0
  131. data/docs/TransactionsStatus.md +20 -0
  132. data/docs/Type.md +15 -0
  133. data/docs/USExchange.md +34 -0
  134. data/docs/UnderlyingSymbol.md +30 -0
  135. data/docs/UniversalActivity.md +46 -0
  136. data/docs/UniversalSymbol.md +32 -0
  137. data/docs/UniversalSymbolTicker.md +32 -0
  138. data/docs/UserErrorLog.md +28 -0
  139. data/docs/UserIDandSecret.md +20 -0
  140. data/docs/UserSettings.md +36 -0
  141. data/lib/snaptrade/api/account_information_api.rb +801 -0
  142. data/lib/snaptrade/api/api_status_api.rb +98 -0
  143. data/lib/snaptrade/api/authentication_api.rb +481 -0
  144. data/lib/snaptrade/api/connections_api.rb +398 -0
  145. data/lib/snaptrade/api/error_logs_api.rb +112 -0
  146. data/lib/snaptrade/api/options_api.rb +591 -0
  147. data/lib/snaptrade/api/portfolio_management_api.rb +2791 -0
  148. data/lib/snaptrade/api/reference_data_api.rb +894 -0
  149. data/lib/snaptrade/api/trading_api.rb +1150 -0
  150. data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -0
  151. data/lib/snaptrade/api_client.rb +427 -0
  152. data/lib/snaptrade/api_client_custom.rb +32 -0
  153. data/lib/snaptrade/api_error.rb +55 -0
  154. data/lib/snaptrade/configuration.rb +374 -0
  155. data/lib/snaptrade/models/account.rb +303 -0
  156. data/lib/snaptrade/models/account_holdings.rb +249 -0
  157. data/lib/snaptrade/models/account_holdings_account.rb +260 -0
  158. data/lib/snaptrade/models/account_order_record.rb +382 -0
  159. data/lib/snaptrade/models/account_order_record_status.rb +56 -0
  160. data/lib/snaptrade/models/account_simple.rb +245 -0
  161. data/lib/snaptrade/models/account_sync_status.rb +218 -0
  162. data/lib/snaptrade/models/action.rb +38 -0
  163. data/lib/snaptrade/models/auth_type.rb +40 -0
  164. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +103 -0
  165. data/lib/snaptrade/models/balance.rb +228 -0
  166. data/lib/snaptrade/models/brokerage.rb +377 -0
  167. data/lib/snaptrade/models/brokerage_authorization.rb +297 -0
  168. data/lib/snaptrade/models/brokerage_authorization_type.rb +217 -0
  169. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +244 -0
  170. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +237 -0
  171. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +38 -0
  172. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +38 -0
  173. data/lib/snaptrade/models/brokerage_symbol.rb +255 -0
  174. data/lib/snaptrade/models/brokerage_type.rb +227 -0
  175. data/lib/snaptrade/models/calculated_trade.rb +229 -0
  176. data/lib/snaptrade/models/cash_restriction.rb +254 -0
  177. data/lib/snaptrade/models/connection_type.rb +38 -0
  178. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +293 -0
  179. data/lib/snaptrade/models/currency.rb +236 -0
  180. data/lib/snaptrade/models/delete_user_response.rb +229 -0
  181. data/lib/snaptrade/models/dividend_at_date.rb +240 -0
  182. data/lib/snaptrade/models/encrypted_response.rb +227 -0
  183. data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +235 -0
  184. data/lib/snaptrade/models/exchange.rb +282 -0
  185. data/lib/snaptrade/models/exchange_rate_pairs.rb +236 -0
  186. data/lib/snaptrade/models/excluded_asset.rb +218 -0
  187. data/lib/snaptrade/models/jwt.rb +218 -0
  188. data/lib/snaptrade/models/login_redirect_uri.rb +228 -0
  189. data/lib/snaptrade/models/manual_trade.rb +283 -0
  190. data/lib/snaptrade/models/manual_trade_and_impact.rb +238 -0
  191. data/lib/snaptrade/models/manual_trade_balance.rb +238 -0
  192. data/lib/snaptrade/models/manual_trade_form.rb +285 -0
  193. data/lib/snaptrade/models/manual_trade_symbol.rb +264 -0
  194. data/lib/snaptrade/models/model400_failed_request_response.rb +229 -0
  195. data/lib/snaptrade/models/model401_failed_request_response.rb +229 -0
  196. data/lib/snaptrade/models/model403_failed_request_response.rb +229 -0
  197. data/lib/snaptrade/models/model404_failed_request_response.rb +229 -0
  198. data/lib/snaptrade/models/model_asset_class.rb +226 -0
  199. data/lib/snaptrade/models/model_asset_class_details.rb +228 -0
  200. data/lib/snaptrade/models/model_asset_class_target.rb +217 -0
  201. data/lib/snaptrade/models/model_portfolio.rb +237 -0
  202. data/lib/snaptrade/models/model_portfolio_asset_class.rb +250 -0
  203. data/lib/snaptrade/models/model_portfolio_details.rb +239 -0
  204. data/lib/snaptrade/models/model_portfolio_security.rb +250 -0
  205. data/lib/snaptrade/models/model_type.rb +39 -0
  206. data/lib/snaptrade/models/monthly_dividends.rb +229 -0
  207. data/lib/snaptrade/models/net_contributions.rb +237 -0
  208. data/lib/snaptrade/models/net_dividend.rb +237 -0
  209. data/lib/snaptrade/models/option_chain_inner.rb +255 -0
  210. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +237 -0
  211. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +238 -0
  212. data/lib/snaptrade/models/option_leg.rb +237 -0
  213. data/lib/snaptrade/models/option_leg_action.rb +40 -0
  214. data/lib/snaptrade/models/option_strategy.rb +255 -0
  215. data/lib/snaptrade/models/option_strategy_legs_inner.rb +244 -0
  216. data/lib/snaptrade/models/options_get_option_strategy_request.rb +252 -0
  217. data/lib/snaptrade/models/options_holdings.rb +267 -0
  218. data/lib/snaptrade/models/options_place_option_strategy_request.rb +251 -0
  219. data/lib/snaptrade/models/options_position.rb +275 -0
  220. data/lib/snaptrade/models/options_symbol.rb +310 -0
  221. data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +40 -0
  222. data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +38 -0
  223. data/lib/snaptrade/models/order_type.rb +40 -0
  224. data/lib/snaptrade/models/partner_data.rb +331 -0
  225. data/lib/snaptrade/models/past_value.rb +236 -0
  226. data/lib/snaptrade/models/performance_custom.rb +416 -0
  227. data/lib/snaptrade/models/portfolio_group.rb +226 -0
  228. data/lib/snaptrade/models/portfolio_group_info.rb +326 -0
  229. data/lib/snaptrade/models/portfolio_group_position.rb +238 -0
  230. data/lib/snaptrade/models/portfolio_group_settings.rb +277 -0
  231. data/lib/snaptrade/models/position.rb +271 -0
  232. data/lib/snaptrade/models/position_symbol.rb +264 -0
  233. data/lib/snaptrade/models/redirect_tokenand_pin.rb +227 -0
  234. data/lib/snaptrade/models/security_type.rb +245 -0
  235. data/lib/snaptrade/models/session_event.rb +274 -0
  236. data/lib/snaptrade/models/session_event_type.rb +43 -0
  237. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +227 -0
  238. data/lib/snaptrade/models/snap_trade_holdings_account.rb +284 -0
  239. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +296 -0
  240. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +227 -0
  241. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +254 -0
  242. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +229 -0
  243. data/lib/snaptrade/models/state.rb +41 -0
  244. data/lib/snaptrade/models/status.rb +236 -0
  245. data/lib/snaptrade/models/strategy_impact.rb +310 -0
  246. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +271 -0
  247. data/lib/snaptrade/models/strategy_order_place.rb +229 -0
  248. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +597 -0
  249. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +271 -0
  250. data/lib/snaptrade/models/strategy_order_record.rb +312 -0
  251. data/lib/snaptrade/models/strategy_order_record_order_type.rb +40 -0
  252. data/lib/snaptrade/models/strategy_order_record_status.rb +55 -0
  253. data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +38 -0
  254. data/lib/snaptrade/models/strategy_quotes.rb +265 -0
  255. data/lib/snaptrade/models/strategy_quotes_greek.rb +253 -0
  256. data/lib/snaptrade/models/strategy_type.rb +37 -0
  257. data/lib/snaptrade/models/sub_period_return_rate.rb +239 -0
  258. data/lib/snaptrade/models/symbol.rb +272 -0
  259. data/lib/snaptrade/models/symbol_query.rb +218 -0
  260. data/lib/snaptrade/models/symbols_quotes.rb +263 -0
  261. data/lib/snaptrade/models/target_asset.rb +290 -0
  262. data/lib/snaptrade/models/time_in_force.rb +39 -0
  263. data/lib/snaptrade/models/trade.rb +281 -0
  264. data/lib/snaptrade/models/trade_action.rb +38 -0
  265. data/lib/snaptrade/models/trade_execution_status.rb +296 -0
  266. data/lib/snaptrade/models/trade_execution_status_action.rb +38 -0
  267. data/lib/snaptrade/models/trade_impact.rb +257 -0
  268. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +217 -0
  269. data/lib/snaptrade/models/trading_place_oco_order_request.rb +230 -0
  270. data/lib/snaptrade/models/transactions_status.rb +229 -0
  271. data/lib/snaptrade/models/type.rb +38 -0
  272. data/lib/snaptrade/models/underlying_symbol.rb +275 -0
  273. data/lib/snaptrade/models/universal_activity.rb +349 -0
  274. data/lib/snaptrade/models/universal_symbol.rb +284 -0
  275. data/lib/snaptrade/models/universal_symbol_ticker.rb +283 -0
  276. data/lib/snaptrade/models/us_exchange.rb +291 -0
  277. data/lib/snaptrade/models/user_error_log.rb +263 -0
  278. data/lib/snaptrade/models/user_i_dand_secret.rb +229 -0
  279. data/lib/snaptrade/models/user_settings.rb +299 -0
  280. data/lib/snaptrade/version.rb +13 -0
  281. data/lib/snaptrade.rb +214 -0
  282. data/snaptrade.gemspec +41 -0
  283. data/spec/api/account_information_api_spec.rb +135 -0
  284. data/spec/api/api_status_api_spec.rb +42 -0
  285. data/spec/api/authentication_api_spec.rb +88 -0
  286. data/spec/api/connections_api_spec.rb +82 -0
  287. data/spec/api/error_logs_api_spec.rb +43 -0
  288. data/spec/api/options_api_spec.rb +101 -0
  289. data/spec/api/portfolio_management_api_spec.rb +395 -0
  290. data/spec/api/reference_data_api_spec.rb +150 -0
  291. data/spec/api/trading_api_spec.rb +163 -0
  292. data/spec/api/transactions_and_reporting_api_spec.rb +67 -0
  293. data/spec/api_client_spec.rb +193 -0
  294. data/spec/configuration_spec.rb +40 -0
  295. data/spec/getting_started_spec.rb +144 -0
  296. data/spec/models/account_holdings_account_spec.rb +54 -0
  297. data/spec/models/account_holdings_spec.rb +48 -0
  298. data/spec/models/account_order_record_spec.rb +132 -0
  299. data/spec/models/account_order_record_status_spec.rb +24 -0
  300. data/spec/models/account_simple_spec.rb +48 -0
  301. data/spec/models/account_spec.rb +84 -0
  302. data/spec/models/account_sync_status_spec.rb +30 -0
  303. data/spec/models/action_spec.rb +24 -0
  304. data/spec/models/auth_type_spec.rb +24 -0
  305. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -0
  306. data/spec/models/balance_spec.rb +36 -0
  307. data/spec/models/brokerage_authorization_spec.rb +78 -0
  308. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -0
  309. data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -0
  310. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -0
  311. data/spec/models/brokerage_authorization_type_spec.rb +30 -0
  312. data/spec/models/brokerage_authorization_type_type_spec.rb +24 -0
  313. data/spec/models/brokerage_spec.rb +132 -0
  314. data/spec/models/brokerage_symbol_spec.rb +54 -0
  315. data/spec/models/brokerage_type_spec.rb +36 -0
  316. data/spec/models/calculated_trade_spec.rb +36 -0
  317. data/spec/models/cash_restriction_spec.rb +54 -0
  318. data/spec/models/connection_type_spec.rb +24 -0
  319. data/spec/models/connections_session_events200_response_inner_spec.rb +66 -0
  320. data/spec/models/currency_spec.rb +42 -0
  321. data/spec/models/delete_user_response_spec.rb +36 -0
  322. data/spec/models/dividend_at_date_spec.rb +42 -0
  323. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -0
  324. data/spec/models/encrypted_response_spec.rb +36 -0
  325. data/spec/models/exchange_rate_pairs_spec.rb +42 -0
  326. data/spec/models/exchange_spec.rb +72 -0
  327. data/spec/models/excluded_asset_spec.rb +30 -0
  328. data/spec/models/jwt_spec.rb +30 -0
  329. data/spec/models/login_redirect_uri_spec.rb +36 -0
  330. data/spec/models/manual_trade_and_impact_spec.rb +42 -0
  331. data/spec/models/manual_trade_balance_spec.rb +42 -0
  332. data/spec/models/manual_trade_form_spec.rb +72 -0
  333. data/spec/models/manual_trade_spec.rb +72 -0
  334. data/spec/models/manual_trade_symbol_spec.rb +60 -0
  335. data/spec/models/model400_failed_request_response_spec.rb +36 -0
  336. data/spec/models/model401_failed_request_response_spec.rb +36 -0
  337. data/spec/models/model403_failed_request_response_spec.rb +36 -0
  338. data/spec/models/model404_failed_request_response_spec.rb +36 -0
  339. data/spec/models/model_asset_class_details_spec.rb +36 -0
  340. data/spec/models/model_asset_class_spec.rb +36 -0
  341. data/spec/models/model_asset_class_target_spec.rb +30 -0
  342. data/spec/models/model_portfolio_asset_class_spec.rb +36 -0
  343. data/spec/models/model_portfolio_details_spec.rb +42 -0
  344. data/spec/models/model_portfolio_security_spec.rb +36 -0
  345. data/spec/models/model_portfolio_spec.rb +42 -0
  346. data/spec/models/model_type_spec.rb +24 -0
  347. data/spec/models/monthly_dividends_spec.rb +36 -0
  348. data/spec/models/net_contributions_spec.rb +42 -0
  349. data/spec/models/net_dividend_spec.rb +42 -0
  350. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -0
  351. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -0
  352. data/spec/models/option_chain_inner_spec.rb +54 -0
  353. data/spec/models/option_leg_action_spec.rb +24 -0
  354. data/spec/models/option_leg_spec.rb +42 -0
  355. data/spec/models/option_strategy_legs_inner_spec.rb +48 -0
  356. data/spec/models/option_strategy_spec.rb +54 -0
  357. data/spec/models/options_get_option_strategy_request_spec.rb +42 -0
  358. data/spec/models/options_holdings_spec.rb +60 -0
  359. data/spec/models/options_place_option_strategy_request_spec.rb +42 -0
  360. data/spec/models/options_position_spec.rb +66 -0
  361. data/spec/models/options_symbol_spec.rb +90 -0
  362. data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -0
  363. data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -0
  364. data/spec/models/order_type_spec.rb +24 -0
  365. data/spec/models/partner_data_spec.rb +96 -0
  366. data/spec/models/past_value_spec.rb +42 -0
  367. data/spec/models/performance_custom_spec.rb +138 -0
  368. data/spec/models/portfolio_group_info_spec.rb +90 -0
  369. data/spec/models/portfolio_group_position_spec.rb +42 -0
  370. data/spec/models/portfolio_group_settings_spec.rb +54 -0
  371. data/spec/models/portfolio_group_spec.rb +36 -0
  372. data/spec/models/position_spec.rb +60 -0
  373. data/spec/models/position_symbol_spec.rb +60 -0
  374. data/spec/models/redirect_tokenand_pin_spec.rb +36 -0
  375. data/spec/models/security_type_spec.rb +48 -0
  376. data/spec/models/session_event_spec.rb +66 -0
  377. data/spec/models/session_event_type_spec.rb +24 -0
  378. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -0
  379. data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -0
  380. data/spec/models/snap_trade_holdings_account_spec.rb +72 -0
  381. data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -0
  382. data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -0
  383. data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -0
  384. data/spec/models/state_spec.rb +24 -0
  385. data/spec/models/status_spec.rb +42 -0
  386. data/spec/models/strategy_impact_legs_inner_spec.rb +66 -0
  387. data/spec/models/strategy_impact_spec.rb +90 -0
  388. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -0
  389. data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -0
  390. data/spec/models/strategy_order_place_spec.rb +36 -0
  391. data/spec/models/strategy_order_record_order_type_spec.rb +24 -0
  392. data/spec/models/strategy_order_record_spec.rb +90 -0
  393. data/spec/models/strategy_order_record_status_spec.rb +24 -0
  394. data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -0
  395. data/spec/models/strategy_quotes_greek_spec.rb +54 -0
  396. data/spec/models/strategy_quotes_spec.rb +60 -0
  397. data/spec/models/strategy_type_spec.rb +24 -0
  398. data/spec/models/sub_period_return_rate_spec.rb +42 -0
  399. data/spec/models/symbol_query_spec.rb +30 -0
  400. data/spec/models/symbol_spec.rb +66 -0
  401. data/spec/models/symbols_quotes_spec.rb +60 -0
  402. data/spec/models/target_asset_spec.rb +60 -0
  403. data/spec/models/time_in_force_spec.rb +24 -0
  404. data/spec/models/trade_action_spec.rb +24 -0
  405. data/spec/models/trade_execution_status_action_spec.rb +24 -0
  406. data/spec/models/trade_execution_status_spec.rb +78 -0
  407. data/spec/models/trade_impact_spec.rb +54 -0
  408. data/spec/models/trade_spec.rb +72 -0
  409. data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -0
  410. data/spec/models/trading_place_oco_order_request_spec.rb +36 -0
  411. data/spec/models/transactions_status_spec.rb +36 -0
  412. data/spec/models/type_spec.rb +24 -0
  413. data/spec/models/underlying_symbol_spec.rb +66 -0
  414. data/spec/models/universal_activity_spec.rb +114 -0
  415. data/spec/models/universal_symbol_spec.rb +72 -0
  416. data/spec/models/universal_symbol_ticker_spec.rb +72 -0
  417. data/spec/models/us_exchange_spec.rb +78 -0
  418. data/spec/models/user_error_log_spec.rb +60 -0
  419. data/spec/models/user_i_dand_secret_spec.rb +36 -0
  420. data/spec/models/user_settings_spec.rb +84 -0
  421. data/spec/spec_helper.rb +109 -0
  422. metadata +664 -0
data/docs/SessionEvent.md ADDED
@@ -0,0 +1,30 @@
1
+ # SnapTrade::SessionEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **session_event_type** | [**SessionEventType**](SessionEventType.md) | | [optional] |
9
+ | **session_id** | **String** | | [optional] |
10
+ | **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user | [optional] |
11
+ | **created_date** | **String** | Time | [optional] |
12
+ | **brokerage_status_code** | **Integer** | | [optional] |
13
+ | **brokerage_authorization_id** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'snaptrade'
19
+
20
+ instance = SnapTrade::SessionEvent.new(
21
+ id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
22
+ session_event_type: null,
23
+ session_id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
24
+ user_id: snaptrade-user-123,
25
+ created_date: 2022-01-21T20:11:19.217Z,
26
+ brokerage_status_code: 400,
27
+ brokerage_authorization_id: 2bcd7cc3-e922-4976-bce1-9858296801c3
28
+ )
29
+ ```
30
+
data/docs/SessionEventType.md ADDED
@@ -0,0 +1,15 @@
1
+ # SnapTrade::SessionEventType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'snaptrade'
12
+
13
+ instance = SnapTrade::SessionEventType.new()
14
+ ```
15
+
data/docs/SnapTradeAPIDisclaimerAcceptStatus.md ADDED
@@ -0,0 +1,20 @@
1
+ # SnapTrade::SnapTradeAPIDisclaimerAcceptStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **accepted** | **Boolean** | | [optional] |
8
+ | **timestamp** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'snaptrade'
14
+
15
+ instance = SnapTrade::SnapTradeAPIDisclaimerAcceptStatus.new(
16
+ accepted: null,
17
+ timestamp: 2022-01-21T20:11:19.217Z
18
+ )
19
+ ```
20
+
data/docs/SnapTradeHoldingsAccount.md ADDED
@@ -0,0 +1,32 @@
1
+ # SnapTrade::SnapTradeHoldingsAccount
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **brokerage_authorization** | [**BrokerageAuthorization**](BrokerageAuthorization.md) | | [optional] |
9
+ | **portfolio_group** | **String** | | [optional] |
10
+ | **name** | **String** | | [optional] |
11
+ | **number** | **String** | | [optional] |
12
+ | **institution_name** | **String** | | [optional] |
13
+ | **sync_status** | [**AccountSyncStatus**](AccountSyncStatus.md) | | [optional] |
14
+ | **meta** | **Hash<String, Object>** | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'snaptrade'
20
+
21
+ instance = SnapTrade::SnapTradeHoldingsAccount.new(
22
+ id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
23
+ brokerage_authorization: null,
24
+ portfolio_group: 2bcd7cc3-e922-4976-bce1-9858296801c3,
25
+ name: Registered Retirement Savings Account,
26
+ number: Q6542138443,
27
+ institution_name: Alpaca,
28
+ sync_status: null,
29
+ meta: {"type":"Margin","status":"ACTIVE","institution_name":"Alpaca"}
30
+ )
31
+ ```
32
+
data/docs/SnapTradeHoldingsAccountAccountId.md ADDED
@@ -0,0 +1,34 @@
1
+ # SnapTrade::SnapTradeHoldingsAccountAccountId
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **brokerage_authorization** | **String** | | [optional] |
9
+ | **portfolio_group** | **String** | | [optional] |
10
+ | **name** | **String** | | [optional] |
11
+ | **number** | **String** | | [optional] |
12
+ | **institution_name** | **String** | | [optional] |
13
+ | **meta** | **Hash<String, Object>** | | [optional] |
14
+ | **cash_restrictions** | [**Array<CashRestriction>**](CashRestriction.md) | | [optional] |
15
+ | **created_date** | **String** | Time | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'snaptrade'
21
+
22
+ instance = SnapTrade::SnapTradeHoldingsAccountAccountId.new(
23
+ id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
24
+ brokerage_authorization: 87b24961-b51e-4db8-9226-f198f6518a89,
25
+ portfolio_group: 2bcd7cc3-e922-4976-bce1-9858296801c3,
26
+ name: Registered Retirement Savings Account,
27
+ number: Q6542138443,
28
+ institution_name: Alpaca,
29
+ meta: {"type":"Margin","status":"ACTIVE","institution_name":"Alpaca"},
30
+ cash_restrictions: null,
31
+ created_date: 2022-01-21T20:11:19.217Z
32
+ )
33
+ ```
34
+
data/docs/SnapTradeHoldingsTotalValue.md ADDED
@@ -0,0 +1,20 @@
1
+ # SnapTrade::SnapTradeHoldingsTotalValue
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Float** | | [optional] |
8
+ | **currency** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'snaptrade'
14
+
15
+ instance = SnapTrade::SnapTradeHoldingsTotalValue.new(
16
+ value: 32600.71,
17
+ currency: USD
18
+ )
19
+ ```
20
+
data/docs/SnapTradeLoginUserRequestBody.md ADDED
@@ -0,0 +1,26 @@
1
+ # SnapTrade::SnapTradeLoginUserRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **broker** | **String** | | [optional] |
8
+ | **immediate_redirect** | **Boolean** | | [optional] |
9
+ | **custom_redirect** | **String** | | [optional] |
10
+ | **reconnect** | **String** | | [optional] |
11
+ | **connection_type** | [**ConnectionType**](ConnectionType.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'snaptrade'
17
+
18
+ instance = SnapTrade::SnapTradeLoginUserRequestBody.new(
19
+ broker: ALPACA,
20
+ immediate_redirect: true,
21
+ custom_redirect: https://passiv.com,
22
+ reconnect: 8b5f262d-4bb9-365d-888a-202bd3b15fa1,
23
+ connection_type: null
24
+ )
25
+ ```
26
+
data/docs/SnapTradeRegisterUserRequestBody.md ADDED
@@ -0,0 +1,20 @@
1
+ # SnapTrade::SnapTradeRegisterUserRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user | [optional] |
8
+ | **rsa_public_key** | **String** | Open SSH RSA public key | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'snaptrade'
14
+
15
+ instance = SnapTrade::SnapTradeRegisterUserRequestBody.new(
16
+ user_id: snaptrade-user-123,
17
+ rsa_public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw==
18
+ )
19
+ ```
20
+
data/docs/State.md ADDED
@@ -0,0 +1,15 @@
1
+ # SnapTrade::State
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'snaptrade'
12
+
13
+ instance = SnapTrade::State.new()
14
+ ```
15
+
data/docs/Status.md ADDED
@@ -0,0 +1,22 @@
1
+ # SnapTrade::Status
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **version** | **Integer** | | [optional] |
8
+ | **timestamp** | **String** | | [optional] |
9
+ | **online** | **Boolean** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'snaptrade'
15
+
16
+ instance = SnapTrade::Status.new(
17
+ version: 151,
18
+ timestamp: 2022-11-04T01:47:00.377Z,
19
+ online: true
20
+ )
21
+ ```
22
+
data/docs/StrategyImpact.md ADDED
@@ -0,0 +1,38 @@
1
+ # SnapTrade::StrategyImpact
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **estimated_commissions** | **Float** | | [optional] |
8
+ | **buying_power_effect** | **Float** | | [optional] |
9
+ | **buying_power_result** | **Float** | | [optional] |
10
+ | **maint_excess_effect** | **Float** | | [optional] |
11
+ | **maint_excess_result** | **Float** | | [optional] |
12
+ | **trade_value_calculation** | **String** | | [optional] |
13
+ | **legs** | [**Array<StrategyImpactLegsInner>**](StrategyImpactLegsInner.md) | | [optional] |
14
+ | **side** | **String** | | [optional] |
15
+ | **effect** | **String** | | [optional] |
16
+ | **price** | **Float** | | [optional] |
17
+ | **strategy** | **String** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'snaptrade'
23
+
24
+ instance = SnapTrade::StrategyImpact.new(
25
+ estimated_commissions: 11.95,
26
+ buying_power_effect: -156.3435,
27
+ buying_power_result: 8800.0882,
28
+ maint_excess_effect: -46.95,
29
+ maint_excess_result: 2642.669129,
30
+ trade_value_calculation: 1 x 0.07 x 100 + 1 x 0.28 x 100 = DR 35.00 CAD,
31
+ legs: null,
32
+ side: Buy,
33
+ effect: Debit,
34
+ price: 0.35,
35
+ strategy: Strangle
36
+ )
37
+ ```
38
+
data/docs/StrategyImpactLegsInner.md ADDED
@@ -0,0 +1,30 @@
1
+ # SnapTrade::StrategyImpactLegsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **leg_id** | **Integer** | | [optional] |
8
+ | **symbol** | **String** | | [optional] |
9
+ | **symbol_id** | **Integer** | | [optional] |
10
+ | **leg_ratio_quantity** | **Integer** | | [optional] |
11
+ | **side** | **String** | | [optional] |
12
+ | **avg_exec_price** | **String** | | [optional] |
13
+ | **last_exec_price** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'snaptrade'
19
+
20
+ instance = SnapTrade::StrategyImpactLegsInner.new(
21
+ leg_id: 0,
22
+ symbol: AC21Oct22C30.00.MX,
23
+ symbol_id: 41790511,
24
+ leg_ratio_quantity: 1,
25
+ side: BTO,
26
+ avg_exec_price: null,
27
+ last_exec_price: null
28
+ )
29
+ ```
30
+
data/docs/StrategyOrderPlace.md ADDED
@@ -0,0 +1,20 @@
1
+ # SnapTrade::StrategyOrderPlace
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **order_id** | **Integer** | | [optional] |
8
+ | **orders** | [**Array<StrategyOrderPlaceOrdersInner>**](StrategyOrderPlaceOrdersInner.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'snaptrade'
14
+
15
+ instance = SnapTrade::StrategyOrderPlace.new(
16
+ order_id: 1069605761,
17
+ orders: null
18
+ )
19
+ ```
20
+
data/docs/StrategyOrderPlaceOrdersInner.md ADDED
@@ -0,0 +1,102 @@
1
+ # SnapTrade::StrategyOrderPlaceOrdersInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | | [optional] |
8
+ | **symbol** | **String** | | [optional] |
9
+ | **symbol_id** | **Integer** | | [optional] |
10
+ | **total_quantity** | **Integer** | | [optional] |
11
+ | **open_quantity** | **Integer** | | [optional] |
12
+ | **filled_quantity** | **Integer** | | [optional] |
13
+ | **canceled_quantity** | **Integer** | | [optional] |
14
+ | **side** | **String** | | [optional] |
15
+ | **order_type** | **String** | | [optional] |
16
+ | **limit_price** | **String** | | [optional] |
17
+ | **stop_price** | **String** | | [optional] |
18
+ | **is_all_or_none** | **Boolean** | | [optional] |
19
+ | **is_anonymous** | **Boolean** | | [optional] |
20
+ | **iceberg_quantity** | **String** | | [optional] |
21
+ | **min_quantity** | **String** | | [optional] |
22
+ | **avg_exec_price** | **Integer** | | [optional] |
23
+ | **last_exec_price** | **String** | | [optional] |
24
+ | **source** | **String** | | [optional] |
25
+ | **time_in_force** | **String** | | [optional] |
26
+ | **gtd_date** | **String** | | [optional] |
27
+ | **state** | **String** | | [optional] |
28
+ | **rejection_reason** | **String** | | [optional] |
29
+ | **chain_id** | **Integer** | | [optional] |
30
+ | **creation_time** | **String** | | [optional] |
31
+ | **update_time** | **String** | | [optional] |
32
+ | **notes** | **String** | | [optional] |
33
+ | **primary_route** | **String** | | [optional] |
34
+ | **secondary_route** | **String** | | [optional] |
35
+ | **order_route** | **String** | | [optional] |
36
+ | **venue_holding_order** | **String** | | [optional] |
37
+ | **comission_charged** | **Integer** | | [optional] |
38
+ | **exchange_order_id** | **String** | | [optional] |
39
+ | **is_significant_share_holder** | **Boolean** | | [optional] |
40
+ | **is_insider** | **Boolean** | | [optional] |
41
+ | **is_limit_offset_in_dollar** | **Boolean** | | [optional] |
42
+ | **user_id** | **Integer** | | [optional] |
43
+ | **placement_commission** | **String** | | [optional] |
44
+ | **legs** | [**Array<StrategyOrderPlaceOrdersInnerLegsInner>**](StrategyOrderPlaceOrdersInnerLegsInner.md) | | [optional] |
45
+ | **strategy_type** | **String** | | [optional] |
46
+ | **trigger_stop_price** | **String** | | [optional] |
47
+ | **order_group_id** | **Integer** | | [optional] |
48
+ | **order_class** | **String** | | [optional] |
49
+ | **is_cross_zero** | **Boolean** | | [optional] |
50
+
51
+ ## Example
52
+
53
+ ```ruby
54
+ require 'snaptrade'
55
+
56
+ instance = SnapTrade::StrategyOrderPlaceOrdersInner.new(
57
+ id: 1069605761,
58
+ symbol: AC.TO,
59
+ symbol_id: 7960447,
60
+ total_quantity: 1,
61
+ open_quantity: 1,
62
+ filled_quantity: 0,
63
+ canceled_quantity: 0,
64
+ side: Buy,
65
+ order_type: Market,
66
+ limit_price: null,
67
+ stop_price: null,
68
+ is_all_or_none: null,
69
+ is_anonymous: null,
70
+ iceberg_quantity: null,
71
+ min_quantity: null,
72
+ avg_exec_price: 0,
73
+ last_exec_price: null,
74
+ source: TradingAPI,
75
+ time_in_force: Day,
76
+ gtd_date: null,
77
+ state: Pending,
78
+ rejection_reason: None,
79
+ chain_id: 1069605761,
80
+ creation_time: 2022-07-19T19:53:47.915Z,
81
+ update_time: 2022-07-19T19:53:47.939Z,
82
+ notes: None,
83
+ primary_route: AUTO,
84
+ secondary_route: AUTO,
85
+ order_route: MX,
86
+ venue_holding_order: None,
87
+ comission_charged: 0,
88
+ exchange_order_id: None,
89
+ is_significant_share_holder: null,
90
+ is_insider: null,
91
+ is_limit_offset_in_dollar: null,
92
+ user_id: 514603,
93
+ placement_commission: null,
94
+ legs: null,
95
+ strategy_type: Strangle,
96
+ trigger_stop_price: null,
97
+ order_group_id: 0,
98
+ order_class: null,
99
+ is_cross_zero: null
100
+ )
101
+ ```
102
+
data/docs/StrategyOrderPlaceOrdersInnerLegsInner.md ADDED
@@ -0,0 +1,30 @@
1
+ # SnapTrade::StrategyOrderPlaceOrdersInnerLegsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **leg_id** | **Integer** | | [optional] |
8
+ | **symbol** | **String** | | [optional] |
9
+ | **symbol_id** | **Integer** | | [optional] |
10
+ | **leg_ratio_quantity** | **Integer** | | [optional] |
11
+ | **side** | **String** | | [optional] |
12
+ | **avg_exec_price** | **Integer** | | [optional] |
13
+ | **last_exec_price** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'snaptrade'
19
+
20
+ instance = SnapTrade::StrategyOrderPlaceOrdersInnerLegsInner.new(
21
+ leg_id: 0,
22
+ symbol: AC21Oct22C30.00.MX,
23
+ symbol_id: 41790511,
24
+ leg_ratio_quantity: 1,
25
+ side: BTO,
26
+ avg_exec_price: 0,
27
+ last_exec_price: null
28
+ )
29
+ ```
30
+
data/docs/StrategyOrderRecord.md ADDED
@@ -0,0 +1,38 @@
1
+ # SnapTrade::StrategyOrderRecord
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **strategy** | [**OptionStrategy**](OptionStrategy.md) | | [optional] |
8
+ | **status** | [**StrategyOrderRecordStatus**](StrategyOrderRecordStatus.md) | | [optional] |
9
+ | **filled_quantity** | **Float** | | [optional] |
10
+ | **open_quantity** | **Float** | | [optional] |
11
+ | **closed_quantity** | **Float** | | [optional] |
12
+ | **order_type** | [**StrategyOrderRecordOrderType**](StrategyOrderRecordOrderType.md) | | [optional] |
13
+ | **time_in_force** | [**StrategyOrderRecordTimeInForce**](StrategyOrderRecordTimeInForce.md) | | [optional] |
14
+ | **limit_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
15
+ | **execution_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
16
+ | **time_placed** | **String** | Time | [optional] |
17
+ | **time_updated** | **String** | Time | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'snaptrade'
23
+
24
+ instance = SnapTrade::StrategyOrderRecord.new(
25
+ strategy: null,
26
+ status: null,
27
+ filled_quantity: 10,
28
+ open_quantity: 10,
29
+ closed_quantity: 10,
30
+ order_type: null,
31
+ time_in_force: null,
32
+ limit_price: 31.33,
33
+ execution_price: 31.33,
34
+ time_placed: 2022-01-21T20:11:19.217Z,
35
+ time_updated: 2022-01-21T20:11:19.217Z
36
+ )
37
+ ```
38
+
data/docs/StrategyOrderRecordOrderType.md ADDED
@@ -0,0 +1,15 @@
1
+ # SnapTrade::StrategyOrderRecordOrderType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'snaptrade'
12
+
13
+ instance = SnapTrade::StrategyOrderRecordOrderType.new()
14
+ ```
15
+
data/docs/StrategyOrderRecordStatus.md ADDED
@@ -0,0 +1,15 @@
1
+ # SnapTrade::StrategyOrderRecordStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'snaptrade'
12
+
13
+ instance = SnapTrade::StrategyOrderRecordStatus.new()
14
+ ```
15
+
data/docs/StrategyOrderRecordTimeInForce.md ADDED
@@ -0,0 +1,15 @@
1
+ # SnapTrade::StrategyOrderRecordTimeInForce
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'snaptrade'
12
+
13
+ instance = SnapTrade::StrategyOrderRecordTimeInForce.new()
14
+ ```
15
+
data/docs/StrategyQuotes.md ADDED
@@ -0,0 +1,28 @@
1
+ # SnapTrade::StrategyQuotes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **strategy** | [**OptionStrategy**](OptionStrategy.md) | | [optional] |
8
+ | **open_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
9
+ | **bid_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
10
+ | **ask_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
11
+ | **volatility** | **Float** | | [optional] |
12
+ | **greek** | [**StrategyQuotesGreek**](StrategyQuotesGreek.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'snaptrade'
18
+
19
+ instance = SnapTrade::StrategyQuotes.new(
20
+ strategy: null,
21
+ open_price: 31.33,
22
+ bid_price: 31.33,
23
+ ask_price: 31.33,
24
+ volatility: 0.141,
25
+ greek: null
26
+ )
27
+ ```
28
+
data/docs/StrategyQuotesGreek.md ADDED
@@ -0,0 +1,26 @@
1
+ # SnapTrade::StrategyQuotesGreek
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **delta** | **Float** | | [optional] |
8
+ | **gamma** | **Float** | | [optional] |
9
+ | **theta** | **Float** | | [optional] |
10
+ | **vega** | **Float** | | [optional] |
11
+ | **rho** | **Float** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'snaptrade'
17
+
18
+ instance = SnapTrade::StrategyQuotesGreek.new(
19
+ delta: 0.1,
20
+ gamma: 0.1,
21
+ theta: 0.1,
22
+ vega: 0.1,
23
+ rho: 0.1
24
+ )
25
+ ```
26
+
data/docs/StrategyType.md ADDED
@@ -0,0 +1,15 @@
1
+ # SnapTrade::StrategyType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'snaptrade'
12
+
13
+ instance = SnapTrade::StrategyType.new()
14
+ ```
15
+
data/docs/SubPeriodReturnRate.md ADDED
@@ -0,0 +1,22 @@
1
+ # SnapTrade::SubPeriodReturnRate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **period_start** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
8
+ | **period_end** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
9
+ | **rate_of_return** | **Float** | The return rate for the given period | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'snaptrade'
15
+
16
+ instance = SnapTrade::SubPeriodReturnRate.new(
17
+ period_start: Sun Jan 23 16:00:00 PST 2022,
18
+ period_end: Sun Jan 23 16:00:00 PST 2022,
19
+ rate_of_return: 0.012312367452
20
+ )
21
+ ```
22
+
data/docs/Symbol.md ADDED
@@ -0,0 +1,30 @@
1
+ # SnapTrade::Symbol
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **symbol** | **String** | | [optional] |
9
+ | **raw_symbol** | **String** | | [optional] |
10
+ | **name** | **String** | | [optional] |
11
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
12
+ | **exchange** | [**Exchange**](Exchange.md) | | [optional] |
13
+ | **type** | [**SecurityType**](SecurityType.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'snaptrade'
19
+
20
+ instance = SnapTrade::Symbol.new(
21
+ id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
22
+ symbol: VAB.TO,
23
+ raw_symbol: VAB,
24
+ name: Vanguard Canadian Aggregate Bond Index ETF,
25
+ currency: null,
26
+ exchange: null,
27
+ type: null
28
+ )
29
+ ```
30
+