esi-client-bvv 1.0.0

data/docs/OpportunitiesApi.md

@@ -0,0 +1,291 @@
+# ESI::OpportunitiesApi
+
+All URIs are relative to *https://esi.tech.ccp.is*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_characters_character_id_opportunities**](OpportunitiesApi.md#get_characters_character_id_opportunities) | **GET** /v1/characters/{character_id}/opportunities/ | Get a character's completed tasks
+[**get_opportunities_groups**](OpportunitiesApi.md#get_opportunities_groups) | **GET** /v1/opportunities/groups/ | Get opportunities groups
+[**get_opportunities_groups_group_id**](OpportunitiesApi.md#get_opportunities_groups_group_id) | **GET** /v1/opportunities/groups/{group_id}/ | Get opportunities group
+[**get_opportunities_tasks**](OpportunitiesApi.md#get_opportunities_tasks) | **GET** /v1/opportunities/tasks/ | Get opportunities tasks
+[**get_opportunities_tasks_task_id**](OpportunitiesApi.md#get_opportunities_tasks_task_id) | **GET** /v1/opportunities/tasks/{task_id}/ | Get opportunities task
+
+
+# **get_characters_character_id_opportunities**
+> Array<GetCharactersCharacterIdOpportunities200Ok> get_characters_character_id_opportunities(character_id, opts)
+
+Get a character's completed tasks
+
+Return a list of tasks finished by a character  ---  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::OpportunitiesApi.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
+  #Get a character's completed tasks
+  result = api_instance.get_characters_character_id_opportunities(character_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling OpportunitiesApi->get_characters_character_id_opportunities: #{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<GetCharactersCharacterIdOpportunities200Ok>**](GetCharactersCharacterIdOpportunities200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_opportunities_groups**
+> Array<Integer> get_opportunities_groups(opts)
+
+Get opportunities groups
+
+Return a list of opportunities groups  ---  This route expires daily at 11:05
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::OpportunitiesApi.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 opportunities groups
+  result = api_instance.get_opportunities_groups(opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling OpportunitiesApi->get_opportunities_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_opportunities_groups_group_id**
+> GetOpportunitiesGroupsGroupIdOk get_opportunities_groups_group_id(group_id, opts)
+
+Get opportunities group
+
+Return information of an opportunities group  ---  This route expires daily at 11:05
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::OpportunitiesApi.new
+
+group_id = 56 # Integer | ID of an opportunities group
+
+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 opportunities group
+  result = api_instance.get_opportunities_groups_group_id(group_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling OpportunitiesApi->get_opportunities_groups_group_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **Integer**| ID of an opportunities group | 
+ **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
+
+[**GetOpportunitiesGroupsGroupIdOk**](GetOpportunitiesGroupsGroupIdOk.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_opportunities_tasks**
+> Array<Integer> get_opportunities_tasks(opts)
+
+Get opportunities tasks
+
+Return a list of opportunities tasks  ---  This route expires daily at 11:05
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::OpportunitiesApi.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 opportunities tasks
+  result = api_instance.get_opportunities_tasks(opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling OpportunitiesApi->get_opportunities_tasks: #{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_opportunities_tasks_task_id**
+> GetOpportunitiesTasksTaskIdOk get_opportunities_tasks_task_id(task_id, opts)
+
+Get opportunities task
+
+Return information of an opportunities task  ---  This route expires daily at 11:05
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::OpportunitiesApi.new
+
+task_id = 56 # Integer | ID of an opportunities task
+
+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 opportunities task
+  result = api_instance.get_opportunities_tasks_task_id(task_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling OpportunitiesApi->get_opportunities_tasks_task_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **Integer**| ID of an opportunities task | 
+ **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
+
+[**GetOpportunitiesTasksTaskIdOk**](GetOpportunitiesTasksTaskIdOk.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/PlanetaryInteractionApi.md

@@ -0,0 +1,258 @@
+# ESI::PlanetaryInteractionApi
+
+All URIs are relative to *https://esi.tech.ccp.is*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_characters_character_id_planets**](PlanetaryInteractionApi.md#get_characters_character_id_planets) | **GET** /v1/characters/{character_id}/planets/ | Get colonies
+[**get_characters_character_id_planets_planet_id**](PlanetaryInteractionApi.md#get_characters_character_id_planets_planet_id) | **GET** /v3/characters/{character_id}/planets/{planet_id}/ | Get colony layout
+[**get_corporations_corporation_id_customs_offices**](PlanetaryInteractionApi.md#get_corporations_corporation_id_customs_offices) | **GET** /v1/corporations/{corporation_id}/customs_offices/ | List corporation customs offices
+[**get_universe_schematics_schematic_id**](PlanetaryInteractionApi.md#get_universe_schematics_schematic_id) | **GET** /v1/universe/schematics/{schematic_id}/ | Get schematic information
+
+
+# **get_characters_character_id_planets**
+> Array<GetCharactersCharacterIdPlanets200Ok> get_characters_character_id_planets(character_id, opts)
+
+Get colonies
+
+Returns a list of all planetary colonies owned by a character.  ---  This route is cached for up to 600 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::PlanetaryInteractionApi.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
+  #Get colonies
+  result = api_instance.get_characters_character_id_planets(character_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling PlanetaryInteractionApi->get_characters_character_id_planets: #{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<GetCharactersCharacterIdPlanets200Ok>**](GetCharactersCharacterIdPlanets200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_characters_character_id_planets_planet_id**
+> GetCharactersCharacterIdPlanetsPlanetIdOk get_characters_character_id_planets_planet_id(character_idplanet_id, opts)
+
+Get colony layout
+
+Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.  ---  This route is cached for up to 600 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::PlanetaryInteractionApi.new
+
+character_id = 56 # Integer | An EVE character ID
+
+planet_id = 56 # Integer | Planet id of the target planet
+
+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
+  #Get colony layout
+  result = api_instance.get_characters_character_id_planets_planet_id(character_idplanet_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling PlanetaryInteractionApi->get_characters_character_id_planets_planet_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **character_id** | **Integer**| An EVE character ID | 
+ **planet_id** | **Integer**| Planet id of the target planet | 
+ **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
+
+[**GetCharactersCharacterIdPlanetsPlanetIdOk**](GetCharactersCharacterIdPlanetsPlanetIdOk.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_corporations_corporation_id_customs_offices**
+> Array<GetCorporationsCorporationIdCustomsOffices200Ok> get_corporations_corporation_id_customs_offices(corporation_id, , opts)
+
+List corporation customs offices
+
+List customs offices owned by a corporation  ---  This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Director
+
+### 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::PlanetaryInteractionApi.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 corporation customs offices
+  result = api_instance.get_corporations_corporation_id_customs_offices(corporation_id, , opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling PlanetaryInteractionApi->get_corporations_corporation_id_customs_offices: #{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<GetCorporationsCorporationIdCustomsOffices200Ok>**](GetCorporationsCorporationIdCustomsOffices200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_universe_schematics_schematic_id**
+> GetUniverseSchematicsSchematicIdOk get_universe_schematics_schematic_id(schematic_id, opts)
+
+Get schematic information
+
+Get information on a planetary factory schematic  ---  This route is cached for up to 3600 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi-client-bvv'
+
+api_instance = ESI::PlanetaryInteractionApi.new
+
+schematic_id = 56 # Integer | A PI schematic ID
+
+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 schematic information
+  result = api_instance.get_universe_schematics_schematic_id(schematic_id, opts)
+  p result
+rescue ESI::ApiError => e
+  puts "Exception when calling PlanetaryInteractionApi->get_universe_schematics_schematic_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **schematic_id** | **Integer**| A PI schematic ID | 
+ **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
+
+[**GetUniverseSchematicsSchematicIdOk**](GetUniverseSchematicsSchematicIdOk.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+