esi-client-bvv 1.0.0

data/docs/MarketApi.md

@@ -0,0 +1,675 @@
+# ESI::MarketApi
+
+All URIs are relative to *https://esi.tech.ccp.is*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_characters_character_id_orders**](MarketApi.md#get_characters_character_id_orders) | **GET** /v2/characters/{character_id}/orders/ | List open orders from a character
+[**get_characters_character_id_orders_history**](MarketApi.md#get_characters_character_id_orders_history) | **GET** /v1/characters/{character_id}/orders/history/ | List historical orders by a character
+[**get_corporations_corporation_id_orders**](MarketApi.md#get_corporations_corporation_id_orders) | **GET** /v2/corporations/{corporation_id}/orders/ | List open orders from a corporation
+[**get_corporations_corporation_id_orders_history**](MarketApi.md#get_corporations_corporation_id_orders_history) | **GET** /v1/corporations/{corporation_id}/orders/history/ | List historical orders from a corporation
+[**get_markets_groups**](MarketApi.md#get_markets_groups) | **GET** /v1/markets/groups/ | Get item groups
+[**get_markets_groups_market_group_id**](MarketApi.md#get_markets_groups_market_group_id) | **GET** /v1/markets/groups/{market_group_id}/ | Get item group information
+[**get_markets_prices**](MarketApi.md#get_markets_prices) | **GET** /v1/markets/prices/ | List market prices
+[**get_markets_region_id_history**](MarketApi.md#get_markets_region_id_history) | **GET** /v1/markets/{region_id}/history/ | List historical market statistics in a region
+[**get_markets_region_id_orders**](MarketApi.md#get_markets_region_id_orders) | **GET** /v1/markets/{region_id}/orders/ | List orders in a region
+[**get_markets_region_id_types**](MarketApi.md#get_markets_region_id_types) | **GET** /v1/markets/{region_id}/types/ | List type IDs relevant to a market
+[**get_markets_structures_structure_id**](MarketApi.md#get_markets_structures_structure_id) | **GET** /v1/markets/structures/{structure_id}/ | List orders in a structure
+
+
+# **get_characters_character_id_orders**
+> Array<GetCharactersCharacterIdOrders200Ok> get_characters_character_id_orders(character_id, opts)
+
+List open orders from a character
+
+List open market orders placed by a character  ---  This route is cached for up to 1200 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+# setup authorization
+ESI.configure do |config|
+  # Configure OAuth2 access token for authorization: evesso
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ESI::MarketApi.new
+
+character_id = 56 # Integer | An EVE character ID
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  token: "token_example", # String | Access token to use if unable to set a header
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List open orders from a character
+  result = api_instance.get_characters_character_id_orders(character_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_characters_character_id_orders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **character_id** | **Integer**| An EVE character ID | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **token** | **String**| Access token to use if unable to set a header | [optional] 
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetCharactersCharacterIdOrders200Ok>**](GetCharactersCharacterIdOrders200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_characters_character_id_orders_history**
+> Array<GetCharactersCharacterIdOrdersHistory200Ok> get_characters_character_id_orders_history(character_id, opts)
+
+List historical orders by a character
+
+List cancelled and expired market orders placed by a character up to 90 days in the past.  ---  This route is cached for up to 3600 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+# setup authorization
+ESI.configure do |config|
+  # Configure OAuth2 access token for authorization: evesso
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ESI::MarketApi.new
+
+character_id = 56 # Integer | An EVE character ID
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  page: 1, # Integer | Which page of results to return
+  token: "token_example", # String | Access token to use if unable to set a header
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List historical orders by a character
+  result = api_instance.get_characters_character_id_orders_history(character_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_characters_character_id_orders_history: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **character_id** | **Integer**| An EVE character ID | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **page** | **Integer**| Which page of results to return | [optional] [default to 1]
+ **token** | **String**| Access token to use if unable to set a header | [optional] 
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetCharactersCharacterIdOrdersHistory200Ok>**](GetCharactersCharacterIdOrdersHistory200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_corporations_corporation_id_orders**
+> Array<GetCorporationsCorporationIdOrders200Ok> get_corporations_corporation_id_orders(corporation_id, , opts)
+
+List open orders from a corporation
+
+List open market orders placed on behalf of a corporation  ---  This route is cached for up to 1200 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+# setup authorization
+ESI.configure do |config|
+  # Configure OAuth2 access token for authorization: evesso
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ESI::MarketApi.new
+
+corporation_id = 56 # Integer | An EVE corporation ID
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  page: 1, # Integer | Which page of results to return
+  token: "token_example", # String | Access token to use if unable to set a header
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List open orders from a corporation
+  result = api_instance.get_corporations_corporation_id_orders(corporation_id, , opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_corporations_corporation_id_orders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **corporation_id** | **Integer**| An EVE corporation ID | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **page** | **Integer**| Which page of results to return | [optional] [default to 1]
+ **token** | **String**| Access token to use if unable to set a header | [optional] 
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetCorporationsCorporationIdOrders200Ok>**](GetCorporationsCorporationIdOrders200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_corporations_corporation_id_orders_history**
+> Array<GetCorporationsCorporationIdOrdersHistory200Ok> get_corporations_corporation_id_orders_history(corporation_id, , opts)
+
+List historical orders from a corporation
+
+List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.  ---  This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+# setup authorization
+ESI.configure do |config|
+  # Configure OAuth2 access token for authorization: evesso
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ESI::MarketApi.new
+
+corporation_id = 56 # Integer | An EVE corporation ID
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  page: 1, # Integer | Which page of results to return
+  token: "token_example", # String | Access token to use if unable to set a header
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List historical orders from a corporation
+  result = api_instance.get_corporations_corporation_id_orders_history(corporation_id, , opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_corporations_corporation_id_orders_history: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **corporation_id** | **Integer**| An EVE corporation ID | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **page** | **Integer**| Which page of results to return | [optional] [default to 1]
+ **token** | **String**| Access token to use if unable to set a header | [optional] 
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetCorporationsCorporationIdOrdersHistory200Ok>**](GetCorporationsCorporationIdOrdersHistory200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_markets_groups**
+> Array<Integer> get_markets_groups(opts)
+
+Get item groups
+
+Get a list of item groups  ---  This route expires daily at 11:05
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::MarketApi.new
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #Get item groups
+  result = api_instance.get_markets_groups(opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_markets_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+**Array<Integer>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_markets_groups_market_group_id**
+> GetMarketsGroupsMarketGroupIdOk get_markets_groups_market_group_id(market_group_id, opts)
+
+Get item group information
+
+Get information on an item group  ---  This route expires daily at 11:05
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::MarketApi.new
+
+market_group_id = 56 # Integer | An Eve item group ID
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  language: "en-us", # String | Language to use in the response
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #Get item group information
+  result = api_instance.get_markets_groups_market_group_id(market_group_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_markets_groups_market_group_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **market_group_id** | **Integer**| An Eve item group ID | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **language** | **String**| Language to use in the response | [optional] [default to en-us]
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**GetMarketsGroupsMarketGroupIdOk**](GetMarketsGroupsMarketGroupIdOk.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_markets_prices**
+> Array<GetMarketsPrices200Ok> get_markets_prices(opts)
+
+List market prices
+
+Return a list of prices  ---  This route is cached for up to 3600 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::MarketApi.new
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List market prices
+  result = api_instance.get_markets_prices(opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_markets_prices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetMarketsPrices200Ok>**](GetMarketsPrices200Ok.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_markets_region_id_history**
+> Array<GetMarketsRegionIdHistory200Ok> get_markets_region_id_history(region_id, type_id, opts)
+
+List historical market statistics in a region
+
+Return a list of historical market statistics for the specified type in a region  ---  This route is cached for up to 3600 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::MarketApi.new
+
+region_id = 56 # Integer | Return statistics in this region
+
+type_id = 56 # Integer | Return statistics for this type
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List historical market statistics in a region
+  result = api_instance.get_markets_region_id_history(region_id, type_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_markets_region_id_history: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **region_id** | **Integer**| Return statistics in this region | 
+ **type_id** | **Integer**| Return statistics for this type | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetMarketsRegionIdHistory200Ok>**](GetMarketsRegionIdHistory200Ok.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_markets_region_id_orders**
+> Array<GetMarketsRegionIdOrders200Ok> get_markets_region_id_orders(order_type, region_id, opts)
+
+List orders in a region
+
+Return a list of orders in a region  ---  This route is cached for up to 300 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::MarketApi.new
+
+order_type = "all" # String | Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders.
+
+region_id = 56 # Integer | Return orders in this region
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  page: 1, # Integer | Which page of results to return
+  type_id: 56, # Integer | Return orders only for this type
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List orders in a region
+  result = api_instance.get_markets_region_id_orders(order_type, region_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_markets_region_id_orders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_type** | **String**| Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders. | [default to all]
+ **region_id** | **Integer**| Return orders in this region | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **page** | **Integer**| Which page of results to return | [optional] [default to 1]
+ **type_id** | **Integer**| Return orders only for this type | [optional] 
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetMarketsRegionIdOrders200Ok>**](GetMarketsRegionIdOrders200Ok.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_markets_region_id_types**
+> Array<Integer> get_markets_region_id_types(region_id, opts)
+
+List type IDs relevant to a market
+
+Return a list of type IDs that have active orders in the region, for efficient market indexing.  ---  This route is cached for up to 600 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::MarketApi.new
+
+region_id = 56 # Integer | Return statistics in this region
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  page: 1, # Integer | Which page of results to return
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List type IDs relevant to a market
+  result = api_instance.get_markets_region_id_types(region_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_markets_region_id_types: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **region_id** | **Integer**| Return statistics in this region | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **page** | **Integer**| Which page of results to return | [optional] [default to 1]
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+**Array<Integer>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_markets_structures_structure_id**
+> Array<GetMarketsStructuresStructureId200Ok> get_markets_structures_structure_id(structure_id, opts)
+
+List orders in a structure
+
+Return all orders in a structure  ---  This route is cached for up to 300 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+# setup authorization
+ESI.configure do |config|
+  # Configure OAuth2 access token for authorization: evesso
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ESI::MarketApi.new
+
+structure_id = 789 # Integer | Return orders in this structure
+
+opts = { 
+  datasource: "tranquility", # String | The server name you would like data from
+  page: 1, # Integer | Which page of results to return
+  token: "token_example", # String | Access token to use if unable to set a header
+  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
+  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
+}
+
+begin
+  #List orders in a structure
+  result = api_instance.get_markets_structures_structure_id(structure_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling MarketApi->get_markets_structures_structure_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **structure_id** | **Integer**| Return orders in this structure | 
+ **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
+ **page** | **Integer**| Which page of results to return | [optional] [default to 1]
+ **token** | **String**| Access token to use if unable to set a header | [optional] 
+ **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] 
+ **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] 
+
+### Return type
+
+[**Array<GetMarketsStructuresStructureId200Ok>**](GetMarketsStructuresStructureId200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+