Class: TinkoffInvestClient::OrdersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tinkoff_invest_client/api/orders_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrdersApi

Returns a new instance of OrdersApi.



19
20
21
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#orders_cancel_post(order_id, opts = {}) ⇒ Empty

Отмена заявки

Parameters:

  • order_id (String) —

    ID заявки

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Номер счета (по умолчанию - Тинькофф)

Returns:



27
28
29
30
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 27

def orders_cancel_post(order_id, opts = {})
  data, _status_code, _headers = orders_cancel_post_with_http_info(order_id, opts)
  data
end

#orders_cancel_post_with_http_info(order_id, opts = {}) ⇒ Array<(Empty, Integer, Hash)>

Отмена заявки

Parameters:

  • order_id (String) —

    ID заявки

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Номер счета (по умолчанию - Тинькофф)

Returns:

  • (Array<(Empty, Integer, Hash)>) —

    Empty data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 37

def orders_cancel_post_with_http_info(order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.orders_cancel_post ...'
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling OrdersApi.orders_cancel_post"
  end
  # resource path
  local_var_path = '/orders/cancel'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'orderId'] = order_id
  query_params[:'brokerAccountId'] = opts[:'broker_account_id'] if !opts[:'broker_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Empty'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sso_auth']

  new_options = opts.merge(
    :operation => :"OrdersApi.orders_cancel_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrdersApi#orders_cancel_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orders_get(opts = {}) ⇒ OrdersResponse

Получение списка активных заявок

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Номер счета (по умолчанию - Тинькофф)

Returns:



91
92
93
94
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 91

def orders_get(opts = {})
  data, _status_code, _headers = orders_get_with_http_info(opts)
  data
end

#orders_get_with_http_info(opts = {}) ⇒ Array<(OrdersResponse, Integer, Hash)>

Получение списка активных заявок

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Номер счета (по умолчанию - Тинькофф)

Returns:

  • (Array<(OrdersResponse, Integer, Hash)>) —

    OrdersResponse data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 100

def orders_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.orders_get ...'
  end
  # resource path
  local_var_path = '/orders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'brokerAccountId'] = opts[:'broker_account_id'] if !opts[:'broker_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OrdersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sso_auth']

  new_options = opts.merge(
    :operation => :"OrdersApi.orders_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrdersApi#orders_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orders_limit_order_post(figi, limit_order_request, opts = {}) ⇒ LimitOrderResponse

Создание лимитной заявки

Parameters:

  • figi (String) —

    FIGI инструмента

  • limit_order_request (LimitOrderRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Номер счета (по умолчанию - Тинькофф)

Returns:



151
152
153
154
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 151

def orders_limit_order_post(figi, limit_order_request, opts = {})
  data, _status_code, _headers = orders_limit_order_post_with_http_info(figi, limit_order_request, opts)
  data
end

#orders_limit_order_post_with_http_info(figi, limit_order_request, opts = {}) ⇒ Array<(LimitOrderResponse, Integer, Hash)>

Создание лимитной заявки

Parameters:

  • figi (String) —

    FIGI инструмента

  • limit_order_request (LimitOrderRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Номер счета (по умолчанию - Тинькофф)

Returns:

  • (Array<(LimitOrderResponse, Integer, Hash)>) —

    LimitOrderResponse data, response status code and response headers



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 162

def orders_limit_order_post_with_http_info(figi, limit_order_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.orders_limit_order_post ...'
  end
  # verify the required parameter 'figi' is set
  if @api_client.config.client_side_validation && figi.nil?
    fail ArgumentError, "Missing the required parameter 'figi' when calling OrdersApi.orders_limit_order_post"
  end
  # verify the required parameter 'limit_order_request' is set
  if @api_client.config.client_side_validation && limit_order_request.nil?
    fail ArgumentError, "Missing the required parameter 'limit_order_request' when calling OrdersApi.orders_limit_order_post"
  end
  # resource path
  local_var_path = '/orders/limit-order'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'figi'] = figi
  query_params[:'brokerAccountId'] = opts[:'broker_account_id'] if !opts[:'broker_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(limit_order_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LimitOrderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sso_auth']

  new_options = opts.merge(
    :operation => :"OrdersApi.orders_limit_order_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrdersApi#orders_limit_order_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orders_market_order_post(figi, market_order_request, opts = {}) ⇒ MarketOrderResponse

Создание рыночной заявки

Parameters:

  • figi (String) —

    FIGI инструмента

  • market_order_request (MarketOrderRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Уникальный идентификатор счета (по умолчанию - Тинькофф)

Returns:



224
225
226
227
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 224

def orders_market_order_post(figi, market_order_request, opts = {})
  data, _status_code, _headers = orders_market_order_post_with_http_info(figi, market_order_request, opts)
  data
end

#orders_market_order_post_with_http_info(figi, market_order_request, opts = {}) ⇒ Array<(MarketOrderResponse, Integer, Hash)>

Создание рыночной заявки

Parameters:

  • figi (String) —

    FIGI инструмента

  • market_order_request (MarketOrderRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

    Уникальный идентификатор счета (по умолчанию - Тинькофф)

Returns:

  • (Array<(MarketOrderResponse, Integer, Hash)>) —

    MarketOrderResponse data, response status code and response headers



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/tinkoff_invest_client/api/orders_api.rb', line 235

def orders_market_order_post_with_http_info(figi, market_order_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.orders_market_order_post ...'
  end
  # verify the required parameter 'figi' is set
  if @api_client.config.client_side_validation && figi.nil?
    fail ArgumentError, "Missing the required parameter 'figi' when calling OrdersApi.orders_market_order_post"
  end
  # verify the required parameter 'market_order_request' is set
  if @api_client.config.client_side_validation && market_order_request.nil?
    fail ArgumentError, "Missing the required parameter 'market_order_request' when calling OrdersApi.orders_market_order_post"
  end
  # resource path
  local_var_path = '/orders/market-order'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'figi'] = figi
  query_params[:'brokerAccountId'] = opts[:'broker_account_id'] if !opts[:'broker_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(market_order_request)

  # return_type
  return_type = opts[:debug_return_type] || 'MarketOrderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['sso_auth']

  new_options = opts.merge(
    :operation => :"OrdersApi.orders_market_order_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrdersApi#orders_market_order_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end