snaptrade 2.0.36 → 2.0.38
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +60 -56
- data/lib/snaptrade/api/account_information_api.rb +4 -4
- data/lib/snaptrade/api/authentication_api.rb +12 -12
- data/lib/snaptrade/api/connections_api.rb +70 -52
- data/lib/snaptrade/models/account.rb +2 -2
- data/lib/snaptrade/models/brokerage.rb +25 -40
- data/lib/snaptrade/models/brokerage_authorization.rb +12 -8
- data/lib/snaptrade/models/brokerage_authorization_disabled_confirmation.rb +1 -0
- data/lib/snaptrade/models/brokerage_authorization_refresh_confirmation.rb +1 -0
- data/lib/snaptrade/models/brokerage_type.rb +1 -1
- data/lib/snaptrade/models/user_i_dand_secret.rb +1 -2
- data/lib/snaptrade/version.rb +1 -1
- data/spec/api/account_information_api_spec.rb +1 -1
- data/spec/api/authentication_api_spec.rb +2 -2
- data/spec/api/connections_api_spec.rb +13 -13
- data/spec/models/brokerage_spec.rb +6 -24
- metadata +2 -2
@@ -17,11 +17,11 @@ module SnapTrade
|
|
17
17
|
@api_client = api_client
|
18
18
|
end
|
19
19
|
|
20
|
-
# Get
|
20
|
+
# Get connection detail
|
21
21
|
#
|
22
|
-
# Returns a single
|
22
|
+
# Returns a single connection for the specified ID.
|
23
23
|
#
|
24
|
-
# @param authorization_id [String]
|
24
|
+
# @param authorization_id [String]
|
25
25
|
# @param user_id [String]
|
26
26
|
# @param user_secret [String]
|
27
27
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -30,11 +30,11 @@ module SnapTrade
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
# Get
|
33
|
+
# Get connection detail
|
34
34
|
#
|
35
|
-
# Returns a single
|
35
|
+
# Returns a single connection for the specified ID.
|
36
36
|
#
|
37
|
-
# @param authorization_id [String]
|
37
|
+
# @param authorization_id [String]
|
38
38
|
# @param user_id [String]
|
39
39
|
# @param user_secret [String]
|
40
40
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -42,9 +42,9 @@ module SnapTrade
|
|
42
42
|
detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
|
43
43
|
end
|
44
44
|
|
45
|
-
# Get
|
46
|
-
# Returns a single
|
47
|
-
# @param authorization_id [String]
|
45
|
+
# Get connection detail
|
46
|
+
# Returns a single connection for the specified ID.
|
47
|
+
# @param authorization_id [String]
|
48
48
|
# @param user_id [String]
|
49
49
|
# @param user_secret [String]
|
50
50
|
# @param [Hash] opts the optional parameters
|
@@ -54,9 +54,9 @@ module SnapTrade
|
|
54
54
|
data
|
55
55
|
end
|
56
56
|
|
57
|
-
# Get
|
58
|
-
# Returns a single
|
59
|
-
# @param authorization_id [String]
|
57
|
+
# Get connection detail
|
58
|
+
# Returns a single connection for the specified ID.
|
59
|
+
# @param authorization_id [String]
|
60
60
|
# @param user_id [String]
|
61
61
|
# @param user_secret [String]
|
62
62
|
# @param [Hash] opts the optional parameters
|
@@ -120,11 +120,14 @@ module SnapTrade
|
|
120
120
|
end
|
121
121
|
|
122
122
|
|
123
|
-
#
|
123
|
+
# Force disable connection
|
124
124
|
#
|
125
|
-
# Manually
|
125
|
+
# Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
|
126
|
+
# Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.
|
127
|
+
#
|
128
|
+
# *Please contact us in order to use this endpoint as it is disabled by default.*
|
126
129
|
#
|
127
|
-
# @param authorization_id [String]
|
130
|
+
# @param authorization_id [String]
|
128
131
|
# @param user_id [String]
|
129
132
|
# @param user_secret [String]
|
130
133
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -133,11 +136,14 @@ module SnapTrade
|
|
133
136
|
data
|
134
137
|
end
|
135
138
|
|
136
|
-
#
|
139
|
+
# Force disable connection
|
137
140
|
#
|
138
|
-
# Manually
|
141
|
+
# Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
|
142
|
+
# Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.
|
143
|
+
#
|
144
|
+
# *Please contact us in order to use this endpoint as it is disabled by default.*
|
139
145
|
#
|
140
|
-
# @param authorization_id [String]
|
146
|
+
# @param authorization_id [String]
|
141
147
|
# @param user_id [String]
|
142
148
|
# @param user_secret [String]
|
143
149
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -145,9 +151,9 @@ module SnapTrade
|
|
145
151
|
disable_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
|
146
152
|
end
|
147
153
|
|
148
|
-
#
|
149
|
-
# Manually
|
150
|
-
# @param authorization_id [String]
|
154
|
+
# Force disable connection
|
155
|
+
# Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection. *Please contact us in order to use this endpoint as it is disabled by default.*
|
156
|
+
# @param authorization_id [String]
|
151
157
|
# @param user_id [String]
|
152
158
|
# @param user_secret [String]
|
153
159
|
# @param [Hash] opts the optional parameters
|
@@ -157,9 +163,9 @@ module SnapTrade
|
|
157
163
|
data
|
158
164
|
end
|
159
165
|
|
160
|
-
#
|
161
|
-
# Manually
|
162
|
-
# @param authorization_id [String]
|
166
|
+
# Force disable connection
|
167
|
+
# Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection. *Please contact us in order to use this endpoint as it is disabled by default.*
|
168
|
+
# @param authorization_id [String]
|
163
169
|
# @param user_id [String]
|
164
170
|
# @param user_secret [String]
|
165
171
|
# @param [Hash] opts the optional parameters
|
@@ -223,9 +229,13 @@ module SnapTrade
|
|
223
229
|
end
|
224
230
|
|
225
231
|
|
226
|
-
# List all
|
232
|
+
# List all connections
|
227
233
|
#
|
228
|
-
# Returns a list of Brokerage Authorization
|
234
|
+
# Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.
|
235
|
+
#
|
236
|
+
# A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
|
237
|
+
#
|
238
|
+
# SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
229
239
|
#
|
230
240
|
# @param user_id [String]
|
231
241
|
# @param user_secret [String]
|
@@ -235,9 +245,13 @@ module SnapTrade
|
|
235
245
|
data
|
236
246
|
end
|
237
247
|
|
238
|
-
# List all
|
248
|
+
# List all connections
|
239
249
|
#
|
240
|
-
# Returns a list of Brokerage Authorization
|
250
|
+
# Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.
|
251
|
+
#
|
252
|
+
# A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
|
253
|
+
#
|
254
|
+
# SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
241
255
|
#
|
242
256
|
# @param user_id [String]
|
243
257
|
# @param user_secret [String]
|
@@ -246,8 +260,8 @@ module SnapTrade
|
|
246
260
|
list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
|
247
261
|
end
|
248
262
|
|
249
|
-
# List all
|
250
|
-
# Returns a list of Brokerage Authorization
|
263
|
+
# List all connections
|
264
|
+
# Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
251
265
|
# @param user_id [String]
|
252
266
|
# @param user_secret [String]
|
253
267
|
# @param [Hash] opts the optional parameters
|
@@ -257,8 +271,8 @@ module SnapTrade
|
|
257
271
|
data
|
258
272
|
end
|
259
273
|
|
260
|
-
# List all
|
261
|
-
# Returns a list of Brokerage Authorization
|
274
|
+
# List all connections
|
275
|
+
# Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
262
276
|
# @param user_id [String]
|
263
277
|
# @param user_secret [String]
|
264
278
|
# @param [Hash] opts the optional parameters
|
@@ -320,9 +334,11 @@ module SnapTrade
|
|
320
334
|
|
321
335
|
# Refresh holdings for a connection
|
322
336
|
#
|
323
|
-
# Trigger a holdings update for all accounts under this
|
337
|
+
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
|
338
|
+
#
|
339
|
+
# *Please contact support for access as this endpoint is not enabled by default.*
|
324
340
|
#
|
325
|
-
# @param authorization_id [String]
|
341
|
+
# @param authorization_id [String]
|
326
342
|
# @param user_id [String]
|
327
343
|
# @param user_secret [String]
|
328
344
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -333,9 +349,11 @@ module SnapTrade
|
|
333
349
|
|
334
350
|
# Refresh holdings for a connection
|
335
351
|
#
|
336
|
-
# Trigger a holdings update for all accounts under this
|
352
|
+
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
|
353
|
+
#
|
354
|
+
# *Please contact support for access as this endpoint is not enabled by default.*
|
337
355
|
#
|
338
|
-
# @param authorization_id [String]
|
356
|
+
# @param authorization_id [String]
|
339
357
|
# @param user_id [String]
|
340
358
|
# @param user_secret [String]
|
341
359
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -344,8 +362,8 @@ module SnapTrade
|
|
344
362
|
end
|
345
363
|
|
346
364
|
# Refresh holdings for a connection
|
347
|
-
# Trigger a holdings update for all accounts under this
|
348
|
-
# @param authorization_id [String]
|
365
|
+
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
|
366
|
+
# @param authorization_id [String]
|
349
367
|
# @param user_id [String]
|
350
368
|
# @param user_secret [String]
|
351
369
|
# @param [Hash] opts the optional parameters
|
@@ -356,8 +374,8 @@ module SnapTrade
|
|
356
374
|
end
|
357
375
|
|
358
376
|
# Refresh holdings for a connection
|
359
|
-
# Trigger a holdings update for all accounts under this
|
360
|
-
# @param authorization_id [String]
|
377
|
+
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
|
378
|
+
# @param authorization_id [String]
|
361
379
|
# @param user_id [String]
|
362
380
|
# @param user_secret [String]
|
363
381
|
# @param [Hash] opts the optional parameters
|
@@ -421,11 +439,11 @@ module SnapTrade
|
|
421
439
|
end
|
422
440
|
|
423
441
|
|
424
|
-
# Delete
|
442
|
+
# Delete connection
|
425
443
|
#
|
426
|
-
# Deletes
|
444
|
+
# Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
|
427
445
|
#
|
428
|
-
# @param authorization_id [String]
|
446
|
+
# @param authorization_id [String]
|
429
447
|
# @param user_id [String]
|
430
448
|
# @param user_secret [String]
|
431
449
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -434,11 +452,11 @@ module SnapTrade
|
|
434
452
|
nil
|
435
453
|
end
|
436
454
|
|
437
|
-
# Delete
|
455
|
+
# Delete connection
|
438
456
|
#
|
439
|
-
# Deletes
|
457
|
+
# Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
|
440
458
|
#
|
441
|
-
# @param authorization_id [String]
|
459
|
+
# @param authorization_id [String]
|
442
460
|
# @param user_id [String]
|
443
461
|
# @param user_secret [String]
|
444
462
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -446,9 +464,9 @@ module SnapTrade
|
|
446
464
|
remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
|
447
465
|
end
|
448
466
|
|
449
|
-
# Delete
|
450
|
-
# Deletes
|
451
|
-
# @param authorization_id [String]
|
467
|
+
# Delete connection
|
468
|
+
# Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
|
469
|
+
# @param authorization_id [String]
|
452
470
|
# @param user_id [String]
|
453
471
|
# @param user_secret [String]
|
454
472
|
# @param [Hash] opts the optional parameters
|
@@ -458,9 +476,9 @@ module SnapTrade
|
|
458
476
|
nil
|
459
477
|
end
|
460
478
|
|
461
|
-
# Delete
|
462
|
-
# Deletes
|
463
|
-
# @param authorization_id [String]
|
479
|
+
# Delete connection
|
480
|
+
# Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
|
481
|
+
# @param authorization_id [String]
|
464
482
|
# @param user_id [String]
|
465
483
|
# @param user_secret [String]
|
466
484
|
# @param [Hash] opts the optional parameters
|
@@ -16,7 +16,7 @@ module SnapTrade
|
|
16
16
|
# Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
|
17
17
|
attr_accessor :id
|
18
18
|
|
19
|
-
# Unique identifier for the connection
|
19
|
+
# Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
|
20
20
|
attr_accessor :brokerage_authorization
|
21
21
|
|
22
22
|
# Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
|
@@ -34,7 +34,7 @@ module SnapTrade
|
|
34
34
|
# Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage.
|
35
35
|
attr_accessor :created_date
|
36
36
|
|
37
|
-
# Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data.
|
37
|
+
# Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
|
38
38
|
attr_accessor :meta
|
39
39
|
|
40
40
|
# This field is deprecated.
|
@@ -11,62 +11,69 @@ require 'date'
|
|
11
11
|
require 'time'
|
12
12
|
|
13
13
|
module SnapTrade
|
14
|
+
# Describes a brokerage that SnapTrade supports.
|
14
15
|
class Brokerage
|
16
|
+
# Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
|
15
17
|
attr_accessor :id
|
16
18
|
|
19
|
+
# A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
20
|
+
attr_accessor :slug
|
21
|
+
|
17
22
|
# Full name of the brokerage.
|
18
23
|
attr_accessor :name
|
19
24
|
|
20
25
|
# A display-friendly name of the brokerage.
|
21
26
|
attr_accessor :display_name
|
22
27
|
|
28
|
+
# A brief description of the brokerage.
|
23
29
|
attr_accessor :description
|
24
30
|
|
31
|
+
# URL to the brokerage's logo.
|
25
32
|
attr_accessor :aws_s3_logo_url
|
26
33
|
|
34
|
+
# URL to the brokerage's logo in square format.
|
27
35
|
attr_accessor :aws_s3_square_logo_url
|
28
36
|
|
37
|
+
# This field is deprecated.
|
29
38
|
attr_accessor :open_url
|
30
39
|
|
31
|
-
#
|
32
|
-
attr_accessor :slug
|
33
|
-
|
40
|
+
# URL to the brokerage's website.
|
34
41
|
attr_accessor :url
|
35
42
|
|
43
|
+
# Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
|
36
44
|
attr_accessor :enabled
|
37
45
|
|
46
|
+
# Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
|
38
47
|
attr_accessor :maintenance_mode
|
39
48
|
|
49
|
+
# This field is deprecated. Please contact us if you have a valid use case for it.
|
40
50
|
attr_accessor :allows_fractional_units
|
41
51
|
|
52
|
+
# Whether the brokerage allows trading through SnapTrade.
|
42
53
|
attr_accessor :allows_trading
|
43
54
|
|
55
|
+
# This field is deprecated. Please contact us if you have a valid use case for it.
|
44
56
|
attr_accessor :has_reporting
|
45
57
|
|
58
|
+
# This field is deprecated. Please contact us if you have a valid use case for it.
|
46
59
|
attr_accessor :is_real_time_connection
|
47
60
|
|
48
|
-
attr_accessor :allows_trading_through_snaptrade_api
|
49
|
-
|
50
|
-
attr_accessor :is_scraping_integration
|
51
|
-
|
52
|
-
attr_accessor :default_currency
|
53
|
-
|
54
61
|
attr_accessor :brokerage_type
|
55
62
|
|
56
|
-
#
|
63
|
+
# This field is deprecated. Please contact us if you have a valid use case for it.
|
57
64
|
attr_accessor :exchanges
|
58
65
|
|
59
66
|
# Attribute mapping from ruby-style variable name to JSON key.
|
60
67
|
def self.attribute_map
|
61
68
|
{
|
62
69
|
:'id' => :'id',
|
70
|
+
:'slug' => :'slug',
|
63
71
|
:'name' => :'name',
|
64
72
|
:'display_name' => :'display_name',
|
65
73
|
:'description' => :'description',
|
66
74
|
:'aws_s3_logo_url' => :'aws_s3_logo_url',
|
67
75
|
:'aws_s3_square_logo_url' => :'aws_s3_square_logo_url',
|
68
76
|
:'open_url' => :'open_url',
|
69
|
-
:'slug' => :'slug',
|
70
77
|
:'url' => :'url',
|
71
78
|
:'enabled' => :'enabled',
|
72
79
|
:'maintenance_mode' => :'maintenance_mode',
|
@@ -74,9 +81,6 @@ module SnapTrade
|
|
74
81
|
:'allows_trading' => :'allows_trading',
|
75
82
|
:'has_reporting' => :'has_reporting',
|
76
83
|
:'is_real_time_connection' => :'is_real_time_connection',
|
77
|
-
:'allows_trading_through_snaptrade_api' => :'allows_trading_through_snaptrade_api',
|
78
|
-
:'is_scraping_integration' => :'is_scraping_integration',
|
79
|
-
:'default_currency' => :'default_currency',
|
80
84
|
:'brokerage_type' => :'brokerage_type',
|
81
85
|
:'exchanges' => :'exchanges'
|
82
86
|
}
|
@@ -91,13 +95,13 @@ module SnapTrade
|
|
91
95
|
def self.openapi_types
|
92
96
|
{
|
93
97
|
:'id' => :'String',
|
98
|
+
:'slug' => :'String',
|
94
99
|
:'name' => :'String',
|
95
100
|
:'display_name' => :'String',
|
96
101
|
:'description' => :'String',
|
97
102
|
:'aws_s3_logo_url' => :'String',
|
98
103
|
:'aws_s3_square_logo_url' => :'String',
|
99
104
|
:'open_url' => :'String',
|
100
|
-
:'slug' => :'String',
|
101
105
|
:'url' => :'String',
|
102
106
|
:'enabled' => :'Boolean',
|
103
107
|
:'maintenance_mode' => :'Boolean',
|
@@ -105,9 +109,6 @@ module SnapTrade
|
|
105
109
|
:'allows_trading' => :'Boolean',
|
106
110
|
:'has_reporting' => :'Boolean',
|
107
111
|
:'is_real_time_connection' => :'Boolean',
|
108
|
-
:'allows_trading_through_snaptrade_api' => :'Boolean',
|
109
|
-
:'is_scraping_integration' => :'Boolean',
|
110
|
-
:'default_currency' => :'String',
|
111
112
|
:'brokerage_type' => :'BrokerageType',
|
112
113
|
:'exchanges' => :'Array<Object>'
|
113
114
|
}
|
@@ -121,7 +122,6 @@ module SnapTrade
|
|
121
122
|
:'allows_fractional_units',
|
122
123
|
:'allows_trading',
|
123
124
|
:'has_reporting',
|
124
|
-
:'allows_trading_through_snaptrade_api',
|
125
125
|
])
|
126
126
|
end
|
127
127
|
|
@@ -144,6 +144,10 @@ module SnapTrade
|
|
144
144
|
self.id = attributes[:'id']
|
145
145
|
end
|
146
146
|
|
147
|
+
if attributes.key?(:'slug')
|
148
|
+
self.slug = attributes[:'slug']
|
149
|
+
end
|
150
|
+
|
147
151
|
if attributes.key?(:'name')
|
148
152
|
self.name = attributes[:'name']
|
149
153
|
end
|
@@ -168,10 +172,6 @@ module SnapTrade
|
|
168
172
|
self.open_url = attributes[:'open_url']
|
169
173
|
end
|
170
174
|
|
171
|
-
if attributes.key?(:'slug')
|
172
|
-
self.slug = attributes[:'slug']
|
173
|
-
end
|
174
|
-
|
175
175
|
if attributes.key?(:'url')
|
176
176
|
self.url = attributes[:'url']
|
177
177
|
end
|
@@ -200,18 +200,6 @@ module SnapTrade
|
|
200
200
|
self.is_real_time_connection = attributes[:'is_real_time_connection']
|
201
201
|
end
|
202
202
|
|
203
|
-
if attributes.key?(:'allows_trading_through_snaptrade_api')
|
204
|
-
self.allows_trading_through_snaptrade_api = attributes[:'allows_trading_through_snaptrade_api']
|
205
|
-
end
|
206
|
-
|
207
|
-
if attributes.key?(:'is_scraping_integration')
|
208
|
-
self.is_scraping_integration = attributes[:'is_scraping_integration']
|
209
|
-
end
|
210
|
-
|
211
|
-
if attributes.key?(:'default_currency')
|
212
|
-
self.default_currency = attributes[:'default_currency']
|
213
|
-
end
|
214
|
-
|
215
203
|
if attributes.key?(:'brokerage_type')
|
216
204
|
self.brokerage_type = attributes[:'brokerage_type']
|
217
205
|
end
|
@@ -242,13 +230,13 @@ module SnapTrade
|
|
242
230
|
return true if self.equal?(o)
|
243
231
|
self.class == o.class &&
|
244
232
|
id == o.id &&
|
233
|
+
slug == o.slug &&
|
245
234
|
name == o.name &&
|
246
235
|
display_name == o.display_name &&
|
247
236
|
description == o.description &&
|
248
237
|
aws_s3_logo_url == o.aws_s3_logo_url &&
|
249
238
|
aws_s3_square_logo_url == o.aws_s3_square_logo_url &&
|
250
239
|
open_url == o.open_url &&
|
251
|
-
slug == o.slug &&
|
252
240
|
url == o.url &&
|
253
241
|
enabled == o.enabled &&
|
254
242
|
maintenance_mode == o.maintenance_mode &&
|
@@ -256,9 +244,6 @@ module SnapTrade
|
|
256
244
|
allows_trading == o.allows_trading &&
|
257
245
|
has_reporting == o.has_reporting &&
|
258
246
|
is_real_time_connection == o.is_real_time_connection &&
|
259
|
-
allows_trading_through_snaptrade_api == o.allows_trading_through_snaptrade_api &&
|
260
|
-
is_scraping_integration == o.is_scraping_integration &&
|
261
|
-
default_currency == o.default_currency &&
|
262
247
|
brokerage_type == o.brokerage_type &&
|
263
248
|
exchanges == o.exchanges
|
264
249
|
end
|
@@ -272,7 +257,7 @@ module SnapTrade
|
|
272
257
|
# Calculates hash code according to all attributes.
|
273
258
|
# @return [Integer] Hash code
|
274
259
|
def hash
|
275
|
-
[id, name, display_name, description, aws_s3_logo_url, aws_s3_square_logo_url, open_url,
|
260
|
+
[id, slug, name, display_name, description, aws_s3_logo_url, aws_s3_square_logo_url, open_url, url, enabled, maintenance_mode, allows_fractional_units, allows_trading, has_reporting, is_real_time_connection, brokerage_type, exchanges].hash
|
276
261
|
end
|
277
262
|
|
278
263
|
# Builds the object from hash
|
@@ -11,28 +11,32 @@ require 'date'
|
|
11
11
|
require 'time'
|
12
12
|
|
13
13
|
module SnapTrade
|
14
|
+
# A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
14
15
|
class BrokerageAuthorization
|
16
|
+
# Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
|
15
17
|
attr_accessor :id
|
16
18
|
|
17
|
-
#
|
19
|
+
# Timestamp of when the connection was established in SnapTrade.
|
18
20
|
attr_accessor :created_date
|
19
21
|
|
20
|
-
#
|
22
|
+
# Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
|
21
23
|
attr_accessor :updated_date
|
22
24
|
|
23
25
|
attr_accessor :brokerage
|
24
26
|
|
25
|
-
#
|
27
|
+
# A short, human-readable name for the connection.
|
26
28
|
attr_accessor :name
|
27
29
|
|
30
|
+
# Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`.
|
28
31
|
attr_accessor :type
|
29
32
|
|
33
|
+
# Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios: - The user has changed their username or password at the brokerage. - The user has explicitly removed the access grant at the brokerage. - The session has expired at the brokerage and now requires explicit user re-authentication. Please see [this guide](https://docs.snaptrade.com/docs/fix-broken-connections) on how to fix a disabled connection.
|
30
34
|
attr_accessor :disabled
|
31
35
|
|
32
|
-
#
|
36
|
+
# Timestamp of when the connection was disabled in SnapTrade.
|
33
37
|
attr_accessor :disabled_date
|
34
38
|
|
35
|
-
# Additional data about brokerage
|
39
|
+
# Additional data about the connection. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
|
36
40
|
attr_accessor :meta
|
37
41
|
|
38
42
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -59,13 +63,13 @@ module SnapTrade
|
|
59
63
|
def self.openapi_types
|
60
64
|
{
|
61
65
|
:'id' => :'String',
|
62
|
-
:'created_date' => :'
|
63
|
-
:'updated_date' => :'
|
66
|
+
:'created_date' => :'Time',
|
67
|
+
:'updated_date' => :'Time',
|
64
68
|
:'brokerage' => :'Brokerage',
|
65
69
|
:'name' => :'String',
|
66
70
|
:'type' => :'String',
|
67
71
|
:'disabled' => :'Boolean',
|
68
|
-
:'disabled_date' => :'
|
72
|
+
:'disabled_date' => :'Time',
|
69
73
|
:'meta' => :'Hash<String, Object>'
|
70
74
|
}
|
71
75
|
end
|
@@ -11,12 +11,11 @@ require 'date'
|
|
11
11
|
require 'time'
|
12
12
|
|
13
13
|
module SnapTrade
|
14
|
-
# Response when register user is successful
|
15
14
|
class UserIDandSecret
|
16
15
|
# SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
|
17
16
|
attr_accessor :user_id
|
18
17
|
|
19
|
-
# SnapTrade User Secret randomly generated
|
18
|
+
# SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
|
20
19
|
attr_accessor :user_secret
|
21
20
|
|
22
21
|
# Attribute mapping from ruby-style variable name to JSON key.
|
data/lib/snaptrade/version.rb
CHANGED
@@ -115,7 +115,7 @@ describe 'AccountInformationApi' do
|
|
115
115
|
|
116
116
|
# unit tests for list_user_accounts
|
117
117
|
# List accounts
|
118
|
-
# Returns all brokerage accounts known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
118
|
+
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
119
119
|
# @param user_id
|
120
120
|
# @param user_secret
|
121
121
|
# @param [Hash] opts the optional parameters
|
@@ -41,7 +41,7 @@ describe 'AuthenticationApi' do
|
|
41
41
|
|
42
42
|
# unit tests for list_snap_trade_users
|
43
43
|
# List all users
|
44
|
-
# Returns a list of all registered user IDs.
|
44
|
+
# Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
45
45
|
# @param [Hash] opts the optional parameters
|
46
46
|
# @return [Array<String>]
|
47
47
|
describe 'list_snap_trade_users test' do
|
@@ -66,7 +66,7 @@ describe 'AuthenticationApi' do
|
|
66
66
|
|
67
67
|
# unit tests for register_snap_trade_user
|
68
68
|
# Register user
|
69
|
-
# Registers a new SnapTrade user under your
|
69
|
+
# Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
|
70
70
|
# @param snap_trade_register_user_request_body
|
71
71
|
# @param [Hash] opts the optional parameters
|
72
72
|
# @return [UserIDandSecret]
|