docs/CharacterApi.md in esi_client-1.3.0 vs docs/CharacterApi.md in esi_client-1.4.0

- old
+ new

@@ -12,15 +12,17 @@ [**get_characters_character_id_fatigue**](CharacterApi.md#get_characters_character_id_fatigue) | **GET** /v1/characters/{character_id}/fatigue/ | Get jump fatigue [**get_characters_character_id_medals**](CharacterApi.md#get_characters_character_id_medals) | **GET** /v1/characters/{character_id}/medals/ | Get medals [**get_characters_character_id_notifications**](CharacterApi.md#get_characters_character_id_notifications) | **GET** /v1/characters/{character_id}/notifications/ | Get character notifications [**get_characters_character_id_notifications_contacts**](CharacterApi.md#get_characters_character_id_notifications_contacts) | **GET** /v1/characters/{character_id}/notifications/contacts/ | Get new contact notifications [**get_characters_character_id_portrait**](CharacterApi.md#get_characters_character_id_portrait) | **GET** /v2/characters/{character_id}/portrait/ | Get character portraits -[**get_characters_character_id_roles**](CharacterApi.md#get_characters_character_id_roles) | **GET** /v1/characters/{character_id}/roles/ | Get character corporation roles +[**get_characters_character_id_roles**](CharacterApi.md#get_characters_character_id_roles) | **GET** /v2/characters/{character_id}/roles/ | Get character corporation roles [**get_characters_character_id_standings**](CharacterApi.md#get_characters_character_id_standings) | **GET** /v1/characters/{character_id}/standings/ | Get standings +[**get_characters_character_id_stats**](CharacterApi.md#get_characters_character_id_stats) | **GET** /v2/characters/{character_id}/stats/ | Yearly aggregate stats +[**get_characters_character_id_titles**](CharacterApi.md#get_characters_character_id_titles) | **GET** /v1/characters/{character_id}/titles/ | Get character corporation titles [**get_characters_names**](CharacterApi.md#get_characters_names) | **GET** /v1/characters/names/ | Get character names [**post_characters_affiliation**](CharacterApi.md#post_characters_affiliation) | **POST** /v1/characters/affiliation/ | Character affiliation -[**post_characters_character_id_cspa**](CharacterApi.md#post_characters_character_id_cspa) | **POST** /v3/characters/{character_id}/cspa/ | Calculate a CSPA charge cost +[**post_characters_character_id_cspa**](CharacterApi.md#post_characters_character_id_cspa) | **POST** /v4/characters/{character_id}/cspa/ | Calculate a CSPA charge cost # **get_characters_character_id** > GetCharactersCharacterIdOk get_characters_character_id(character_id, opts) @@ -36,13 +38,13 @@ api_instance = ESIClient::CharacterApi.new character_id = 56 # Integer | An EVE character 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 + 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 character's public information result = api_instance.get_characters_character_id(character_id, opts) @@ -96,14 +98,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 agents research result = api_instance.get_characters_character_id_agents_research(character_id, opts) @@ -158,15 +160,15 @@ api_instance = ESIClient::CharacterApi.new character_id = 56 # Integer | An EVE character ID opts = { - datasource: "tranquility", # String | The server name you would like data from + 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 + 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 blueprints result = api_instance.get_characters_character_id_blueprints(character_id, opts) @@ -222,14 +224,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 chat channels result = api_instance.get_characters_character_id_chat_channels(character_id, opts) @@ -279,13 +281,13 @@ api_instance = ESIClient::CharacterApi.new character_id = 56 # Integer | An EVE character 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 + 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 corporation history result = api_instance.get_characters_character_id_corporationhistory(character_id, opts) @@ -339,14 +341,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 jump fatigue result = api_instance.get_characters_character_id_fatigue(character_id, opts) @@ -401,14 +403,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 medals result = api_instance.get_characters_character_id_medals(character_id, opts) @@ -446,11 +448,11 @@ # **get_characters_character_id_notifications** > Array&lt;GetCharactersCharacterIdNotifications200Ok&gt; get_characters_character_id_notifications(character_id, opts) Get character notifications -Return character notifications --- This route is cached for up to 600 seconds +Return character notifications --- This route is cached for up to 600 seconds --- [This route has an available update](https://esi.tech.ccp.is/diff/latest/dev/#GET-/characters/{character_id}/notifications/) ### Example ```ruby # load the gem require 'esi_client' @@ -463,14 +465,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 character notifications result = api_instance.get_characters_character_id_notifications(character_id, opts) @@ -525,14 +527,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 new contact notifications result = api_instance.get_characters_character_id_notifications_contacts(character_id, opts) @@ -582,13 +584,13 @@ api_instance = ESIClient::CharacterApi.new character_id = 56 # Integer | An EVE character 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 + 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 character portraits result = api_instance.get_characters_character_id_portrait(character_id, opts) @@ -621,11 +623,11 @@ - **Accept**: application/json # **get_characters_character_id_roles** -> Array&lt;String&gt; get_characters_character_id_roles(character_id, opts) +> GetCharactersCharacterIdRolesOk get_characters_character_id_roles(character_id, opts) Get character corporation roles Returns a character's corporation roles --- This route is cached for up to 3600 seconds @@ -642,14 +644,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 character corporation roles result = api_instance.get_characters_character_id_roles(character_id, opts) @@ -669,11 +671,11 @@ **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&lt;String&gt;** +[**GetCharactersCharacterIdRolesOk**](GetCharactersCharacterIdRolesOk.md) ### Authorization [evesso](../README.md#evesso) @@ -704,14 +706,14 @@ api_instance = ESIClient::CharacterApi.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 + 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 standings result = api_instance.get_characters_character_id_standings(character_id, opts) @@ -744,10 +746,134 @@ - **Content-Type**: Not defined - **Accept**: application/json +# **get_characters_character_id_stats** +> Array&lt;GetCharactersCharacterIdStats200Ok&gt; get_characters_character_id_stats(character_id, opts) + +Yearly aggregate stats + +Returns aggregate yearly stats for a character --- This route is cached for up to 86400 seconds + +### Example +```ruby +# load the gem +require 'esi_client' +# setup authorization +ESIClient.configure do |config| + # Configure OAuth2 access token for authorization: evesso + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = ESIClient::CharacterApi.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 + #Yearly aggregate stats + result = api_instance.get_characters_character_id_stats(character_id, opts) + p result +rescue ESIClient::ApiError => e + puts "Exception when calling CharacterApi->get_characters_character_id_stats: #{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&lt;GetCharactersCharacterIdStats200Ok&gt;**](GetCharactersCharacterIdStats200Ok.md) + +### Authorization + +[evesso](../README.md#evesso) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + + +# **get_characters_character_id_titles** +> Array&lt;GetCharactersCharacterIdTitles200Ok&gt; get_characters_character_id_titles(character_id, opts) + +Get character corporation titles + +Returns a character's titles --- This route is cached for up to 3600 seconds + +### Example +```ruby +# load the gem +require 'esi_client' +# setup authorization +ESIClient.configure do |config| + # Configure OAuth2 access token for authorization: evesso + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = ESIClient::CharacterApi.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 character corporation titles + result = api_instance.get_characters_character_id_titles(character_id, opts) + p result +rescue ESIClient::ApiError => e + puts "Exception when calling CharacterApi->get_characters_character_id_titles: #{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&lt;GetCharactersCharacterIdTitles200Ok&gt;**](GetCharactersCharacterIdTitles200Ok.md) + +### Authorization + +[evesso](../README.md#evesso) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + + # **get_characters_names** > Array&lt;GetCharactersNames200Ok&gt; get_characters_names(character_ids, opts) Get character names @@ -761,13 +887,13 @@ api_instance = ESIClient::CharacterApi.new character_ids = [56] # Array<Integer> | A comma separated list of character IDs 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 + 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 character names result = api_instance.get_characters_names(character_ids, opts) @@ -816,13 +942,13 @@ api_instance = ESIClient::CharacterApi.new characters = [ESIClient::Array<Integer>.new] # Array<Integer> | The character IDs to fetch affiliations for. All characters must exist, or none will be returned. 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 + 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 #Character affiliation result = api_instance.post_characters_affiliation(characters, opts) @@ -855,11 +981,11 @@ - **Accept**: application/json # **post_characters_character_id_cspa** -> PostCharactersCharacterIdCspaCreated post_characters_character_id_cspa(character_idcharacters, opts) +> Float post_characters_character_id_cspa(character_idcharacters, opts) Calculate a CSPA charge cost Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost --- @@ -875,17 +1001,17 @@ api_instance = ESIClient::CharacterApi.new character_id = 56 # Integer | An EVE character ID -characters = ESIClient::PostCharactersCharacterIdCspaCharacters.new # PostCharactersCharacterIdCspaCharacters | The target characters to calculate the charge for +characters = [ESIClient::Array<Integer>.new] # Array<Integer> | The target characters to calculate the charge for 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 + 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 #Calculate a CSPA charge cost result = api_instance.post_characters_character_id_cspa(character_idcharacters, opts) @@ -898,18 +1024,18 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **character_id** | **Integer**| An EVE character ID | - **characters** | [**PostCharactersCharacterIdCspaCharacters**](PostCharactersCharacterIdCspaCharacters.md)| The target characters to calculate the charge for | + **characters** | **Array&lt;Integer&gt;**| The target characters to calculate the charge for | **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 -[**PostCharactersCharacterIdCspaCreated**](PostCharactersCharacterIdCspaCreated.md) +**Float** ### Authorization [evesso](../README.md#evesso)