docs/CharacterApi.md in esi_client-0.8.5.0 vs docs/CharacterApi.md in esi_client-1.0.1

- old
+ new

@@ -1,26 +1,23 @@ # ESIClient::CharacterApi -All URIs are relative to *https://esi.evetech.net* +All URIs are relative to *https://esi.tech.ccp.is/* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_characters_character_id**](CharacterApi.md#get_characters_character_id) | **GET** /v4/characters/{character_id}/ | Get character&#39;s public information [**get_characters_character_id_agents_research**](CharacterApi.md#get_characters_character_id_agents_research) | **GET** /v1/characters/{character_id}/agents_research/ | Get agents research -[**get_characters_character_id_blueprints**](CharacterApi.md#get_characters_character_id_blueprints) | **GET** /v2/characters/{character_id}/blueprints/ | Get blueprints +[**get_characters_character_id_blueprints**](CharacterApi.md#get_characters_character_id_blueprints) | **GET** /v1/characters/{character_id}/blueprints/ | Get blueprints +[**get_characters_character_id_chat_channels**](CharacterApi.md#get_characters_character_id_chat_channels) | **GET** /v1/characters/{character_id}/chat_channels/ | Get chat channels [**get_characters_character_id_corporationhistory**](CharacterApi.md#get_characters_character_id_corporationhistory) | **GET** /v1/characters/{character_id}/corporationhistory/ | Get corporation history -[**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** /v2/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** /v2/characters/{character_id}/roles/ | Get character corporation roles +[**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_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** /v4/characters/{character_id}/cspa/ | Calculate a CSPA charge cost +[**post_characters_character_id_cspa**](CharacterApi.md#post_characters_character_id_cspa) | **POST** /v3/characters/{character_id}/cspa/ | Calculate a CSPA charge cost # **get_characters_character_id** > GetCharactersCharacterIdOk get_characters_character_id(character_id, opts) @@ -36,12 +33,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 - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag + 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) @@ -55,11 +53,12 @@ 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] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [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 [**GetCharactersCharacterIdOk**](GetCharactersCharacterIdOk.md) @@ -67,11 +66,11 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json # **get_characters_character_id_agents_research** @@ -91,16 +90,17 @@ config.access_token = 'YOUR ACCESS TOKEN' end api_instance = ESIClient::CharacterApi.new -character_id = 56 # Integer | An EVE character ID +character_id = 56 # Integer | ID for a character opts = { - datasource: 'tranquility', # String | The server name you would like data from - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header + datasource: "tranquility", # String | The server name you would like data from + token: "token_example", # String | Access token to use, if preferred over 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) @@ -112,14 +112,15 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **character_id** | **Integer**| An EVE character ID | + **character_id** | **Integer**| ID for a character | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **token** | **String**| Access token to use if unable to set a header | [optional] + **token** | **String**| Access token to use, if preferred over 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;GetCharactersCharacterIdAgentsResearch200Ok&gt;**](GetCharactersCharacterIdAgentsResearch200Ok.md) @@ -127,21 +128,21 @@ [evesso](../README.md#evesso) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json # **get_characters_character_id_blueprints** > Array&lt;GetCharactersCharacterIdBlueprints200Ok&gt; get_characters_character_id_blueprints(character_id, opts) Get blueprints -Return a list of blueprints the character owns --- This route is cached for up to 3600 seconds +Return a list of blueprints the character has --- This route is cached for up to 3600 seconds ### Example ```ruby # load the gem require 'esi_client' @@ -151,17 +152,17 @@ config.access_token = 'YOUR ACCESS TOKEN' end api_instance = ESIClient::CharacterApi.new -character_id = 56 # Integer | An EVE character ID +character_id = 56 # Integer | ID for a character opts = { - datasource: 'tranquility', # String | The server name you would like data from - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - page: 1, # Integer | Which page of results to return - token: 'token_example' # String | Access token to use if unable to set a header + datasource: "tranquility", # String | The server name you would like data from + token: "token_example", # String | Access token to use, if preferred over 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) @@ -173,15 +174,15 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **character_id** | **Integer**| An EVE character ID | + **character_id** | **Integer**| ID for a character | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **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] + **token** | **String**| Access token to use, if preferred over 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;GetCharactersCharacterIdBlueprints200Ok&gt;**](GetCharactersCharacterIdBlueprints200Ok.md) @@ -189,124 +190,128 @@ [evesso](../README.md#evesso) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json -# **get_characters_character_id_corporationhistory** -> Array&lt;GetCharactersCharacterIdCorporationhistory200Ok&gt; get_characters_character_id_corporationhistory(character_id, opts) +# **get_characters_character_id_chat_channels** +> Array&lt;GetCharactersCharacterIdChatChannels200Ok&gt; get_characters_character_id_chat_channels(character_id, opts) -Get corporation history +Get chat channels -Get a list of all the corporations a character has been a member of --- This route is cached for up to 3600 seconds +Return chat channels that a character is the owner or an operator of --- This route is cached for up to 300 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 +character_id = 56 # Integer | ID for a character opts = { - datasource: 'tranquility', # String | The server name you would like data from - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag + datasource: "tranquility", # String | The server name you would like data from + token: "token_example", # String | Access token to use, if preferred over 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 corporation history - result = api_instance.get_characters_character_id_corporationhistory(character_id, opts) + #Get chat channels + result = api_instance.get_characters_character_id_chat_channels(character_id, opts) p result rescue ESIClient::ApiError => e - puts "Exception when calling CharacterApi->get_characters_character_id_corporationhistory: #{e}" + puts "Exception when calling CharacterApi->get_characters_character_id_chat_channels: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **character_id** | **Integer**| An EVE character ID | + **character_id** | **Integer**| ID for a character | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] + **token** | **String**| Access token to use, if preferred over 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;GetCharactersCharacterIdCorporationhistory200Ok&gt;**](GetCharactersCharacterIdCorporationhistory200Ok.md) +[**Array&lt;GetCharactersCharacterIdChatChannels200Ok&gt;**](GetCharactersCharacterIdChatChannels200Ok.md) ### Authorization -No authorization required +[evesso](../README.md#evesso) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json -# **get_characters_character_id_fatigue** -> GetCharactersCharacterIdFatigueOk get_characters_character_id_fatigue(character_id, opts) +# **get_characters_character_id_corporationhistory** +> Array&lt;GetCharactersCharacterIdCorporationhistory200Ok&gt; get_characters_character_id_corporationhistory(character_id, opts) -Get jump fatigue +Get corporation history -Return a character's jump activation and fatigue information --- This route is cached for up to 300 seconds +Get a list of all the corporations a character has been a member of --- 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 - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header + 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 jump fatigue - result = api_instance.get_characters_character_id_fatigue(character_id, opts) + #Get corporation history + result = api_instance.get_characters_character_id_corporationhistory(character_id, opts) p result rescue ESIClient::ApiError => e - puts "Exception when calling CharacterApi->get_characters_character_id_fatigue: #{e}" + puts "Exception when calling CharacterApi->get_characters_character_id_corporationhistory: #{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] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **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 -[**GetCharactersCharacterIdFatigueOk**](GetCharactersCharacterIdFatigueOk.md) +[**Array&lt;GetCharactersCharacterIdCorporationhistory200Ok&gt;**](GetCharactersCharacterIdCorporationhistory200Ok.md) ### Authorization -[evesso](../README.md#evesso) +No authorization required ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json # **get_characters_character_id_medals** @@ -326,16 +331,17 @@ config.access_token = 'YOUR ACCESS TOKEN' end api_instance = ESIClient::CharacterApi.new -character_id = 56 # Integer | An EVE character ID +character_id = 56 # Integer | ID for a character opts = { - datasource: 'tranquility', # String | The server name you would like data from - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header + datasource: "tranquility", # String | The server name you would like data from + token: "token_example", # String | Access token to use, if preferred over 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) @@ -347,14 +353,15 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **character_id** | **Integer**| An EVE character ID | + **character_id** | **Integer**| ID for a character | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **token** | **String**| Access token to use if unable to set a header | [optional] + **token** | **String**| Access token to use, if preferred over 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;GetCharactersCharacterIdMedals200Ok&gt;**](GetCharactersCharacterIdMedals200Ok.md) @@ -362,135 +369,15 @@ [evesso](../README.md#evesso) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json -# **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 --- Warning: This route has an upgrade available. --- [Diff of the upcoming changes](https://esi.evetech.net/diff/latest/dev/#GET-/characters/{character_id}/notifications/) - -### 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 - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header -} - -begin - #Get character notifications - result = api_instance.get_characters_character_id_notifications(character_id, opts) - p result -rescue ESIClient::ApiError => e - puts "Exception when calling CharacterApi->get_characters_character_id_notifications: #{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] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **token** | **String**| Access token to use if unable to set a header | [optional] - -### Return type - -[**Array&lt;GetCharactersCharacterIdNotifications200Ok&gt;**](GetCharactersCharacterIdNotifications200Ok.md) - -### Authorization - -[evesso](../README.md#evesso) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -# **get_characters_character_id_notifications_contacts** -> Array&lt;GetCharactersCharacterIdNotificationsContacts200Ok&gt; get_characters_character_id_notifications_contacts(character_id, opts) - -Get new contact notifications - -Return notifications about having been added to someone's contact list --- This route is cached for up to 600 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 - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header -} - -begin - #Get new contact notifications - result = api_instance.get_characters_character_id_notifications_contacts(character_id, opts) - p result -rescue ESIClient::ApiError => e - puts "Exception when calling CharacterApi->get_characters_character_id_notifications_contacts: #{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] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **token** | **String**| Access token to use if unable to set a header | [optional] - -### Return type - -[**Array&lt;GetCharactersCharacterIdNotificationsContacts200Ok&gt;**](GetCharactersCharacterIdNotificationsContacts200Ok.md) - -### Authorization - -[evesso](../README.md#evesso) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - # **get_characters_character_id_portrait** > GetCharactersCharacterIdPortraitOk get_characters_character_id_portrait(character_id, opts) Get character portraits @@ -504,12 +391,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 - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag + 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) @@ -523,11 +411,12 @@ 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] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [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 [**GetCharactersCharacterIdPortraitOk**](GetCharactersCharacterIdPortraitOk.md) @@ -535,17 +424,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json # **get_characters_character_id_roles** -> GetCharactersCharacterIdRolesOk get_characters_character_id_roles(character_id, opts) +> Array&lt;String&gt; 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 @@ -559,16 +448,17 @@ config.access_token = 'YOUR ACCESS TOKEN' end api_instance = ESIClient::CharacterApi.new -character_id = 56 # Integer | An EVE character ID +character_id = 56 # Integer | A character ID opts = { - datasource: 'tranquility', # String | The server name you would like data from - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header + datasource: "tranquility", # String | The server name you would like data from + token: "token_example", # String | Access token to use, if preferred over 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) @@ -580,26 +470,27 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **character_id** | **Integer**| An EVE character ID | + **character_id** | **Integer**| A character ID | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **token** | **String**| Access token to use if unable to set a header | [optional] + **token** | **String**| Access token to use, if preferred over 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 -[**GetCharactersCharacterIdRolesOk**](GetCharactersCharacterIdRolesOk.md) +**Array&lt;String&gt;** ### Authorization [evesso](../README.md#evesso) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json # **get_characters_character_id_standings** @@ -619,16 +510,17 @@ config.access_token = 'YOUR ACCESS TOKEN' end api_instance = ESIClient::CharacterApi.new -character_id = 56 # Integer | An EVE character ID +character_id = 56 # Integer | ID for a character opts = { - datasource: 'tranquility', # String | The server name you would like data from - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header + datasource: "tranquility", # String | The server name you would like data from + token: "token_example", # String | Access token to use, if preferred over 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) @@ -640,14 +532,15 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **character_id** | **Integer**| An EVE character ID | + **character_id** | **Integer**| ID for a character | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **token** | **String**| Access token to use if unable to set a header | [optional] + **token** | **String**| Access token to use, if preferred over 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;GetCharactersCharacterIdStandings200Ok&gt;**](GetCharactersCharacterIdStandings200Ok.md) @@ -655,135 +548,70 @@ [evesso](../README.md#evesso) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json -# **get_characters_character_id_stats** -> Array&lt;GetCharactersCharacterIdStats200Ok&gt; get_characters_character_id_stats(character_id, opts) +# **get_characters_names** +> Array&lt;GetCharactersNames200Ok&gt; get_characters_names(character_ids, opts) -Yearly aggregate stats +Get character names -Returns aggregate yearly stats for a character --- This route is cached for up to 86400 seconds +Resolve a set of character IDs to character names --- 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 +character_ids = [56] # Array<Integer> | A comma separated list of character IDs opts = { - datasource: 'tranquility', # String | The server name you would like data from - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header + 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 - #Yearly aggregate stats - result = api_instance.get_characters_character_id_stats(character_id, opts) + #Get character names + result = api_instance.get_characters_names(character_ids, opts) p result rescue ESIClient::ApiError => e - puts "Exception when calling CharacterApi->get_characters_character_id_stats: #{e}" + puts "Exception when calling CharacterApi->get_characters_names: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **character_id** | **Integer**| An EVE character ID | + **character_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A comma separated list of character IDs | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **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) +[**Array&lt;GetCharactersNames200Ok&gt;**](GetCharactersNames200Ok.md) ### Authorization -[evesso](../README.md#evesso) +No authorization required ### HTTP request headers - - **Content-Type**: application/json + - **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 - if_none_match: 'if_none_match_example', # String | ETag from a previous request. A 304 will be returned if this matches the current ETag - token: 'token_example' # String | Access token to use if unable to set a header -} - -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] - **if_none_match** | **String**| ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] - **token** | **String**| Access token to use if unable to set a header | [optional] - -### Return type - -[**Array&lt;GetCharactersCharacterIdTitles200Ok&gt;**](GetCharactersCharacterIdTitles200Ok.md) - -### Authorization - -[evesso](../README.md#evesso) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - # **post_characters_affiliation** > Array&lt;PostCharactersAffiliation200Ok&gt; post_characters_affiliation(characters, opts) Character affiliation @@ -794,14 +622,16 @@ # load the gem require 'esi_client' 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. +characters = [ESIClient::Array<Integer>.new] # Array<Integer> | The character IDs to fetch affiliations for opts = { - datasource: 'tranquility', # String | The server name you would like data from + 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) @@ -813,12 +643,14 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **characters** | **Array&lt;Integer&gt;**| The character IDs to fetch affiliations for. All characters must exist, or none will be returned. | + **characters** | **Array&lt;Integer&gt;**| The character IDs to fetch affiliations for | **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&lt;PostCharactersAffiliation200Ok&gt;**](PostCharactersAffiliation200Ok.md) @@ -826,17 +658,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json # **post_characters_character_id_cspa** -> Float post_characters_character_id_cspa(character_idcharacters, opts) +> PostCharactersCharacterIdCspaCreated post_characters_character_id_cspa(character_id, characters, 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 --- @@ -852,20 +684,22 @@ api_instance = ESIClient::CharacterApi.new character_id = 56 # Integer | An EVE character ID -characters = [ESIClient::Array<Integer>.new] # Array<Integer> | The target characters to calculate the charge for +characters = ESIClient::PostCharactersCharacterIdCspaCharacters.new # PostCharactersCharacterIdCspaCharacters | 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 + datasource: "tranquility", # String | The server name you would like data from + token: "token_example", # String | Access token to use, if preferred over 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) + result = api_instance.post_characters_character_id_cspa(character_id, characters, opts) p result rescue ESIClient::ApiError => e puts "Exception when calling CharacterApi->post_characters_character_id_cspa: #{e}" end ``` @@ -873,24 +707,26 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **character_id** | **Integer**| An EVE character ID | - **characters** | **Array&lt;Integer&gt;**| The target characters to calculate the charge for | + **characters** | [**PostCharactersCharacterIdCspaCharacters**](PostCharactersCharacterIdCspaCharacters.md)| 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] + **token** | **String**| Access token to use, if preferred over 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 -**Float** +[**PostCharactersCharacterIdCspaCreated**](PostCharactersCharacterIdCspaCreated.md) ### Authorization [evesso](../README.md#evesso) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json