tinkoff_invest_client 1.0.0

data/docs/OrderResponse.md

@@ -0,0 +1,20 @@
+# TinkoffInvestClient::OrderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price** | **Float** |  |  |
+| **quantity** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'tinkoff_invest_client'
+
+instance = TinkoffInvestClient::OrderResponse.new(
+  price: null,
+  quantity: null
+)
+```
+

data/docs/OrderStatus.md

@@ -0,0 +1,15 @@
+# TinkoffInvestClient::OrderStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'tinkoff_invest_client'
+
+instance = TinkoffInvestClient::OrderStatus.new()
+```
+

data/docs/OrderType.md

@@ -0,0 +1,15 @@
+# TinkoffInvestClient::OrderType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'tinkoff_invest_client'
+
+instance = TinkoffInvestClient::OrderType.new()
+```
+

data/docs/Orderbook.md

@@ -0,0 +1,38 @@
+# TinkoffInvestClient::Orderbook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **figi** | **String** |  |  |
+| **depth** | **Integer** |  |  |
+| **bids** | [**Array<OrderResponse>**](OrderResponse.md) |  |  |
+| **asks** | [**Array<OrderResponse>**](OrderResponse.md) |  |  |
+| **trade_status** | [**TradeStatus**](TradeStatus.md) |  |  |
+| **min_price_increment** | **Float** | Шаг цены |  |
+| **face_value** | **Float** | Номинал для облигаций | [optional] |
+| **last_price** | **Float** |  | [optional] |
+| **close_price** | **Float** |  | [optional] |
+| **limit_up** | **Float** | Верхняя граница цены | [optional] |
+| **limit_down** | **Float** | Нижняя граница цены | [optional] |
+
+## Example
+
+```ruby
+require 'tinkoff_invest_client'
+
+instance = TinkoffInvestClient::Orderbook.new(
+  figi: null,
+  depth: null,
+  bids: null,
+  asks: null,
+  trade_status: null,
+  min_price_increment: null,
+  face_value: null,
+  last_price: null,
+  close_price: null,
+  limit_up: null,
+  limit_down: null
+)
+```
+

data/docs/OrderbookResponse.md

@@ -0,0 +1,22 @@
+# TinkoffInvestClient::OrderbookResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracking_id** | **String** |  |  |
+| **status** | **String** |  | [default to 'Ok'] |
+| **payload** | [**Orderbook**](Orderbook.md) |  |  |
+
+## Example
+
+```ruby
+require 'tinkoff_invest_client'
+
+instance = TinkoffInvestClient::OrderbookResponse.new(
+  tracking_id: null,
+  status: null,
+  payload: null
+)
+```
+

data/docs/OrdersApi.md

@@ -0,0 +1,297 @@
+# TinkoffInvestClient::OrdersApi
+
+All URIs are relative to *https://api-invest.tinkoff.ru/openapi*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**orders_cancel_post**](OrdersApi.md#orders_cancel_post) | **POST** /orders/cancel | Отмена заявки |
+| [**orders_get**](OrdersApi.md#orders_get) | **GET** /orders | Получение списка активных заявок |
+| [**orders_limit_order_post**](OrdersApi.md#orders_limit_order_post) | **POST** /orders/limit-order | Создание лимитной заявки |
+| [**orders_market_order_post**](OrdersApi.md#orders_market_order_post) | **POST** /orders/market-order | Создание рыночной заявки |
+
+
+## orders_cancel_post
+
+> <Empty> orders_cancel_post(order_id, opts)
+
+Отмена заявки
+
+### Examples
+
+```ruby
+require 'time'
+require 'tinkoff_invest_client'
+# setup authorization
+TinkoffInvestClient.configure do |config|
+  # Configure Bearer authorization: sso_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TinkoffInvestClient::OrdersApi.new
+order_id = 'order_id_example' # String | ID заявки
+opts = {
+  broker_account_id: 'broker_account_id_example' # String | Номер счета (по умолчанию - Тинькофф)
+}
+
+begin
+  # Отмена заявки
+  result = api_instance.orders_cancel_post(order_id, opts)
+  p result
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_cancel_post: #{e}"
+end
+```
+
+#### Using the orders_cancel_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Empty>, Integer, Hash)> orders_cancel_post_with_http_info(order_id, opts)
+
+```ruby
+begin
+  # Отмена заявки
+  data, status_code, headers = api_instance.orders_cancel_post_with_http_info(order_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Empty>
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_cancel_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | ID заявки |  |
+| **broker_account_id** | **String** | Номер счета (по умолчанию - Тинькофф) | [optional] |
+
+### Return type
+
+[**Empty**](Empty.md)
+
+### Authorization
+
+[sso_auth](../README.md#sso_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## orders_get
+
+> <OrdersResponse> orders_get(opts)
+
+Получение списка активных заявок
+
+### Examples
+
+```ruby
+require 'time'
+require 'tinkoff_invest_client'
+# setup authorization
+TinkoffInvestClient.configure do |config|
+  # Configure Bearer authorization: sso_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TinkoffInvestClient::OrdersApi.new
+opts = {
+  broker_account_id: 'broker_account_id_example' # String | Номер счета (по умолчанию - Тинькофф)
+}
+
+begin
+  # Получение списка активных заявок
+  result = api_instance.orders_get(opts)
+  p result
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_get: #{e}"
+end
+```
+
+#### Using the orders_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrdersResponse>, Integer, Hash)> orders_get_with_http_info(opts)
+
+```ruby
+begin
+  # Получение списка активных заявок
+  data, status_code, headers = api_instance.orders_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrdersResponse>
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broker_account_id** | **String** | Номер счета (по умолчанию - Тинькофф) | [optional] |
+
+### Return type
+
+[**OrdersResponse**](OrdersResponse.md)
+
+### Authorization
+
+[sso_auth](../README.md#sso_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## orders_limit_order_post
+
+> <LimitOrderResponse> orders_limit_order_post(figi, limit_order_request, opts)
+
+Создание лимитной заявки
+
+### Examples
+
+```ruby
+require 'time'
+require 'tinkoff_invest_client'
+# setup authorization
+TinkoffInvestClient.configure do |config|
+  # Configure Bearer authorization: sso_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TinkoffInvestClient::OrdersApi.new
+figi = 'figi_example' # String | FIGI инструмента
+limit_order_request = TinkoffInvestClient::LimitOrderRequest.new({lots: 37, operation: TinkoffInvestClient::OperationType::BUY, price: 3.56}) # LimitOrderRequest | 
+opts = {
+  broker_account_id: 'broker_account_id_example' # String | Номер счета (по умолчанию - Тинькофф)
+}
+
+begin
+  # Создание лимитной заявки
+  result = api_instance.orders_limit_order_post(figi, limit_order_request, opts)
+  p result
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_limit_order_post: #{e}"
+end
+```
+
+#### Using the orders_limit_order_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LimitOrderResponse>, Integer, Hash)> orders_limit_order_post_with_http_info(figi, limit_order_request, opts)
+
+```ruby
+begin
+  # Создание лимитной заявки
+  data, status_code, headers = api_instance.orders_limit_order_post_with_http_info(figi, limit_order_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LimitOrderResponse>
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_limit_order_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **figi** | **String** | FIGI инструмента |  |
+| **limit_order_request** | [**LimitOrderRequest**](LimitOrderRequest.md) |  |  |
+| **broker_account_id** | **String** | Номер счета (по умолчанию - Тинькофф) | [optional] |
+
+### Return type
+
+[**LimitOrderResponse**](LimitOrderResponse.md)
+
+### Authorization
+
+[sso_auth](../README.md#sso_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## orders_market_order_post
+
+> <MarketOrderResponse> orders_market_order_post(figi, market_order_request, opts)
+
+Создание рыночной заявки
+
+### Examples
+
+```ruby
+require 'time'
+require 'tinkoff_invest_client'
+# setup authorization
+TinkoffInvestClient.configure do |config|
+  # Configure Bearer authorization: sso_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TinkoffInvestClient::OrdersApi.new
+figi = 'figi_example' # String | FIGI инструмента
+market_order_request = TinkoffInvestClient::MarketOrderRequest.new({lots: 37, operation: TinkoffInvestClient::OperationType::BUY}) # MarketOrderRequest | 
+opts = {
+  broker_account_id: 'broker_account_id_example' # String | Уникальный идентификатор счета (по умолчанию - Тинькофф)
+}
+
+begin
+  # Создание рыночной заявки
+  result = api_instance.orders_market_order_post(figi, market_order_request, opts)
+  p result
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_market_order_post: #{e}"
+end
+```
+
+#### Using the orders_market_order_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MarketOrderResponse>, Integer, Hash)> orders_market_order_post_with_http_info(figi, market_order_request, opts)
+
+```ruby
+begin
+  # Создание рыночной заявки
+  data, status_code, headers = api_instance.orders_market_order_post_with_http_info(figi, market_order_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MarketOrderResponse>
+rescue TinkoffInvestClient::ApiError => e
+  puts "Error when calling OrdersApi->orders_market_order_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **figi** | **String** | FIGI инструмента |  |
+| **market_order_request** | [**MarketOrderRequest**](MarketOrderRequest.md) |  |  |
+| **broker_account_id** | **String** | Уникальный идентификатор счета (по умолчанию - Тинькофф) | [optional] |
+
+### Return type
+
+[**MarketOrderResponse**](MarketOrderResponse.md)
+
+### Authorization
+
+[sso_auth](../README.md#sso_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OrdersResponse.md

@@ -0,0 +1,22 @@
+# TinkoffInvestClient::OrdersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracking_id** | **String** |  |  |
+| **status** | **String** |  | [default to 'Ok'] |
+| **payload** | [**Array<Order>**](Order.md) |  |  |
+
+## Example
+
+```ruby
+require 'tinkoff_invest_client'
+
+instance = TinkoffInvestClient::OrdersResponse.new(
+  tracking_id: null,
+  status: null,
+  payload: null
+)
+```
+

data/docs/PlacedLimitOrder.md

@@ -0,0 +1,32 @@
+# TinkoffInvestClient::PlacedLimitOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** |  |  |
+| **operation** | [**OperationType**](OperationType.md) |  |  |
+| **status** | [**OrderStatus**](OrderStatus.md) |  |  |
+| **reject_reason** | **String** |  | [optional] |
+| **message** | **String** | Сообщение об ошибке | [optional] |
+| **requested_lots** | **Integer** |  |  |
+| **executed_lots** | **Integer** |  |  |
+| **commission** | [**MoneyAmount**](MoneyAmount.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tinkoff_invest_client'
+
+instance = TinkoffInvestClient::PlacedLimitOrder.new(
+  order_id: null,
+  operation: null,
+  status: null,
+  reject_reason: null,
+  message: null,
+  requested_lots: null,
+  executed_lots: null,
+  commission: null
+)
+```
+