docs/WalletApi.md in esi_client-1.2.0 vs docs/WalletApi.md in esi_client-1.3.0
- old
+ new
@@ -1,20 +1,25 @@
# ESIClient::WalletApi
-All URIs are relative to *https://esi.tech.ccp.is/*
+All URIs are relative to *https://esi.tech.ccp.is*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**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**](WalletApi.md#get_characters_character_id_wallet) | **GET** /v1/characters/{character_id}/wallet/ | Get a character's wallet balance
+[**get_characters_character_id_wallet_journal**](WalletApi.md#get_characters_character_id_wallet_journal) | **GET** /v2/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's wallet balance
+[**get_corporations_corporation_id_wallets_division_journal**](WalletApi.md#get_corporations_corporation_id_wallets_division_journal) | **GET** /v1/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**
-> Array<GetCharactersCharacterIdWallets200Ok> get_characters_character_id_wallets(character_id, opts)
+# **get_characters_character_id_wallet**
+> Float get_characters_character_id_wallet(character_id, opts)
-List wallets and balances
+Get a character's wallet balance
-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
+Returns a character's wallet balance --- This route is cached for up to 120 seconds
### Example
```ruby
# load the gem
require 'esi_client'
@@ -28,36 +33,360 @@
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 preferred over a header
+ token: "token_example", # String | Access token to use if unable to set a header
user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
}
begin
- #List wallets and balances
- result = api_instance.get_characters_character_id_wallets(character_id, opts)
+ #Get a character's wallet balance
+ result = api_instance.get_characters_character_id_wallet(character_id, opts)
p result
rescue ESIClient::ApiError => e
- puts "Exception when calling WalletApi->get_characters_character_id_wallets: #{e}"
+ puts "Exception when calling WalletApi->get_characters_character_id_wallet: #{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 preferred over a header | [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<GetCharactersCharacterIdWallets200Ok>**](GetCharactersCharacterIdWallets200Ok.md)
+**Float**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_characters_character_id_wallet_journal**
+> Array<GetCharactersCharacterIdWalletJournal200Ok> get_characters_character_id_wallet_journal(character_id, opts)
+
+Get character wallet journal
+
+Retrieve character wallet journal --- 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 journal entries happened before the transaction referenced by this id
+ 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 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]
+ **from_id** | **Integer**| Only show journal entries happened before the transaction referenced by this id | [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<GetCharactersCharacterIdWalletJournal200Ok>**](GetCharactersCharacterIdWalletJournal200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_characters_character_id_wallet_transactions**
+> Array<GetCharactersCharacterIdWalletTransactions200Ok> 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
+ 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 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]
+ **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<GetCharactersCharacterIdWalletTransactions200Ok>**](GetCharactersCharacterIdWalletTransactions200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_corporations_corporation_id_wallets**
+> Array<GetCorporationsCorporationIdWallets200Ok> 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
+
+### 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
+ 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
+ #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]
+ **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<GetCorporationsCorporationIdWallets200Ok>**](GetCorporationsCorporationIdWallets200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_corporations_corporation_id_wallets_division_journal**
+> Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok> get_corporations_corporation_id_wallets_division_journal(corporation_iddivision, opts)
+
+Get corporation wallet journal
+
+Retrieve corporation wallet journal --- 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
+
+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
+ 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 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]
+ **from_id** | **Integer**| Only show journal entries happened before the transaction referenced by this id | [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<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>**](GetCorporationsCorporationIdWalletsDivisionJournal200Ok.md)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_corporations_corporation_id_wallets_division_transactions**
+> Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok> 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
+
+### 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
+ 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 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]
+ **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<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok>**](GetCorporationsCorporationIdWalletsDivisionTransactions200Ok.md)
### Authorization
[evesso](../README.md#evesso)