net.troja.eve.esi.api

Class PlanetaryInteractionApi

java.lang.Object

net.troja.eve.esi.api.PlanetaryInteractionApi

public class PlanetaryInteractionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PlanetaryInteractionApi()
PlanetaryInteractionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<CharacterPlanetsResponse>	getCharactersCharacterIdPlanets(Integer characterId, String datasource, String ifNoneMatch, String token) Get colonies Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1
okhttp3.Call	getCharactersCharacterIdPlanetsAsync(Integer characterId, String datasource, String ifNoneMatch, String token, ApiCallback<List<CharacterPlanetsResponse>> _callback) Get colonies (asynchronously) Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1
okhttp3.Call	getCharactersCharacterIdPlanetsCall(Integer characterId, String datasource, String ifNoneMatch, String token, ApiCallback _callback) Build call for getCharactersCharacterIdPlanets
CharacterPlanetResponse	getCharactersCharacterIdPlanetsPlanetId(Integer characterId, Integer planetId, String datasource, String token) Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes.
okhttp3.Call	getCharactersCharacterIdPlanetsPlanetIdAsync(Integer characterId, Integer planetId, String datasource, String token, ApiCallback<CharacterPlanetResponse> _callback) Get colony layout (asynchronously) Returns full details on the layout of a single planetary colony, including links, pins and routes.
okhttp3.Call	getCharactersCharacterIdPlanetsPlanetIdCall(Integer characterId, Integer planetId, String datasource, String token, ApiCallback _callback) Build call for getCharactersCharacterIdPlanetsPlanetId
ApiResponse<CharacterPlanetResponse>	getCharactersCharacterIdPlanetsPlanetIdWithHttpInfo(Integer characterId, Integer planetId, String datasource, String token) Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes.
ApiResponse<List<CharacterPlanetsResponse>>	getCharactersCharacterIdPlanetsWithHttpInfo(Integer characterId, String datasource, String ifNoneMatch, String token) Get colonies Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1
List<CorporationCustomsOfficesResponse>	getCorporationsCorporationIdCustomsOffices(Integer corporationId, String datasource, String ifNoneMatch, Integer page, String token) List corporation customs offices List customs offices owned by a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director SSO Scope: esi-planets.read_customs_offices.v1
okhttp3.Call	getCorporationsCorporationIdCustomsOfficesAsync(Integer corporationId, String datasource, String ifNoneMatch, Integer page, String token, ApiCallback<List<CorporationCustomsOfficesResponse>> _callback) List corporation customs offices (asynchronously) List customs offices owned by a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director SSO Scope: esi-planets.read_customs_offices.v1
okhttp3.Call	getCorporationsCorporationIdCustomsOfficesCall(Integer corporationId, String datasource, String ifNoneMatch, Integer page, String token, ApiCallback _callback) Build call for getCorporationsCorporationIdCustomsOffices
ApiResponse<List<CorporationCustomsOfficesResponse>>	getCorporationsCorporationIdCustomsOfficesWithHttpInfo(Integer corporationId, String datasource, String ifNoneMatch, Integer page, String token) List corporation customs offices List customs offices owned by a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director SSO Scope: esi-planets.read_customs_offices.v1
PlanetFactorySchematicResponse	getUniverseSchematicsSchematicId(Integer schematicId, String datasource, String ifNoneMatch) Get schematic information Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds
okhttp3.Call	getUniverseSchematicsSchematicIdAsync(Integer schematicId, String datasource, String ifNoneMatch, ApiCallback<PlanetFactorySchematicResponse> _callback) Get schematic information (asynchronously) Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds
okhttp3.Call	getUniverseSchematicsSchematicIdCall(Integer schematicId, String datasource, String ifNoneMatch, ApiCallback _callback) Build call for getUniverseSchematicsSchematicId
ApiResponse<PlanetFactorySchematicResponse>	getUniverseSchematicsSchematicIdWithHttpInfo(Integer schematicId, String datasource, String ifNoneMatch) Get schematic information Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanetaryInteractionApi

public PlanetaryInteractionApi()

PlanetaryInteractionApi

public PlanetaryInteractionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCharactersCharacterIdPlanetsCall

public okhttp3.Call getCharactersCharacterIdPlanetsCall(Integer characterId,
                                                        String datasource,
                                                        String ifNoneMatch,
                                                        String token,
                                                        ApiCallback _callback)
                                                 throws ApiException

Build call for getCharactersCharacterIdPlanets

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCharactersCharacterIdPlanets

public List<CharacterPlanetsResponse> getCharactersCharacterIdPlanets(Integer characterId,
                                                                      String datasource,
                                                                      String ifNoneMatch,
                                                                      String token)
                                                               throws ApiException

Get colonies Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

List<CharacterPlanetsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCharactersCharacterIdPlanetsWithHttpInfo

public ApiResponse<List<CharacterPlanetsResponse>> getCharactersCharacterIdPlanetsWithHttpInfo(Integer characterId,
                                                                                               String datasource,
                                                                                               String ifNoneMatch,
                                                                                               String token)
                                                                                        throws ApiException

Get colonies Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

ApiResponse<List<CharacterPlanetsResponse>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCharactersCharacterIdPlanetsAsync

public okhttp3.Call getCharactersCharacterIdPlanetsAsync(Integer characterId,
                                                         String datasource,
                                                         String ifNoneMatch,
                                                         String token,
                                                         ApiCallback<List<CharacterPlanetsResponse>> _callback)
                                                  throws ApiException

Get colonies (asynchronously) Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getCharactersCharacterIdPlanetsPlanetIdCall

public okhttp3.Call getCharactersCharacterIdPlanetsPlanetIdCall(Integer characterId,
                                                                Integer planetId,
                                                                String datasource,
                                                                String token,
                                                                ApiCallback _callback)
                                                         throws ApiException

Build call for getCharactersCharacterIdPlanetsPlanetId

Parameters:

characterId - An EVE character ID (required)

planetId - Planet id of the target planet (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCharactersCharacterIdPlanetsPlanetId

public CharacterPlanetResponse getCharactersCharacterIdPlanetsPlanetId(Integer characterId,
                                                                       Integer planetId,
                                                                       String datasource,
                                                                       String token)
                                                                throws ApiException

Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. --- SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - An EVE character ID (required)

planetId - Planet id of the target planet (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

Returns:

CharacterPlanetResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCharactersCharacterIdPlanetsPlanetIdWithHttpInfo

public ApiResponse<CharacterPlanetResponse> getCharactersCharacterIdPlanetsPlanetIdWithHttpInfo(Integer characterId,
                                                                                                Integer planetId,
                                                                                                String datasource,
                                                                                                String token)
                                                                                         throws ApiException

Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. --- SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - An EVE character ID (required)

planetId - Planet id of the target planet (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

Returns:

ApiResponse<CharacterPlanetResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCharactersCharacterIdPlanetsPlanetIdAsync

public okhttp3.Call getCharactersCharacterIdPlanetsPlanetIdAsync(Integer characterId,
                                                                 Integer planetId,
                                                                 String datasource,
                                                                 String token,
                                                                 ApiCallback<CharacterPlanetResponse> _callback)
                                                          throws ApiException

Get colony layout (asynchronously) Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. --- SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - An EVE character ID (required)

planetId - Planet id of the target planet (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getCorporationsCorporationIdCustomsOfficesCall

public okhttp3.Call getCorporationsCorporationIdCustomsOfficesCall(Integer corporationId,
                                                                   String datasource,
                                                                   String ifNoneMatch,
                                                                   Integer page,
                                                                   String token,
                                                                   ApiCallback _callback)
                                                            throws ApiException

Build call for getCorporationsCorporationIdCustomsOffices

Parameters:

corporationId - An EVE corporation ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

token - Access token to use if unable to set a header (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCorporationsCorporationIdCustomsOffices

public List<CorporationCustomsOfficesResponse> getCorporationsCorporationIdCustomsOffices(Integer corporationId,
                                                                                          String datasource,
                                                                                          String ifNoneMatch,
                                                                                          Integer page,
                                                                                          String token)
                                                                                   throws ApiException

List corporation customs offices List customs offices owned by a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director SSO Scope: esi-planets.read_customs_offices.v1

Parameters:

corporationId - An EVE corporation ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

token - Access token to use if unable to set a header (optional)

Returns:

List<CorporationCustomsOfficesResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCorporationsCorporationIdCustomsOfficesWithHttpInfo

public ApiResponse<List<CorporationCustomsOfficesResponse>> getCorporationsCorporationIdCustomsOfficesWithHttpInfo(Integer corporationId,
                                                                                                                   String datasource,
                                                                                                                   String ifNoneMatch,
                                                                                                                   Integer page,
                                                                                                                   String token)
                                                                                                            throws ApiException

List corporation customs offices List customs offices owned by a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director SSO Scope: esi-planets.read_customs_offices.v1

Parameters:

corporationId - An EVE corporation ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

token - Access token to use if unable to set a header (optional)

Returns:

ApiResponse<List<CorporationCustomsOfficesResponse>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCorporationsCorporationIdCustomsOfficesAsync

public okhttp3.Call getCorporationsCorporationIdCustomsOfficesAsync(Integer corporationId,
                                                                    String datasource,
                                                                    String ifNoneMatch,
                                                                    Integer page,
                                                                    String token,
                                                                    ApiCallback<List<CorporationCustomsOfficesResponse>> _callback)
                                                             throws ApiException

List corporation customs offices (asynchronously) List customs offices owned by a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director SSO Scope: esi-planets.read_customs_offices.v1

Parameters:

corporationId - An EVE corporation ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

token - Access token to use if unable to set a header (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getUniverseSchematicsSchematicIdCall

public okhttp3.Call getUniverseSchematicsSchematicIdCall(Integer schematicId,
                                                         String datasource,
                                                         String ifNoneMatch,
                                                         ApiCallback _callback)
                                                  throws ApiException

Build call for getUniverseSchematicsSchematicId

Parameters:

schematicId - A PI schematic ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUniverseSchematicsSchematicId

public PlanetFactorySchematicResponse getUniverseSchematicsSchematicId(Integer schematicId,
                                                                       String datasource,
                                                                       String ifNoneMatch)
                                                                throws ApiException

Get schematic information Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds

Parameters:

schematicId - A PI schematic ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

Returns:

PlanetFactorySchematicResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getUniverseSchematicsSchematicIdWithHttpInfo

public ApiResponse<PlanetFactorySchematicResponse> getUniverseSchematicsSchematicIdWithHttpInfo(Integer schematicId,
                                                                                                String datasource,
                                                                                                String ifNoneMatch)
                                                                                         throws ApiException

Get schematic information Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds

Parameters:

schematicId - A PI schematic ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

Returns:

ApiResponse<PlanetFactorySchematicResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getUniverseSchematicsSchematicIdAsync

public okhttp3.Call getUniverseSchematicsSchematicIdAsync(Integer schematicId,
                                                          String datasource,
                                                          String ifNoneMatch,
                                                          ApiCallback<PlanetFactorySchematicResponse> _callback)
                                                   throws ApiException

Get schematic information (asynchronously) Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds

Parameters:

schematicId - A PI schematic ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object