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/BookmarksApi.md CHANGED Viewed

@@ -1,13 +1,11 @@
 # ESIClient::BookmarksApi
-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_bookmarks**](BookmarksApi.md#get_characters_character_id_bookmarks) | **GET** /v2/characters/{character_id}/bookmarks/ | List bookmarks
-[**get_characters_character_id_bookmarks_folders**](BookmarksApi.md#get_characters_character_id_bookmarks_folders) | **GET** /v2/characters/{character_id}/bookmarks/folders/ | List bookmark folders
-[**get_corporations_corporation_id_bookmarks**](BookmarksApi.md#get_corporations_corporation_id_bookmarks) | **GET** /v1/corporations/{corporation_id}/bookmarks/ | List corporation bookmarks
-[**get_corporations_corporation_id_bookmarks_folders**](BookmarksApi.md#get_corporations_corporation_id_bookmarks_folders) | **GET** /v1/corporations/{corporation_id}/bookmarks/folders/ | List corporation bookmark folders
+[**get_characters_character_id_bookmarks**](BookmarksApi.md#get_characters_character_id_bookmarks) | **GET** /v1/characters/{character_id}/bookmarks/ | List bookmarks
+[**get_characters_character_id_bookmarks_folders**](BookmarksApi.md#get_characters_character_id_bookmarks_folders) | **GET** /v1/characters/{character_id}/bookmarks/folders/ | List bookmark folders
 # **get_characters_character_id_bookmarks**
@@ -15,7 +13,7 @@ Method | HTTP request | Description
 List bookmarks
-A list of your character's personal bookmarks  ---  This route is cached for up to 3600 seconds
+List your character's personal bookmarks  ---  This route is cached for up to 3600 seconds
 ### Example
 ```ruby
@@ -32,10 +30,10 @@ api_instance = ESIClient::BookmarksApi.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
+  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,9 +51,9 @@ 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]
+ **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
@@ -67,7 +65,7 @@ Name | Type | Description  | Notes
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
@@ -77,7 +75,7 @@ Name | Type | Description  | Notes
 List bookmark folders
-A list of your character's personal bookmark folders  ---  This route is cached for up to 3600 seconds
+List your character's personal bookmark folders  ---  This route is cached for up to 3600 seconds
 ### Example
 ```ruby
@@ -94,10 +92,10 @@ api_instance = ESIClient::BookmarksApi.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
+  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
@@ -115,9 +113,9 @@ 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]
+ **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
@@ -129,131 +127,7 @@ Name | Type | Description  | Notes
 ### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_corporations_corporation_id_bookmarks**
-> Array&lt;GetCorporationsCorporationIdBookmarks200Ok&gt; get_corporations_corporation_id_bookmarks(corporation_id, opts)
-List corporation bookmarks
-A list of your corporation's bookmarks  ---  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::BookmarksApi.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
-  #List corporation bookmarks
-  result = api_instance.get_corporations_corporation_id_bookmarks(corporation_id, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling BookmarksApi->get_corporations_corporation_id_bookmarks: #{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&lt;GetCorporationsCorporationIdBookmarks200Ok&gt;**](GetCorporationsCorporationIdBookmarks200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_corporations_corporation_id_bookmarks_folders**
-> Array&lt;GetCorporationsCorporationIdBookmarksFolders200Ok&gt; get_corporations_corporation_id_bookmarks_folders(corporation_id, opts)
-List corporation bookmark folders
-A list of your corporation's bookmark folders  ---  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::BookmarksApi.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
-  #List corporation bookmark folders
-  result = api_instance.get_corporations_corporation_id_bookmarks_folders(corporation_id, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling BookmarksApi->get_corporations_corporation_id_bookmarks_folders: #{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&lt;GetCorporationsCorporationIdBookmarksFolders200Ok&gt;**](GetCorporationsCorporationIdBookmarksFolders200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json

data/docs/CalendarApi.md CHANGED Viewed

@@ -1,12 +1,11 @@
 # ESIClient::CalendarApi
-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_calendar**](CalendarApi.md#get_characters_character_id_calendar) | **GET** /v1/characters/{character_id}/calendar/ | List calendar event summaries
 [**get_characters_character_id_calendar_event_id**](CalendarApi.md#get_characters_character_id_calendar_event_id) | **GET** /v3/characters/{character_id}/calendar/{event_id}/ | Get an event
-[**get_characters_character_id_calendar_event_id_attendees**](CalendarApi.md#get_characters_character_id_calendar_event_id_attendees) | **GET** /v1/characters/{character_id}/calendar/{event_id}/attendees/ | Get attendees
 [**put_characters_character_id_calendar_event_id**](CalendarApi.md#put_characters_character_id_calendar_event_id) | **PUT** /v3/characters/{character_id}/calendar/{event_id}/ | Respond to an event
@@ -15,7 +14,7 @@ Method | HTTP request | Description
 List calendar event summaries
-Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event.  ---  This route is cached for up to 5 seconds
+Get 50 event summaries from the calendar. If no event ID is given, the resource will return the next 50 chronological event summaries from now. If an event ID is specified, it will return the next 50 chronological event summaries from after that event.  ---  This route is cached for up to 5 seconds
 ### Example
 ```ruby
@@ -29,13 +28,14 @@ end
 api_instance = ESIClient::CalendarApi.new
-character_id = 56 # Integer | An EVE character ID
+character_id = 56 # Integer | The character to retrieve events from
 opts = {
-  datasource: 'tranquility', # String | The server name you would like data from
+  datasource: "tranquility", # String | The server name you would like data from
   from_event: 56, # Integer | The event ID to retrieve events 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
+  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
@@ -51,11 +51,12 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **character_id** | **Integer**| An EVE character ID |
+ **character_id** | **Integer**| The character to retrieve events from |
  **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility]
  **from_event** | **Integer**| The event ID to retrieve events from | [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]
+ **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
@@ -67,13 +68,13 @@ Name | Type | Description  | Notes
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 # **get_characters_character_id_calendar_event_id**
-> GetCharactersCharacterIdCalendarEventIdOk get_characters_character_id_calendar_event_id(character_idevent_id, opts)
+> GetCharactersCharacterIdCalendarEventIdOk get_characters_character_id_calendar_event_id(character_id, event_id, opts)
 Get an event
@@ -91,19 +92,20 @@ end
 api_instance = ESIClient::CalendarApi.new
-character_id = 56 # Integer | An EVE character ID
+character_id = 56 # Integer | The character id requesting the event
 event_id = 56 # Integer | The id of the event requested
 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 an event
-  result = api_instance.get_characters_character_id_calendar_event_id(character_idevent_id, opts)
+  result = api_instance.get_characters_character_id_calendar_event_id(character_id, event_id, opts)
   p result
 rescue ESIClient::ApiError => e
   puts "Exception when calling CalendarApi->get_characters_character_id_calendar_event_id: #{e}"
@@ -114,11 +116,12 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **character_id** | **Integer**| An EVE character ID |
+ **character_id** | **Integer**| The character id requesting the event |
  **event_id** | **Integer**| The id of the event requested |
  **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
@@ -130,76 +133,13 @@ Name | Type | Description  | Notes
 ### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **get_characters_character_id_calendar_event_id_attendees**
-> Array&lt;GetCharactersCharacterIdCalendarEventIdAttendees200Ok&gt; get_characters_character_id_calendar_event_id_attendees(character_idevent_id, opts)
-Get attendees
-Get all invited attendees for a given event  ---  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::CalendarApi.new
-character_id = 56 # Integer | An EVE character ID
-event_id = 56 # Integer | The id of the event requested
-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 attendees
-  result = api_instance.get_characters_character_id_calendar_event_id_attendees(character_idevent_id, opts)
-  p result
-rescue ESIClient::ApiError => e
-  puts "Exception when calling CalendarApi->get_characters_character_id_calendar_event_id_attendees: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **character_id** | **Integer**| An EVE character ID |
- **event_id** | **Integer**| The id of the event requested |
- **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;GetCharactersCharacterIdCalendarEventIdAttendees200Ok&gt;**](GetCharactersCharacterIdCalendarEventIdAttendees200Ok.md)
-### Authorization
-[evesso](../README.md#evesso)
-### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 # **put_characters_character_id_calendar_event_id**
-> put_characters_character_id_calendar_event_id(character_idevent_id, response, opts)
+> put_characters_character_id_calendar_event_id(character_id, event_id, response, opts)
 Respond to an event
@@ -217,20 +157,22 @@ end
 api_instance = ESIClient::CalendarApi.new
-character_id = 56 # Integer | An EVE character ID
+character_id = 56 # Integer | The character ID requesting the event
 event_id = 56 # Integer | The ID of the event requested
 response = ESIClient::PutCharactersCharacterIdCalendarEventIdResponse.new # PutCharactersCharacterIdCalendarEventIdResponse | The response value to set, overriding current value.
 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
   #Respond to an event
-  api_instance.put_characters_character_id_calendar_event_id(character_idevent_id, response, opts)
+  api_instance.put_characters_character_id_calendar_event_id(character_id, event_id, response, opts)
 rescue ESIClient::ApiError => e
   puts "Exception when calling CalendarApi->put_characters_character_id_calendar_event_id: #{e}"
 end
@@ -240,11 +182,13 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **character_id** | **Integer**| An EVE character ID |
+ **character_id** | **Integer**| The character ID requesting the event |
  **event_id** | **Integer**| The ID of the event requested |
  **response** | [**PutCharactersCharacterIdCalendarEventIdResponse**](PutCharactersCharacterIdCalendarEventIdResponse.md)| The response value to set, overriding current value. |
  **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
@@ -256,7 +200,7 @@ nil (empty response body)
 ### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json