RubyGems - esi_client - Versions diffs - 0.8.5.0 → 1.0.1 - Mend

esi_client 0.8.5.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1106) hide show

data/docs/UserInterfaceApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # ESIClient::UserInterfaceApi
-All URIs are relative to *https://esi.evetech.net*
+All URIs are relative to *https://esi.tech.ccp.is/*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -37,8 +37,10 @@ clear_other_waypoints = false # BOOLEAN | Whether clean other waypoints beforing
 destination_id = 789 # Integer | The destination to travel to, can be solar system, station or structure's 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
+  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
@@ -57,7 +59,9 @@ Name | Type | Description  | Notes
  **clear_other_waypoints** | **BOOLEAN**| Whether clean other waypoints beforing adding this one | [default to false]
  **destination_id** | **Integer**| The destination to travel to, can be solar system, station or structure&#39;s 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]
+ **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,7 +73,7 @@ nil (empty response body)
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
@@ -96,8 +100,10 @@ api_instance = ESIClient::UserInterfaceApi.new
 contract_id = 56 # Integer | The contract to open
 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
@@ -114,7 +120,9 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **contract_id** | **Integer**| The contract to open |
  **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
@@ -126,7 +134,7 @@ nil (empty response body)
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
@@ -153,8 +161,10 @@ api_instance = ESIClient::UserInterfaceApi.new
 target_id = 56 # Integer | The target to open
 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
@@ -171,7 +181,9 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **target_id** | **Integer**| The target to open |
  **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
@@ -183,7 +195,7 @@ nil (empty response body)
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
@@ -210,8 +222,10 @@ api_instance = ESIClient::UserInterfaceApi.new
 type_id = 56 # Integer | The item type to open in market window
 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
@@ -228,7 +242,9 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **type_id** | **Integer**| The item type to open in market window |
  **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
@@ -240,7 +256,7 @@ nil (empty response body)
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
@@ -267,8 +283,10 @@ api_instance = ESIClient::UserInterfaceApi.new
 new_mail = ESIClient::PostUiOpenwindowNewmailNewMail.new # PostUiOpenwindowNewmailNewMail | The details of mail to create
 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
@@ -285,7 +303,9 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **new_mail** | [**PostUiOpenwindowNewmailNewMail**](PostUiOpenwindowNewmailNewMail.md)| The details of mail to create |
  **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
@@ -297,7 +317,7 @@ nil (empty response body)
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json

data/docs/WalletApi.md CHANGED Viewed

@@ -1,23 +1,18 @@
 # ESIClient::WalletApi
-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_wallet**](WalletApi.md#get_characters_character_id_wallet) | **GET** /v1/characters/{character_id}/wallet/ | Get a character&#39;s wallet balance
-[**get_characters_character_id_wallet_journal**](WalletApi.md#get_characters_character_id_wallet_journal) | **GET** /v4/characters/{character_id}/wallet/journal/ | Get character wallet journal
-[**get_characters_character_id_wallet_transactions**](WalletApi.md#get_characters_character_id_wallet_transactions) | **GET** /v1/characters/{character_id}/wallet/transactions/ | Get wallet transactions
-[**get_corporations_corporation_id_wallets**](WalletApi.md#get_corporations_corporation_id_wallets) | **GET** /v1/corporations/{corporation_id}/wallets/ | Returns a corporation&#39;s wallet balance
-[**get_corporations_corporation_id_wallets_division_journal**](WalletApi.md#get_corporations_corporation_id_wallets_division_journal) | **GET** /v3/corporations/{corporation_id}/wallets/{division}/journal/ | Get corporation wallet journal
-[**get_corporations_corporation_id_wallets_division_transactions**](WalletApi.md#get_corporations_corporation_id_wallets_division_transactions) | **GET** /v1/corporations/{corporation_id}/wallets/{division}/transactions/ | Get corporation wallet transactions
+[**get_characters_character_id_wallets**](WalletApi.md#get_characters_character_id_wallets) | **GET** /v1/characters/{character_id}/wallets/ | List wallets and balances
-# **get_characters_character_id_wallet**
-> Float get_characters_character_id_wallet(character_id, opts)
+# **get_characters_character_id_wallets**
+> Array&lt;GetCharactersCharacterIdWallets200Ok&gt; get_characters_character_id_wallets(character_id, opts)
-Get a character's wallet balance
+List wallets and balances
-Returns a character's wallet balance  ---  This route is cached for up to 120 seconds
+List your wallets and their balances. Characters typically have only one wallet, with wallet_id 1000 being the master wallet.  ---  This route is cached for up to 120 seconds
 ### Example
 ```ruby
@@ -34,17 +29,18 @@ api_instance = ESIClient::WalletApi.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
+  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 a character's wallet balance
-  result = api_instance.get_characters_character_id_wallet(character_id, opts)
+  #List wallets and balances
+  result = api_instance.get_characters_character_id_wallets(character_id, opts)
   p result
 rescue ESIClient::ApiError => e
-  puts "Exception when calling WalletApi->get_characters_character_id_wallet: #{e}"
+  puts "Exception when calling WalletApi->get_characters_character_id_wallets: #{e}"
 end
 ```
@@ -54,12 +50,13 @@ 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]
+ **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**
+[**Array&lt;GetCharactersCharacterIdWallets200Ok&gt;**](GetCharactersCharacterIdWallets200Ok.md)
 ### Authorization
@@ -67,321 +64,7 @@ Name | Type | Description  | Notes
 ### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_characters_character_id_wallet_journal**
-> Array&lt;GetCharactersCharacterIdWalletJournal200Ok&gt; get_characters_character_id_wallet_journal(character_id, opts)
-Get character wallet journal
-Retrieve the given character's wallet journal going 30 days back  ---  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::WalletApi.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
-  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 character wallet journal
-  result = api_instance.get_characters_character_id_wallet_journal(character_id, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling WalletApi->get_characters_character_id_wallet_journal: #{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]
- **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&lt;GetCharactersCharacterIdWalletJournal200Ok&gt;**](GetCharactersCharacterIdWalletJournal200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_characters_character_id_wallet_transactions**
-> Array&lt;GetCharactersCharacterIdWalletTransactions200Ok&gt; get_characters_character_id_wallet_transactions(character_id, opts)
-Get wallet transactions
-Get wallet transactions of a character  ---  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::WalletApi.new
-character_id = 56 # Integer | An EVE character ID
-opts = {
-  datasource: 'tranquility', # String | The server name you would like data from
-  from_id: 789, # Integer | Only show transactions happened before the one referenced by this id
-  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 wallet transactions
-  result = api_instance.get_characters_character_id_wallet_transactions(character_id, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling WalletApi->get_characters_character_id_wallet_transactions: #{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]
- **from_id** | **Integer**| Only show transactions happened before the one referenced by this id | [optional]
- **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;GetCharactersCharacterIdWalletTransactions200Ok&gt;**](GetCharactersCharacterIdWalletTransactions200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_corporations_corporation_id_wallets**
-> Array&lt;GetCorporationsCorporationIdWallets200Ok&gt; get_corporations_corporation_id_wallets(corporation_id, opts)
-Returns a corporation's wallet balance
-Get a corporation's wallets  ---  This route is cached for up to 300 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
-### 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::WalletApi.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
-  token: 'token_example' # String | Access token to use if unable to set a header
-}
-begin
-  #Returns a corporation's wallet balance
-  result = api_instance.get_corporations_corporation_id_wallets(corporation_id, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling WalletApi->get_corporations_corporation_id_wallets: #{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]
- **token** | **String**| Access token to use if unable to set a header | [optional]
-### Return type
-[**Array&lt;GetCorporationsCorporationIdWallets200Ok&gt;**](GetCorporationsCorporationIdWallets200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_corporations_corporation_id_wallets_division_journal**
-> Array&lt;GetCorporationsCorporationIdWalletsDivisionJournal200Ok&gt; get_corporations_corporation_id_wallets_division_journal(corporation_iddivision, opts)
-Get corporation wallet journal
-Retrieve the given corporation's wallet journal for the given division going 30 days back  ---  This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
-### 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::WalletApi.new
-corporation_id = 56 # Integer | An EVE corporation ID
-division = 56 # Integer | Wallet key of the division to fetch journals from
-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 wallet journal
-  result = api_instance.get_corporations_corporation_id_wallets_division_journal(corporation_iddivision, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling WalletApi->get_corporations_corporation_id_wallets_division_journal: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **corporation_id** | **Integer**| An EVE corporation ID |
- **division** | **Integer**| Wallet key of the division to fetch journals from |
- **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&lt;GetCorporationsCorporationIdWalletsDivisionJournal200Ok&gt;**](GetCorporationsCorporationIdWalletsDivisionJournal200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_corporations_corporation_id_wallets_division_transactions**
-> Array&lt;GetCorporationsCorporationIdWalletsDivisionTransactions200Ok&gt; get_corporations_corporation_id_wallets_division_transactions(corporation_iddivision, opts)
-Get corporation wallet transactions
-Get wallet transactions of a corporation  ---  This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
-### 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::WalletApi.new
-corporation_id = 56 # Integer | An EVE corporation ID
-division = 56 # Integer | Wallet key of the division to fetch journals from
-opts = {
-  datasource: 'tranquility', # String | The server name you would like data from
-  from_id: 789, # Integer | Only show journal entries happened before the transaction referenced by this id
-  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 corporation wallet transactions
-  result = api_instance.get_corporations_corporation_id_wallets_division_transactions(corporation_iddivision, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling WalletApi->get_corporations_corporation_id_wallets_division_transactions: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **corporation_id** | **Integer**| An EVE corporation ID |
- **division** | **Integer**| Wallet key of the division to fetch journals from |
- **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
- **from_id** | **Integer**| Only show journal entries happened before the transaction referenced by this id | [optional]
- **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;GetCorporationsCorporationIdWalletsDivisionTransactions200Ok&gt;**](GetCorporationsCorporationIdWalletsDivisionTransactions200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json