Class: TinkoffInvestClient::SandboxApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SandboxApi

Returns a new instance of SandboxApi.



19
20
21
 
# File 'lib/tinkoff_invest_client/api/sandbox_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/sandbox_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#sandbox_clear_post(opts = {}) ⇒ Empty

Удаление всех позиций Удаление всех позиций клиента

Parameters:

  • 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/sandbox_api.rb', line 27

def sandbox_clear_post(opts = {})
  data, _status_code, _headers = sandbox_clear_post_with_http_info(opts)
  data
end

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

Удаление всех позиций Удаление всех позиций клиента

Parameters:

  • 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
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 37

def sandbox_clear_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.sandbox_clear_post ...'
  end
  # resource path
  local_var_path = '/sandbox/clear'

  # 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] || 'Empty'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.sandbox_clear_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: SandboxApi#sandbox_clear_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_currencies_balance_post(sandbox_set_currency_balance_request, opts = {}) ⇒ Empty

Выставление баланса по валютным позициям

Parameters:

  • sandbox_set_currency_balance_request (SandboxSetCurrencyBalanceRequest) —

    Запрос на выставление баланса по валютным позициям

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

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

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

Returns:



87
88
89
90
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 87

def sandbox_currencies_balance_post(sandbox_set_currency_balance_request, opts = {})
  data, _status_code, _headers = sandbox_currencies_balance_post_with_http_info(sandbox_set_currency_balance_request, opts)
  data
end

#sandbox_currencies_balance_post_with_http_info(sandbox_set_currency_balance_request, opts = {}) ⇒ Array<(Empty, Integer, Hash)>

Выставление баланса по валютным позициям

Parameters:

  • sandbox_set_currency_balance_request (SandboxSetCurrencyBalanceRequest) —

    Запрос на выставление баланса по валютным позициям

  • 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



97
98
99
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
144
145
146
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 97

def sandbox_currencies_balance_post_with_http_info(sandbox_set_currency_balance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.sandbox_currencies_balance_post ...'
  end
  # verify the required parameter 'sandbox_set_currency_balance_request' is set
  if @api_client.config.client_side_validation && sandbox_set_currency_balance_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_set_currency_balance_request' when calling SandboxApi.sandbox_currencies_balance_post"
  end
  # resource path
  local_var_path = '/sandbox/currencies/balance'

  # 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'])
  # 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(sandbox_set_currency_balance_request)

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

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

  new_options = opts.merge(
    :operation => :"SandboxApi.sandbox_currencies_balance_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: SandboxApi#sandbox_currencies_balance_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_positions_balance_post(sandbox_set_position_balance_request, opts = {}) ⇒ Empty

Выставление баланса по инструментным позициям

Parameters:

  • sandbox_set_position_balance_request (SandboxSetPositionBalanceRequest) —

    Запрос на выставление баланса по инструментным позициям

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

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

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

Returns:



153
154
155
156
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 153

def sandbox_positions_balance_post(sandbox_set_position_balance_request, opts = {})
  data, _status_code, _headers = sandbox_positions_balance_post_with_http_info(sandbox_set_position_balance_request, opts)
  data
end

#sandbox_positions_balance_post_with_http_info(sandbox_set_position_balance_request, opts = {}) ⇒ Array<(Empty, Integer, Hash)>

Выставление баланса по инструментным позициям

Parameters:

  • sandbox_set_position_balance_request (SandboxSetPositionBalanceRequest) —

    Запрос на выставление баланса по инструментным позициям

  • 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



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
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 163

def sandbox_positions_balance_post_with_http_info(sandbox_set_position_balance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.sandbox_positions_balance_post ...'
  end
  # verify the required parameter 'sandbox_set_position_balance_request' is set
  if @api_client.config.client_side_validation && sandbox_set_position_balance_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_set_position_balance_request' when calling SandboxApi.sandbox_positions_balance_post"
  end
  # resource path
  local_var_path = '/sandbox/positions/balance'

  # 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'])
  # 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(sandbox_set_position_balance_request)

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

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

  new_options = opts.merge(
    :operation => :"SandboxApi.sandbox_positions_balance_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: SandboxApi#sandbox_positions_balance_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_register_post(opts = {}) ⇒ SandboxRegisterResponse

Регистрация клиента в sandbox Создание счета и валютных позиций для клиента

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sandbox_register_request (SandboxRegisterRequest) —

    Запрос на создание счета и выставление баланса по валютным позициям

Returns:



219
220
221
222
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 219

def sandbox_register_post(opts = {})
  data, _status_code, _headers = sandbox_register_post_with_http_info(opts)
  data
end

#sandbox_register_post_with_http_info(opts = {}) ⇒ Array<(SandboxRegisterResponse, Integer, Hash)>

Регистрация клиента в sandbox Создание счета и валютных позиций для клиента

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sandbox_register_request (SandboxRegisterRequest) —

    Запрос на создание счета и выставление баланса по валютным позициям

Returns:

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

    SandboxRegisterResponse data, response status code and response headers



229
230
231
232
233
234
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
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 229

def sandbox_register_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.sandbox_register_post ...'
  end
  # resource path
  local_var_path = '/sandbox/register'

  # query parameters
  query_params = opts[:query_params] || {}

  # 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(opts[:'sandbox_register_request'])

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

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

  new_options = opts.merge(
    :operation => :"SandboxApi.sandbox_register_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: SandboxApi#sandbox_register_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_remove_post(opts = {}) ⇒ Empty

Удаление счета Удаление счета клиента

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :broker_account_id (String) —

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

Returns:



280
281
282
283
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 280

def sandbox_remove_post(opts = {})
  data, _status_code, _headers = sandbox_remove_post_with_http_info(opts)
  data
end

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

Удаление счета Удаление счета клиента

Parameters:

  • 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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/tinkoff_invest_client/api/sandbox_api.rb', line 290

def sandbox_remove_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.sandbox_remove_post ...'
  end
  # resource path
  local_var_path = '/sandbox/remove'

  # 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] || 'Empty'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.sandbox_remove_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: SandboxApi#sandbox_remove_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end