snaptrade 2.0.127 → 2.0.128

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f76bd21456b85ad4893f2ac6ee26379500e230cd8cf14389daf785b684c7648a
4
- data.tar.gz: 271b4ef9ad2f6c0857653d9377402e20984c9f5cc593a9f3d9e189b5b475feaa
3
+ metadata.gz: 626f5e2f3f2e1e9f8cf98974bb11e98c090f783971fd7451165cb8e649643d55
4
+ data.tar.gz: aed8e71c69da4adf9d749c04fda93f547a7d1cd81068308f5bf75652a4ab6cd4
5
5
  SHA512:
6
- metadata.gz: 97793f804b00d4f34f9cb6678a8f8543a75da9d40bff5db57f84f21c498d12cf02c399052e40b2a31949d25a40ede9edba30aa8b5a7acf697ada34f7a0743867
7
- data.tar.gz: a1b77ba592b1e45528054b8ef217c62f1b5f18a32eba99921e7f65a17bb194ba515b62b1cd95078cb46042f7844d08e869cbb4dbd834c83e2ffb03008dc4f13c
6
+ metadata.gz: 0c1e9ceb5f4d8ee854293d281a4056fe9fa003d70e798c4f33e31535e9448d515887cc4d4e053c660203ded61189dc79972cd880e38e61883a17d209ef0fc826
7
+ data.tar.gz: e76261a8ffe0b401b56f296d5f9bf905b0a2c991e7f81e22aefaf81c94461e503dec0e8b1e5854e4d3ebca277d561dab01b5cb5550ebee3b1c0e29365fcbf58f
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (2.0.127)
4
+ snaptrade (2.0.128)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
data/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/gem-v2.0.127-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.127)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.128-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.128)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -81,7 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
81
81
  Add to Gemfile:
82
82
 
83
83
  ```ruby
84
- gem 'snaptrade', '~> 2.0.127'
84
+ gem 'snaptrade', '~> 2.0.128'
85
85
  ```
86
86
 
87
87
  ## Getting Started<a id="getting-started"></a>
@@ -320,7 +320,7 @@ p result
320
320
 
321
321
  ### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
322
322
 
323
- Returns the detail of a single order in the specified account.
323
+ Returns the detail of a single order using the external order ID provided in the request body.
324
324
 
325
325
  This endpoint is always realtime and does not rely on cached data.
326
326
 
@@ -331,27 +331,30 @@ This endpoint only returns orders placed through SnapTrade. In other words, orde
331
331
 
332
332
  ```ruby
333
333
  result = snaptrade.account_information.get_user_account_order_detail(
334
+ external_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
335
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
334
336
  user_id: "snaptrade-user-123",
335
337
  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
336
- account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
337
- brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
338
338
  )
339
339
  p result
340
340
  ```
341
341
 
342
342
  #### ⚙️ Parameters<a id="⚙️-parameters"></a>
343
343
 
344
+ ##### external_order_id: `String`<a id="external_order_id-string"></a>
345
+ Order ID returned by brokerage. This is the unique identifier for the order in
346
+ the brokerage system.
347
+
348
+ ##### account_id: `String`<a id="account_id-string"></a>
344
349
  ##### user_id: `String`<a id="user_id-string"></a>
345
350
  ##### user_secret: `String`<a id="user_secret-string"></a>
346
- ##### account_id: `String`<a id="account_id-string"></a>
347
- ##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
348
351
  #### 🔄 Return<a id="🔄-return"></a>
349
352
 
350
353
  [AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
351
354
 
352
355
  #### 🌐 Endpoint<a id="🌐-endpoint"></a>
353
356
 
354
- `/accounts/{accountId}/orders/{brokerageOrderId}` `GET`
357
+ `/accounts/{accountId}/orders/details` `POST`
355
358
 
356
359
  [🔙 **Back to Table of Contents**](#table-of-contents)
357
360
 
@@ -499,64 +499,76 @@ module SnapTrade
499
499
 
500
500
  # Get account order detail
501
501
  #
502
- # Returns the detail of a single order in the specified account.
502
+ # Returns the detail of a single order using the external order ID provided in the request body.
503
503
  #
504
504
  # This endpoint is always realtime and does not rely on cached data.
505
505
  #
506
506
  # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
507
507
  #
508
+ # @param external_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
509
+ # @param account_id [String]
508
510
  # @param user_id [String]
509
511
  # @param user_secret [String]
510
- # @param account_id [String]
511
- # @param brokerage_order_id [String]
512
+ # @param body [AccountInformationGetUserAccountOrderDetailRequest]
512
513
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
513
- def get_user_account_order_detail(user_id:, user_secret:, account_id:, brokerage_order_id:, extra: {})
514
- data, _status_code, _headers = get_user_account_order_detail_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, extra)
514
+ def get_user_account_order_detail(external_order_id:, account_id:, user_id:, user_secret:, extra: {})
515
+ _body = {}
516
+ _body[:external_order_id] = external_order_id if external_order_id != SENTINEL
517
+ account_information_get_user_account_order_detail_request = _body
518
+ data, _status_code, _headers = get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
515
519
  data
516
520
  end
517
521
 
518
522
  # Get account order detail
519
523
  #
520
- # Returns the detail of a single order in the specified account.
524
+ # Returns the detail of a single order using the external order ID provided in the request body.
521
525
  #
522
526
  # This endpoint is always realtime and does not rely on cached data.
523
527
  #
524
528
  # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
525
529
  #
530
+ # @param external_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
531
+ # @param account_id [String]
526
532
  # @param user_id [String]
527
533
  # @param user_secret [String]
528
- # @param account_id [String]
529
- # @param brokerage_order_id [String]
534
+ # @param body [AccountInformationGetUserAccountOrderDetailRequest]
530
535
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
531
- def get_user_account_order_detail_with_http_info(user_id:, user_secret:, account_id:, brokerage_order_id:, extra: {})
532
- get_user_account_order_detail_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, extra)
536
+ def get_user_account_order_detail_with_http_info(external_order_id:, account_id:, user_id:, user_secret:, extra: {})
537
+ _body = {}
538
+ _body[:external_order_id] = external_order_id if external_order_id != SENTINEL
539
+ account_information_get_user_account_order_detail_request = _body
540
+ get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
533
541
  end
534
542
 
535
543
  # Get account order detail
536
- # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
544
+ # Returns the detail of a single order using the external order ID provided in the request body. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
545
+ # @param account_id [String]
537
546
  # @param user_id [String]
538
547
  # @param user_secret [String]
539
- # @param account_id [String]
540
- # @param brokerage_order_id [String]
548
+ # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest]
541
549
  # @param [Hash] opts the optional parameters
542
550
  # @return [AccountOrderRecord]
543
- private def get_user_account_order_detail_impl(user_id, user_secret, account_id, brokerage_order_id, opts = {})
544
- data, _status_code, _headers = get_user_account_order_detail_with_http_info(user_id, user_secret, account_id, brokerage_order_id, opts)
551
+ private def get_user_account_order_detail_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
552
+ data, _status_code, _headers = get_user_account_order_detail_with_http_info(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts)
545
553
  data
546
554
  end
547
555
 
548
556
  # Get account order detail
549
- # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
557
+ # Returns the detail of a single order using the external order ID provided in the request body. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
558
+ # @param account_id [String]
550
559
  # @param user_id [String]
551
560
  # @param user_secret [String]
552
- # @param account_id [String]
553
- # @param brokerage_order_id [String]
561
+ # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest]
554
562
  # @param [Hash] opts the optional parameters
555
563
  # @return [Array<(AccountOrderRecord, Integer, Hash)>] AccountOrderRecord data, response status code and response headers
556
- private def get_user_account_order_detail_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, opts = {})
564
+ private def get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
557
565
  if @api_client.config.debugging
558
566
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_order_detail ...'
559
567
  end
568
+ # verify the required parameter 'account_id' is set
569
+ if @api_client.config.client_side_validation && account_id.nil?
570
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountInformationApi.get_user_account_order_detail"
571
+ end
560
572
  # verify the required parameter 'user_id' is set
561
573
  if @api_client.config.client_side_validation && user_id.nil?
562
574
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountInformationApi.get_user_account_order_detail"
@@ -565,16 +577,12 @@ module SnapTrade
565
577
  if @api_client.config.client_side_validation && user_secret.nil?
566
578
  fail ArgumentError, "Missing the required parameter 'user_secret' when calling AccountInformationApi.get_user_account_order_detail"
567
579
  end
568
- # verify the required parameter 'account_id' is set
569
- if @api_client.config.client_side_validation && account_id.nil?
570
- fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountInformationApi.get_user_account_order_detail"
571
- end
572
- # verify the required parameter 'brokerage_order_id' is set
573
- if @api_client.config.client_side_validation && brokerage_order_id.nil?
574
- fail ArgumentError, "Missing the required parameter 'brokerage_order_id' when calling AccountInformationApi.get_user_account_order_detail"
580
+ # verify the required parameter 'account_information_get_user_account_order_detail_request' is set
581
+ if @api_client.config.client_side_validation && account_information_get_user_account_order_detail_request.nil?
582
+ fail ArgumentError, "Missing the required parameter 'account_information_get_user_account_order_detail_request' when calling AccountInformationApi.get_user_account_order_detail"
575
583
  end
576
584
  # resource path
577
- local_var_path = '/accounts/{accountId}/orders/{brokerageOrderId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'brokerageOrderId' + '}', CGI.escape(brokerage_order_id.to_s))
585
+ local_var_path = '/accounts/{accountId}/orders/details'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
578
586
 
579
587
  # query parameters
580
588
  query_params = opts[:query_params] || {}
@@ -585,12 +593,17 @@ module SnapTrade
585
593
  header_params = opts[:header_params] || {}
586
594
  # HTTP header 'Accept' (if needed)
587
595
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
596
+ # HTTP header 'Content-Type'
597
+ content_type = @api_client.select_header_content_type(['application/json'])
598
+ if !content_type.nil?
599
+ header_params['Content-Type'] = content_type
600
+ end
588
601
 
589
602
  # form parameters
590
603
  form_params = opts[:form_params] || {}
591
604
 
592
605
  # http body (model)
593
- post_body = opts[:debug_body]
606
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(account_information_get_user_account_order_detail_request)
594
607
 
595
608
  # return_type
596
609
  return_type = opts[:debug_return_type] || 'AccountOrderRecord'
@@ -608,7 +621,7 @@ module SnapTrade
608
621
  :return_type => return_type
609
622
  )
610
623
 
611
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
624
+ data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
612
625
  if @api_client.config.debugging
613
626
  @api_client.config.logger.debug "API called: AccountInformationApi#get_user_account_order_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
614
627
  end
@@ -0,0 +1,222 @@
1
+ =begin
2
+ #SnapTrade
3
+
4
+ #Connect brokerage accounts to your app for live positions and trading
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@snaptrade.com
8
+ =end
9
+
10
+ require 'date'
11
+ require 'time'
12
+
13
+ module SnapTrade
14
+ class AccountInformationGetUserAccountOrderDetailRequest
15
+ # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
16
+ attr_accessor :external_order_id
17
+
18
+ # Attribute mapping from ruby-style variable name to JSON key.
19
+ def self.attribute_map
20
+ {
21
+ :'external_order_id' => :'external_order_id'
22
+ }
23
+ end
24
+
25
+ # Returns all the JSON keys this model knows about
26
+ def self.acceptable_attributes
27
+ attribute_map.values
28
+ end
29
+
30
+ # Attribute type mapping.
31
+ def self.openapi_types
32
+ {
33
+ :'external_order_id' => :'String'
34
+ }
35
+ end
36
+
37
+ # List of attributes with nullable: true
38
+ def self.openapi_nullable
39
+ Set.new([
40
+ ])
41
+ end
42
+
43
+ # Initializes the object
44
+ # @param [Hash] attributes Model attributes in the form of hash
45
+ def initialize(attributes = {})
46
+ if (!attributes.is_a?(Hash))
47
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::AccountInformationGetUserAccountOrderDetailRequest` initialize method"
48
+ end
49
+
50
+ # check to see if the attribute exists and convert string to symbol for hash key
51
+ attributes = attributes.each_with_object({}) { |(k, v), h|
52
+ if (!self.class.attribute_map.key?(k.to_sym))
53
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::AccountInformationGetUserAccountOrderDetailRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
54
+ end
55
+ h[k.to_sym] = v
56
+ }
57
+
58
+ if attributes.key?(:'external_order_id')
59
+ self.external_order_id = attributes[:'external_order_id']
60
+ end
61
+ end
62
+
63
+ # Show invalid properties with the reasons. Usually used together with valid?
64
+ # @return Array for valid properties with the reasons
65
+ def list_invalid_properties
66
+ invalid_properties = Array.new
67
+ if @external_order_id.nil?
68
+ invalid_properties.push('invalid value for "external_order_id", external_order_id cannot be nil.')
69
+ end
70
+
71
+ invalid_properties
72
+ end
73
+
74
+ # Check to see if the all the properties in the model are valid
75
+ # @return true if the model is valid
76
+ def valid?
77
+ return false if @external_order_id.nil?
78
+ true
79
+ end
80
+
81
+ # Checks equality by comparing each attribute.
82
+ # @param [Object] Object to be compared
83
+ def ==(o)
84
+ return true if self.equal?(o)
85
+ self.class == o.class &&
86
+ external_order_id == o.external_order_id
87
+ end
88
+
89
+ # @see the `==` method
90
+ # @param [Object] Object to be compared
91
+ def eql?(o)
92
+ self == o
93
+ end
94
+
95
+ # Calculates hash code according to all attributes.
96
+ # @return [Integer] Hash code
97
+ def hash
98
+ [external_order_id].hash
99
+ end
100
+
101
+ # Builds the object from hash
102
+ # @param [Hash] attributes Model attributes in the form of hash
103
+ # @return [Object] Returns the model itself
104
+ def self.build_from_hash(attributes)
105
+ new.build_from_hash(attributes)
106
+ end
107
+
108
+ # Builds the object from hash
109
+ # @param [Hash] attributes Model attributes in the form of hash
110
+ # @return [Object] Returns the model itself
111
+ def build_from_hash(attributes)
112
+ return nil unless attributes.is_a?(Hash)
113
+ attributes = attributes.transform_keys(&:to_sym)
114
+ self.class.openapi_types.each_pair do |key, type|
115
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
116
+ self.send("#{key}=", nil)
117
+ elsif type =~ /\AArray<(.*)>/i
118
+ # check to ensure the input is an array given that the attribute
119
+ # is documented as an array but the input is not
120
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
121
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
122
+ end
123
+ elsif !attributes[self.class.attribute_map[key]].nil?
124
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
125
+ end
126
+ end
127
+
128
+ self
129
+ end
130
+
131
+ # Deserializes the data based on type
132
+ # @param string type Data type
133
+ # @param string value Value to be deserialized
134
+ # @return [Object] Deserialized data
135
+ def _deserialize(type, value)
136
+ case type.to_sym
137
+ when :Time
138
+ Time.parse(value)
139
+ when :Date
140
+ Date.parse(value)
141
+ when :String
142
+ value.to_s
143
+ when :Integer
144
+ value.to_i
145
+ when :Float
146
+ value.to_f
147
+ when :Boolean
148
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
149
+ true
150
+ else
151
+ false
152
+ end
153
+ when :Object
154
+ # generic object (usually a Hash), return directly
155
+ value
156
+ when /\AArray<(?<inner_type>.+)>\z/
157
+ inner_type = Regexp.last_match[:inner_type]
158
+ value.map { |v| _deserialize(inner_type, v) }
159
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
160
+ k_type = Regexp.last_match[:k_type]
161
+ v_type = Regexp.last_match[:v_type]
162
+ {}.tap do |hash|
163
+ value.each do |k, v|
164
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
165
+ end
166
+ end
167
+ else # model
168
+ # models (e.g. Pet) or oneOf
169
+ klass = SnapTrade.const_get(type)
170
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
171
+ end
172
+ end
173
+
174
+ # Returns the string representation of the object
175
+ # @return [String] String presentation of the object
176
+ def to_s
177
+ to_hash.to_s
178
+ end
179
+
180
+ # to_body is an alias to to_hash (backward compatibility)
181
+ # @return [Hash] Returns the object in the form of hash
182
+ def to_body
183
+ to_hash
184
+ end
185
+
186
+ # Returns the object in the form of hash
187
+ # @return [Hash] Returns the object in the form of hash
188
+ def to_hash
189
+ hash = {}
190
+ self.class.attribute_map.each_pair do |attr, param|
191
+ value = self.send(attr)
192
+ if value.nil?
193
+ is_nullable = self.class.openapi_nullable.include?(attr)
194
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
195
+ end
196
+
197
+ hash[param] = _to_hash(value)
198
+ end
199
+ hash
200
+ end
201
+
202
+ # Outputs non-array value in the form of hash
203
+ # For object, use to_hash. Otherwise, just return the value
204
+ # @param [Object] value Any valid value
205
+ # @return [Hash] Returns the value in the form of hash
206
+ def _to_hash(value)
207
+ if value.is_a?(Array)
208
+ value.compact.map { |v| _to_hash(v) }
209
+ elsif value.is_a?(Hash)
210
+ {}.tap do |hash|
211
+ value.each { |k, v| hash[k] = _to_hash(v) }
212
+ end
213
+ elsif value.respond_to? :to_hash
214
+ value.to_hash
215
+ else
216
+ value
217
+ end
218
+ end
219
+
220
+ end
221
+
222
+ end
@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
8
8
  =end
9
9
 
10
10
  module SnapTrade
11
- VERSION = '2.0.127'
11
+ VERSION = '2.0.128'
12
12
  end
data/lib/snaptrade.rb CHANGED
@@ -21,6 +21,7 @@ require 'snaptrade/models/account_balance'
21
21
  require 'snaptrade/models/account_balance_total'
22
22
  require 'snaptrade/models/account_holdings'
23
23
  require 'snaptrade/models/account_holdings_account'
24
+ require 'snaptrade/models/account_information_get_user_account_order_detail_request'
24
25
  require 'snaptrade/models/account_order_record'
25
26
  require 'snaptrade/models/account_order_record_child_brokerage_order_ids'
26
27
  require 'snaptrade/models/account_order_record_option_symbol'
@@ -90,11 +90,11 @@ describe 'AccountInformationApi' do
90
90
 
91
91
  # unit tests for get_user_account_order_detail
92
92
  # Get account order detail
93
- # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
93
+ # Returns the detail of a single order using the external order ID provided in the request body. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
94
+ # @param account_id
94
95
  # @param user_id
95
96
  # @param user_secret
96
- # @param account_id
97
- # @param brokerage_order_id
97
+ # @param account_information_get_user_account_order_detail_request
98
98
  # @param [Hash] opts the optional parameters
99
99
  # @return [AccountOrderRecord]
100
100
  describe 'get_user_account_order_detail test' do
@@ -0,0 +1,29 @@
1
+ =begin
2
+ #SnapTrade
3
+
4
+ #Connect brokerage accounts to your app for live positions and trading
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@snaptrade.com
8
+ =end
9
+
10
+ require 'spec_helper'
11
+ require 'json'
12
+ require 'date'
13
+
14
+ # Unit tests for SnapTrade::AccountInformationGetUserAccountOrderDetailRequest
15
+ describe SnapTrade::AccountInformationGetUserAccountOrderDetailRequest do
16
+ let(:instance) { SnapTrade::AccountInformationGetUserAccountOrderDetailRequest.new }
17
+
18
+ describe 'test an instance of AccountInformationGetUserAccountOrderDetailRequest' do
19
+ it 'should create an instance of AccountInformationGetUserAccountOrderDetailRequest' do
20
+ expect(instance).to be_instance_of(SnapTrade::AccountInformationGetUserAccountOrderDetailRequest)
21
+ end
22
+ end
23
+ describe 'test attribute "external_order_id"' do
24
+ it 'should work' do
25
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
26
+ end
27
+ end
28
+
29
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: snaptrade
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.127
4
+ version: 2.0.128
5
5
  platform: ruby
6
6
  authors:
7
7
  - SnapTrade
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-08-27 00:00:00.000000000 Z
11
+ date: 2025-09-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -100,6 +100,7 @@ files:
100
100
  - lib/snaptrade/models/account_balance_total.rb
101
101
  - lib/snaptrade/models/account_holdings.rb
102
102
  - lib/snaptrade/models/account_holdings_account.rb
103
+ - lib/snaptrade/models/account_information_get_user_account_order_detail_request.rb
103
104
  - lib/snaptrade/models/account_order_record.rb
104
105
  - lib/snaptrade/models/account_order_record_child_brokerage_order_ids.rb
105
106
  - lib/snaptrade/models/account_order_record_option_symbol.rb
@@ -267,6 +268,7 @@ files:
267
268
  - spec/models/account_balance_total_spec.rb
268
269
  - spec/models/account_holdings_account_spec.rb
269
270
  - spec/models/account_holdings_spec.rb
271
+ - spec/models/account_information_get_user_account_order_detail_request_spec.rb
270
272
  - spec/models/account_order_record_child_brokerage_order_ids_spec.rb
271
273
  - spec/models/account_order_record_option_symbol_spec.rb
272
274
  - spec/models/account_order_record_quote_currency_spec.rb
@@ -445,170 +447,171 @@ signing_key:
445
447
  specification_version: 4
446
448
  summary: SnapTrade Ruby Gem
447
449
  test_files:
450
+ - spec/api/options_api_spec.rb
448
451
  - spec/api/trading_api_spec.rb
449
- - spec/api/connections_api_spec.rb
450
- - spec/api/reference_data_api_spec.rb
451
452
  - spec/api/transactions_and_reporting_api_spec.rb
452
- - spec/api/account_information_api_spec.rb
453
453
  - spec/api/api_status_api_spec.rb
454
+ - spec/api/connections_api_spec.rb
455
+ - spec/api/account_information_api_spec.rb
454
456
  - spec/api/authentication_api_spec.rb
455
- - spec/api/options_api_spec.rb
457
+ - spec/api/reference_data_api_spec.rb
456
458
  - spec/api_client_spec.rb
457
459
  - spec/configuration_spec.rb
458
460
  - spec/getting_started_spec.rb
459
- - spec/models/option_brokerage_symbol_spec.rb
460
- - spec/models/trading_instrument_spec.rb
461
- - spec/models/session_event_type_spec.rb
462
- - spec/models/account_order_record_status_spec.rb
463
- - spec/models/time_in_force_strict_spec.rb
464
- - spec/models/account_universal_activity_spec.rb
465
- - spec/models/mleg_order_type_strict_spec.rb
466
- - spec/models/type_spec.rb
467
- - spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
468
- - spec/models/transactions_status_spec.rb
469
- - spec/models/encrypted_response_encrypted_message_data_spec.rb
470
- - spec/models/mleg_trade_form_spec.rb
471
- - spec/models/crypto_trading_instrument_spec.rb
461
+ - spec/models/brokerage_type_spec.rb
472
462
  - spec/models/sub_period_return_rate_spec.rb
473
- - spec/models/validated_trade_body_spec.rb
463
+ - spec/models/time_in_force_strict_spec.rb
474
464
  - spec/models/manual_trade_form_with_options_spec.rb
475
- - spec/models/mleg_instrument_type_spec.rb
465
+ - spec/models/simple_order_form_spec.rb
466
+ - spec/models/option_brokerage_symbol_spec.rb
467
+ - spec/models/model402_brokerage_auth_disabled_response_spec.rb
476
468
  - spec/models/net_contributions_spec.rb
477
- - spec/models/symbols_quotes_inner_spec.rb
478
- - spec/models/account_spec.rb
479
- - spec/models/account_order_record_option_symbol_spec.rb
480
- - spec/models/position_symbol_spec.rb
481
- - spec/models/account_balance_total_spec.rb
482
- - spec/models/status_spec.rb
483
- - spec/models/us_exchange_spec.rb
484
- - spec/models/underlying_symbol_spec.rb
469
+ - spec/models/delete_user_response_spec.rb
485
470
  - spec/models/snap_trade_login_user_request_body_spec.rb
486
- - spec/models/manual_trade_replace_form_spec.rb
487
- - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
471
+ - spec/models/order_updated_response_spec.rb
472
+ - spec/models/symbol_query_spec.rb
473
+ - spec/models/action_strict_with_options_spec.rb
474
+ - spec/models/account_balance_spec.rb
488
475
  - spec/models/performance_custom_spec.rb
489
- - spec/models/cryptocurrency_pair_quote_spec.rb
490
- - spec/models/dividend_at_date_spec.rb
491
- - spec/models/mleg_leg_spec.rb
492
- - spec/models/auth_type_spec.rb
493
- - spec/models/option_chain_inner_spec.rb
494
- - spec/models/model404_failed_request_response_spec.rb
495
- - spec/models/crypto_order_form_spec.rb
496
- - spec/models/currency_spec.rb
497
- - spec/models/manual_trade_form_bracket_spec.rb
498
- - spec/models/crypto_order_preview_estimated_fee_spec.rb
499
- - spec/models/manual_trade_balance_spec.rb
500
- - spec/models/strategy_order_record_status_spec.rb
501
- - spec/models/model401_failed_request_response_spec.rb
502
- - spec/models/cryptocurrency_pair_spec.rb
503
- - spec/models/symbol_currency_spec.rb
504
- - spec/models/underlying_symbol_exchange_spec.rb
505
- - spec/models/account_holdings_account_spec.rb
506
- - spec/models/stop_loss_spec.rb
507
476
  - spec/models/take_profit_spec.rb
508
- - spec/models/login_redirect_uri_spec.rb
509
- - spec/models/snap_trade_holdings_total_value_spec.rb
510
- - spec/models/snap_trade_holdings_account_spec.rb
511
- - spec/models/manual_trade_spec.rb
512
- - spec/models/account_universal_activity_symbol_spec.rb
513
- - spec/models/balance_spec.rb
514
- - spec/models/holdings_status_spec.rb
515
- - spec/models/brokerage_instrument_spec.rb
516
- - spec/models/manual_trade_impact_spec.rb
517
- - spec/models/options_position_spec.rb
518
- - spec/models/model500_unexpected_exception_response_spec.rb
519
- - spec/models/balance_currency_spec.rb
520
- - spec/models/crypto_order_form_time_in_force_spec.rb
521
- - spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
522
- - spec/models/snap_trade_register_user_request_body_spec.rb
523
- - spec/models/options_symbol_spec.rb
524
- - spec/models/account_order_record_child_brokerage_order_ids_spec.rb
525
- - spec/models/authentication_login_snap_trade_user200_response_spec.rb
526
- - spec/models/encrypted_response_spec.rb
527
- - spec/models/strategy_quotes_greek_spec.rb
528
- - spec/models/brokerage_instruments_response_spec.rb
529
477
  - spec/models/account_order_record_spec.rb
530
- - spec/models/exchange_spec.rb
531
- - spec/models/security_type_spec.rb
532
- - spec/models/option_strategy_legs_inner_spec.rb
533
- - spec/models/account_balance_spec.rb
534
478
  - spec/models/rate_of_return_response_spec.rb
535
479
  - spec/models/manual_trade_and_impact_spec.rb
536
- - spec/models/session_event_spec.rb
537
- - spec/models/child_brokerage_order_ids_spec.rb
538
- - spec/models/underlying_symbol_type_spec.rb
539
- - spec/models/brokerage_authorization_type_read_only_spec.rb
540
- - spec/models/crypto_order_form_type_spec.rb
541
- - spec/models/model400_failed_request_response_spec.rb
542
- - spec/models/action_strict_spec.rb
543
- - spec/models/account_order_record_quote_universal_symbol_spec.rb
480
+ - spec/models/manual_trade_spec.rb
481
+ - spec/models/account_universal_activity_spec.rb
482
+ - spec/models/symbols_quotes_inner_spec.rb
483
+ - spec/models/past_value_spec.rb
544
484
  - spec/models/recent_orders_response_spec.rb
545
- - spec/models/brokerage_type_spec.rb
546
- - spec/models/paginated_universal_activity_spec.rb
547
- - spec/models/trading_cancel_user_account_order_request_spec.rb
548
- - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
549
- - spec/models/account_status_spec.rb
550
- - spec/models/connections_session_events200_response_inner_spec.rb
551
- - spec/models/trading_instrument_type_spec.rb
552
- - spec/models/manual_trade_form_spec.rb
553
- - spec/models/rate_of_return_object_spec.rb
554
- - spec/models/monthly_dividends_spec.rb
555
- - spec/models/account_universal_activity_currency_spec.rb
556
- - spec/models/account_simple_spec.rb
557
- - spec/models/mleg_action_strict_spec.rb
558
- - spec/models/net_dividend_spec.rb
559
- - spec/models/simple_order_form_time_in_force_spec.rb
560
- - spec/models/brokerage_spec.rb
561
- - spec/models/symbol_query_spec.rb
562
- - spec/models/order_type_strict_spec.rb
485
+ - spec/models/cryptocurrency_pair_spec.rb
486
+ - spec/models/account_information_get_user_account_order_detail_request_spec.rb
487
+ - spec/models/model404_failed_request_response_spec.rb
488
+ - spec/models/strategy_type_spec.rb
489
+ - spec/models/figi_instrument_spec.rb
490
+ - spec/models/authentication_login_snap_trade_user200_response_spec.rb
491
+ - spec/models/symbol_spec.rb
492
+ - spec/models/options_position_currency_spec.rb
493
+ - spec/models/snap_trade_holdings_account_spec.rb
494
+ - spec/models/cryptocurrency_pair_quote_spec.rb
495
+ - spec/models/position_symbol_spec.rb
496
+ - spec/models/balance_spec.rb
497
+ - spec/models/login_redirect_uri_spec.rb
498
+ - spec/models/option_chain_inner_chain_per_root_inner_spec.rb
499
+ - spec/models/encrypted_response_spec.rb
500
+ - spec/models/model400_failed_request_response_spec.rb
501
+ - spec/models/strategy_order_record_status_spec.rb
563
502
  - spec/models/universal_activity_spec.rb
564
- - spec/models/position_currency_spec.rb
565
- - spec/models/mleg_trading_instrument_spec.rb
503
+ - spec/models/manual_trade_replace_form_spec.rb
504
+ - spec/models/model403_failed_request_response_spec.rb
505
+ - spec/models/mleg_trade_form_spec.rb
506
+ - spec/models/account_order_record_child_brokerage_order_ids_spec.rb
507
+ - spec/models/simple_order_form_type_spec.rb
508
+ - spec/models/model425_failed_request_response_spec.rb
566
509
  - spec/models/timeframe_spec.rb
567
- - spec/models/cancel_order_response_spec.rb
568
- - spec/models/account_order_record_universal_symbol_spec.rb
569
- - spec/models/crypto_trading_instrument_type_spec.rb
570
- - spec/models/crypto_order_preview_spec.rb
571
- - spec/models/strategy_order_record_spec.rb
572
- - spec/models/action_strict_with_options_spec.rb
573
- - spec/models/symbol_exchange_spec.rb
574
- - spec/models/partner_data_spec.rb
575
- - spec/models/simple_order_form_spec.rb
576
- - spec/models/mleg_price_effect_strict_spec.rb
577
- - spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
510
+ - spec/models/balance_currency_spec.rb
511
+ - spec/models/transactions_status_spec.rb
512
+ - spec/models/manual_trade_symbol_spec.rb
513
+ - spec/models/symbol_currency_spec.rb
514
+ - spec/models/connection_portal_version_spec.rb
578
515
  - spec/models/model403_feature_not_enabled_response_spec.rb
579
- - spec/models/figi_instrument_spec.rb
516
+ - spec/models/monthly_dividends_spec.rb
517
+ - spec/models/account_order_record_universal_symbol_spec.rb
580
518
  - spec/models/brokerage_authorization_disabled_confirmation_spec.rb
581
- - spec/models/model425_failed_request_response_spec.rb
582
- - spec/models/pagination_details_spec.rb
583
- - spec/models/account_holdings_spec.rb
519
+ - spec/models/trading_instrument_type_spec.rb
520
+ - spec/models/crypto_order_form_time_in_force_spec.rb
521
+ - spec/models/session_event_spec.rb
522
+ - spec/models/account_order_record_quote_currency_spec.rb
523
+ - spec/models/user_i_dand_secret_spec.rb
524
+ - spec/models/mleg_trading_instrument_spec.rb
525
+ - spec/models/stop_loss_spec.rb
584
526
  - spec/models/exchange_rate_pairs_spec.rb
585
- - spec/models/manual_trade_symbol_spec.rb
527
+ - spec/models/crypto_order_preview_estimated_fee_spec.rb
528
+ - spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
529
+ - spec/models/order_type_strict_spec.rb
586
530
  - spec/models/account_universal_activity_option_symbol_spec.rb
587
- - spec/models/strategy_quotes_spec.rb
588
- - spec/models/symbol_spec.rb
589
- - spec/models/account_order_record_quote_currency_spec.rb
590
- - spec/models/simple_order_form_type_spec.rb
591
- - spec/models/strategy_type_spec.rb
592
- - spec/models/account_sync_status_spec.rb
593
- - spec/models/model403_failed_request_response_spec.rb
594
- - spec/models/mleg_order_response_spec.rb
595
- - spec/models/option_strategy_spec.rb
531
+ - spec/models/paginated_universal_activity_spec.rb
532
+ - spec/models/account_holdings_account_spec.rb
533
+ - spec/models/manual_trade_impact_spec.rb
596
534
  - spec/models/brokerage_authorization_spec.rb
597
- - spec/models/delete_user_response_spec.rb
598
- - spec/models/model402_brokerage_auth_disabled_response_spec.rb
599
- - spec/models/connection_portal_version_spec.rb
535
+ - spec/models/crypto_order_preview_spec.rb
536
+ - spec/models/account_order_record_quote_universal_symbol_spec.rb
537
+ - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
538
+ - spec/models/crypto_order_form_spec.rb
539
+ - spec/models/status_spec.rb
540
+ - spec/models/snap_trade_holdings_total_value_spec.rb
541
+ - spec/models/currency_spec.rb
600
542
  - spec/models/universal_symbol_spec.rb
601
- - spec/models/symbol_figi_instrument_spec.rb
602
- - spec/models/option_chain_inner_chain_per_root_inner_spec.rb
603
- - spec/models/option_leg_action_spec.rb
604
- - spec/models/position_spec.rb
543
+ - spec/models/options_symbol_spec.rb
544
+ - spec/models/account_status_spec.rb
545
+ - spec/models/rate_of_return_object_spec.rb
605
546
  - spec/models/notional_value_spec.rb
606
- - spec/models/past_value_spec.rb
547
+ - spec/models/mleg_instrument_type_spec.rb
548
+ - spec/models/connections_session_events200_response_inner_spec.rb
549
+ - spec/models/account_universal_activity_currency_spec.rb
550
+ - spec/models/strategy_order_record_spec.rb
551
+ - spec/models/option_strategy_spec.rb
552
+ - spec/models/brokerage_authorization_type_read_only_spec.rb
553
+ - spec/models/mleg_order_response_spec.rb
554
+ - spec/models/account_order_record_option_symbol_spec.rb
555
+ - spec/models/options_position_spec.rb
556
+ - spec/models/action_strict_spec.rb
557
+ - spec/models/mleg_action_strict_spec.rb
558
+ - spec/models/mleg_leg_spec.rb
559
+ - spec/models/model500_unexpected_exception_response_spec.rb
607
560
  - spec/models/manual_trade_form_notional_value_spec.rb
608
- - spec/models/options_position_currency_spec.rb
609
- - spec/models/connection_type_spec.rb
561
+ - spec/models/mleg_price_effect_strict_spec.rb
562
+ - spec/models/type_spec.rb
563
+ - spec/models/trading_instrument_spec.rb
564
+ - spec/models/brokerage_instruments_response_spec.rb
565
+ - spec/models/account_universal_activity_symbol_spec.rb
566
+ - spec/models/option_leg_action_spec.rb
567
+ - spec/models/account_holdings_spec.rb
610
568
  - spec/models/option_leg_spec.rb
611
- - spec/models/user_i_dand_secret_spec.rb
612
- - spec/models/order_updated_response_spec.rb
569
+ - spec/models/brokerage_instrument_spec.rb
570
+ - spec/models/holdings_status_spec.rb
571
+ - spec/models/mleg_order_type_strict_spec.rb
572
+ - spec/models/encrypted_response_encrypted_message_data_spec.rb
573
+ - spec/models/strategy_quotes_spec.rb
574
+ - spec/models/crypto_trading_instrument_spec.rb
575
+ - spec/models/model401_failed_request_response_spec.rb
576
+ - spec/models/account_simple_spec.rb
577
+ - spec/models/connection_type_spec.rb
578
+ - spec/models/brokerage_spec.rb
579
+ - spec/models/underlying_symbol_exchange_spec.rb
580
+ - spec/models/manual_trade_form_spec.rb
581
+ - spec/models/symbol_figi_instrument_spec.rb
582
+ - spec/models/dividend_at_date_spec.rb
583
+ - spec/models/snap_trade_register_user_request_body_spec.rb
584
+ - spec/models/child_brokerage_order_ids_spec.rb
585
+ - spec/models/option_strategy_legs_inner_spec.rb
586
+ - spec/models/crypto_order_form_type_spec.rb
587
+ - spec/models/us_exchange_spec.rb
588
+ - spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
589
+ - spec/models/cancel_order_response_spec.rb
590
+ - spec/models/account_spec.rb
591
+ - spec/models/manual_trade_form_bracket_spec.rb
592
+ - spec/models/auth_type_spec.rb
593
+ - spec/models/simple_order_form_time_in_force_spec.rb
594
+ - spec/models/account_order_record_status_spec.rb
613
595
  - spec/models/option_type_spec.rb
596
+ - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
597
+ - spec/models/validated_trade_body_spec.rb
598
+ - spec/models/trading_cancel_user_account_order_request_spec.rb
599
+ - spec/models/underlying_symbol_spec.rb
600
+ - spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
601
+ - spec/models/partner_data_spec.rb
602
+ - spec/models/underlying_symbol_type_spec.rb
603
+ - spec/models/exchange_spec.rb
604
+ - spec/models/pagination_details_spec.rb
605
+ - spec/models/session_event_type_spec.rb
606
+ - spec/models/account_sync_status_spec.rb
607
+ - spec/models/option_chain_inner_spec.rb
608
+ - spec/models/position_currency_spec.rb
609
+ - spec/models/net_dividend_spec.rb
610
+ - spec/models/symbol_exchange_spec.rb
611
+ - spec/models/strategy_quotes_greek_spec.rb
612
+ - spec/models/crypto_trading_instrument_type_spec.rb
613
+ - spec/models/account_balance_total_spec.rb
614
+ - spec/models/manual_trade_balance_spec.rb
615
+ - spec/models/security_type_spec.rb
616
+ - spec/models/position_spec.rb
614
617
  - spec/spec_helper.rb