esi_client 0.8.5.0 → 1.0.1

data/bin/regenerate

@@ -1,25 +1,11 @@
 #!/usr/bin/env sh
 
-echo "Version Number?"
-read version_number
-echo ">>> Generating files for version $version_number..."
-
-## DOCKER swagger-codegen
-docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate \
+swagger-codegen generate \
   --input-spec=https://esi.tech.ccp.is/_latest/swagger.json?datasource=tranquility \
   --lang=ruby \
-  -D gemName=esi_client,moduleName=ESIClient,gemVersion=$version_number \
-  --git-repo-id esi_client \
-  --git-user-id EmberSands \
-  --output=/local/.
-
-## Local swagger-codegen
-# swagger-codegen generate \
-#   --input-spec=https://esi.tech.ccp.is/_latest/swagger.json?datasource=tranquility \
-#   --lang=ruby \
-#   -D gemName=esi_client,moduleName=ESIClient,gemVersion=$version_number \
-#   --git-repo-id esi_client \
-#   --git-user-id EmberSands \
-#   --output=.
+  -DgemName=esi_client \
+  -DmoduleName=ESIClient \
+  --output=.
 
 echo ">>> File generation complete."
+echo ">>> Remember to update the gem version to the version of ESI"

data/docs/AllianceApi.md

@@ -1,13 +1,14 @@
 # ESIClient::AllianceApi
 
-All URIs are relative to *https://esi.evetech.net*
+All URIs are relative to *https://esi.tech.ccp.is/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_alliances**](AllianceApi.md#get_alliances) | **GET** /v1/alliances/ | List all alliances
-[**get_alliances_alliance_id**](AllianceApi.md#get_alliances_alliance_id) | **GET** /v3/alliances/{alliance_id}/ | Get alliance information
+[**get_alliances_alliance_id**](AllianceApi.md#get_alliances_alliance_id) | **GET** /v2/alliances/{alliance_id}/ | Get alliance information
 [**get_alliances_alliance_id_corporations**](AllianceApi.md#get_alliances_alliance_id_corporations) | **GET** /v1/alliances/{alliance_id}/corporations/ | List alliance's corporations
 [**get_alliances_alliance_id_icons**](AllianceApi.md#get_alliances_alliance_id_icons) | **GET** /v1/alliances/{alliance_id}/icons/ | Get alliance icon
+[**get_alliances_names**](AllianceApi.md#get_alliances_names) | **GET** /v1/alliances/names/ | Get alliance names
 
 
 # **get_alliances**
@@ -25,8 +26,9 @@ require 'esi_client'
 api_instance = ESIClient::AllianceApi.new
 
 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
@@ -43,7 +45,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **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
 
@@ -55,7 +58,7 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 
@@ -74,11 +77,12 @@ require 'esi_client'
 
 api_instance = ESIClient::AllianceApi.new
 
-alliance_id = 56 # Integer | An EVE alliance ID
+alliance_id = 56 # Integer | An Eve alliance 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
@@ -94,9 +98,10 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **alliance_id** | **Integer**| An EVE alliance ID | 
+ **alliance_id** | **Integer**| An Eve alliance 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
 
@@ -108,7 +113,7 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 
@@ -130,8 +135,9 @@ api_instance = ESIClient::AllianceApi.new
 alliance_id = 56 # Integer | An EVE alliance 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
@@ -149,7 +155,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **alliance_id** | **Integer**| An EVE alliance 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
 
@@ -161,7 +168,7 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 
@@ -183,8 +190,9 @@ api_instance = ESIClient::AllianceApi.new
 alliance_id = 56 # Integer | An EVE alliance 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
@@ -202,7 +210,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **alliance_id** | **Integer**| An EVE alliance 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
 
@@ -214,7 +223,62 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_alliances_names**
+> Array<GetAlliancesNames200Ok> get_alliances_names(alliance_ids, opts)
+
+Get alliance names
+
+Resolve a set of alliance IDs to alliance names  ---  This route is cached for up to 3600 seconds
+
+### Example
+```ruby
+# load the gem
+require 'esi_client'
+
+api_instance = ESIClient::AllianceApi.new
+
+alliance_ids = [56] # Array<Integer> | A comma separated list of alliance 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
+}
+
+begin
+  #Get alliance names
+  result = api_instance.get_alliances_names(alliance_ids, opts)
+  p result
+rescue ESIClient::ApiError => e
+  puts "Exception when calling AllianceApi->get_alliances_names: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **alliance_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A comma separated list of alliance IDs | 
+ **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;GetAlliancesNames200Ok&gt;**](GetAlliancesNames200Ok.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 

data/docs/AssetsApi.md

@@ -1,15 +1,10 @@
 # ESIClient::AssetsApi
 
-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_assets**](AssetsApi.md#get_characters_character_id_assets) | **GET** /v3/characters/{character_id}/assets/ | Get character assets
-[**get_corporations_corporation_id_assets**](AssetsApi.md#get_corporations_corporation_id_assets) | **GET** /v3/corporations/{corporation_id}/assets/ | Get corporation assets
-[**post_characters_character_id_assets_locations**](AssetsApi.md#post_characters_character_id_assets_locations) | **POST** /v2/characters/{character_id}/assets/locations/ | Get character asset locations
-[**post_characters_character_id_assets_names**](AssetsApi.md#post_characters_character_id_assets_names) | **POST** /v1/characters/{character_id}/assets/names/ | Get character asset names
-[**post_corporations_corporation_id_assets_locations**](AssetsApi.md#post_corporations_corporation_id_assets_locations) | **POST** /v2/corporations/{corporation_id}/assets/locations/ | Get corporation asset locations
-[**post_corporations_corporation_id_assets_names**](AssetsApi.md#post_corporations_corporation_id_assets_names) | **POST** /v1/corporations/{corporation_id}/assets/names/ | Get coporation asset names
+[**get_characters_character_id_assets**](AssetsApi.md#get_characters_character_id_assets) | **GET** /v1/characters/{character_id}/assets/ | Get character assets
 
 
 # **get_characters_character_id_assets**
@@ -31,13 +26,13 @@ end
 
 api_instance = ESIClient::AssetsApi.new
 
-character_id = 56 # Integer | An EVE character ID
+character_id = 56 # Integer | Character id of the target 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
@@ -53,11 +48,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **character_id** | **Integer**| An EVE character ID | 
+ **character_id** | **Integer**| Character id of the target 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
 
@@ -69,313 +64,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_corporations_corporation_id_assets**
-> Array<GetCorporationsCorporationIdAssets200Ok> get_corporations_corporation_id_assets(corporation_id, opts)
-
-Get corporation assets
-
-Return a list of the corporation assets  ---  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'
-# setup authorization
-ESIClient.configure do |config|
-  # Configure OAuth2 access token for authorization: evesso
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = ESIClient::AssetsApi.new
-
-corporation_id = 56 # Integer | An EVE corporation 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
-  page: 1, # Integer | Which page of results to return
-  token: 'token_example' # String | Access token to use if unable to set a header
-}
-
-begin
-  #Get corporation assets
-  result = api_instance.get_corporations_corporation_id_assets(corporation_id, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling AssetsApi->get_corporations_corporation_id_assets: #{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]
- **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] 
-
-### Return type
-
-[**Array<GetCorporationsCorporationIdAssets200Ok>**](GetCorporationsCorporationIdAssets200Ok.md)
-
-### Authorization
-
-[evesso](../README.md#evesso)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **post_characters_character_id_assets_locations**
-> Array<PostCharactersCharacterIdAssetsLocations200Ok> post_characters_character_id_assets_locations(character_iditem_ids, opts)
-
-Get character asset locations
-
-Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)  --- 
-
-### 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::AssetsApi.new
-
-character_id = 56 # Integer | An EVE character ID
-
-item_ids = [ESIClient::Array<Integer>.new] # Array<Integer> | A list of item ids
-
-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
-}
-
-begin
-  #Get character asset locations
-  result = api_instance.post_characters_character_id_assets_locations(character_iditem_ids, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling AssetsApi->post_characters_character_id_assets_locations: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **character_id** | **Integer**| An EVE character ID | 
- **item_ids** | **Array&lt;Integer&gt;**| A list of item ids | 
- **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] 
-
-### Return type
-
-[**Array&lt;PostCharactersCharacterIdAssetsLocations200Ok&gt;**](PostCharactersCharacterIdAssetsLocations200Ok.md)
-
-### Authorization
-
-[evesso](../README.md#evesso)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **post_characters_character_id_assets_names**
-> Array&lt;PostCharactersCharacterIdAssetsNames200Ok&gt; post_characters_character_id_assets_names(character_iditem_ids, opts)
-
-Get character asset names
-
-Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships.  --- 
-
-### 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::AssetsApi.new
-
-character_id = 56 # Integer | An EVE character ID
-
-item_ids = [ESIClient::Array<Integer>.new] # Array<Integer> | A list of item ids
-
-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
-}
-
-begin
-  #Get character asset names
-  result = api_instance.post_characters_character_id_assets_names(character_iditem_ids, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling AssetsApi->post_characters_character_id_assets_names: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **character_id** | **Integer**| An EVE character ID | 
- **item_ids** | **Array&lt;Integer&gt;**| A list of item ids | 
- **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] 
-
-### Return type
-
-[**Array&lt;PostCharactersCharacterIdAssetsNames200Ok&gt;**](PostCharactersCharacterIdAssetsNames200Ok.md)
-
-### Authorization
-
-[evesso](../README.md#evesso)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **post_corporations_corporation_id_assets_locations**
-> Array&lt;PostCorporationsCorporationIdAssetsLocations200Ok&gt; post_corporations_corporation_id_assets_locations(corporation_iditem_ids, opts)
-
-Get corporation asset locations
-
-Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)  ---  Requires one of the following EVE corporation role(s): Director
-
-### 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::AssetsApi.new
-
-corporation_id = 56 # Integer | An EVE corporation ID
-
-item_ids = [ESIClient::Array<Integer>.new] # Array<Integer> | A list of item ids
-
-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
-}
-
-begin
-  #Get corporation asset locations
-  result = api_instance.post_corporations_corporation_id_assets_locations(corporation_iditem_ids, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling AssetsApi->post_corporations_corporation_id_assets_locations: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **corporation_id** | **Integer**| An EVE corporation ID | 
- **item_ids** | **Array&lt;Integer&gt;**| A list of item ids | 
- **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] 
-
-### Return type
-
-[**Array&lt;PostCorporationsCorporationIdAssetsLocations200Ok&gt;**](PostCorporationsCorporationIdAssetsLocations200Ok.md)
-
-### Authorization
-
-[evesso](../README.md#evesso)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **post_corporations_corporation_id_assets_names**
-> Array&lt;PostCorporationsCorporationIdAssetsNames200Ok&gt; post_corporations_corporation_id_assets_names(corporation_iditem_ids, opts)
-
-Get coporation asset names
-
-Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships.  ---  Requires one of the following EVE corporation role(s): Director
-
-### 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::AssetsApi.new
-
-corporation_id = 56 # Integer | An EVE corporation ID
-
-item_ids = [ESIClient::Array<Integer>.new] # Array<Integer> | A list of item ids
-
-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
-}
-
-begin
-  #Get coporation asset names
-  result = api_instance.post_corporations_corporation_id_assets_names(corporation_iditem_ids, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling AssetsApi->post_corporations_corporation_id_assets_names: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **corporation_id** | **Integer**| An EVE corporation ID | 
- **item_ids** | **Array&lt;Integer&gt;**| A list of item ids | 
- **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] 
-
-### Return type
-
-[**Array&lt;PostCorporationsCorporationIdAssetsNames200Ok&gt;**](PostCorporationsCorporationIdAssetsNames200Ok.md)
-
-### Authorization
-
-[evesso](../README.md#evesso)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json