docs/WalletApi.md in esi_client-0.7.6.2 vs docs/WalletApi.md in esi_client-0.8.5.0
- old
+ new
@@ -1,16 +1,16 @@
# ESIClient::WalletApi
-All URIs are relative to *https://esi.tech.ccp.is*
+All URIs are relative to *https://esi.evetech.net*
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's wallet balance
-[**get_characters_character_id_wallet_journal**](WalletApi.md#get_characters_character_id_wallet_journal) | **GET** /v3/characters/{character_id}/wallet/journal/ | Get character wallet journal
+[**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's wallet balance
-[**get_corporations_corporation_id_wallets_division_journal**](WalletApi.md#get_corporations_corporation_id_wallets_division_journal) | **GET** /v2/corporations/{corporation_id}/wallets/{division}/journal/ | Get corporation wallet journal
+[**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_wallet**
> Float get_characters_character_id_wallet(character_id, opts)
@@ -33,13 +33,12 @@
character_id = 56 # Integer | An EVE character ID
opts = {
datasource: 'tranquility', # String | The server name you would like data from
- token: 'token_example', # String | Access token to use if unable to set a header
- user_agent: 'user_agent_example', # String | Client identifier, takes precedence over headers
- x_user_agent: 'x_user_agent_example' # String | Client identifier, takes precedence over User-Agent
+ 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 a character's wallet balance
result = api_instance.get_characters_character_id_wallet(character_id, opts)
@@ -53,13 +52,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]
**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
**Float**
@@ -67,21 +65,21 @@
[evesso](../README.md#evesso)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **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 --- [This route has an available update](https://esi.tech.ccp.is/diff/latest/dev/#GET-/characters/{character_id}/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'
@@ -95,14 +93,13 @@
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
+ 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)
@@ -116,14 +113,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]
- **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]
+ **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]
- **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)
@@ -131,11 +127,11 @@
[evesso](../README.md#evesso)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
# **get_characters_character_id_wallet_transactions**
@@ -160,13 +156,12 @@
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
+ 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)
@@ -181,13 +176,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]
**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]
- **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)
@@ -195,17 +189,17 @@
[evesso](../README.md#evesso)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
# **get_corporations_corporation_id_wallets**
-> Array<GetCorporationsCorporationIdWallets200Ok> get_corporations_corporation_id_wallets(corporation_id, , opts)
+> 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 --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
@@ -223,18 +217,17 @@
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
+ 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)
+ 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
```
@@ -243,13 +236,12 @@
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]
- **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)
@@ -257,21 +249,21 @@
[evesso](../README.md#evesso)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
# **get_corporations_corporation_id_wallets_division_journal**
-> Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok> get_corporations_corporation_id_wallets_division_journal(corporation_id, division, opts)
+> 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 --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant --- [This route has an available update](https://esi.tech.ccp.is/diff/latest/dev/#GET-/corporations/{corporation_id}/wallets/{division}/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'
@@ -287,19 +279,18 @@
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
+ 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_id, division, opts)
+ 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
```
@@ -309,14 +300,13 @@
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]
+ **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]
- **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)
@@ -324,17 +314,17 @@
[evesso](../README.md#evesso)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
# **get_corporations_corporation_id_wallets_division_transactions**
-> Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok> get_corporations_corporation_id_wallets_division_transactions(corporation_id, division, opts)
+> 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 --- Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant
@@ -355,18 +345,17 @@
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
+ 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_id, division, opts)
+ 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
```
@@ -377,13 +366,12 @@
------------- | ------------- | ------------- | -------------
**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]
- **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)
@@ -391,10 +379,10 @@
[evesso](../README.md#evesso)
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json