Package com.xero.api.client

Class IdentityApi

java.lang.Object

com.xero.api.client.IdentityApi

public class IdentityApi
extends Object

IdentityApi has methods for interacting with all endpoints in the API set

Constructor Summary

Constructors

Constructor	Description
IdentityApi()	IdentityApi
IdentityApi(ApiClient apiClient)	IdentityApi

Method Summary

Modifier and Type	Method	Description
ByteArrayInputStream	convertInputToByteArray(InputStream is)	convert intput to byte array
void	deleteConnection(String accessToken, UUID id)	Deletes a connection for this user (i.e.
com.google.api.client.http.HttpResponse	deleteConnectionForHttpResponse(String accessToken, UUID id)	Deletes a connection for this user (i.e.
ApiClient	getApiClient()	get ApiClient
List<Connection>	getConnections(String accessToken, UUID authEventId)	Retrieves the connections for this user Override the base server url that include version
com.google.api.client.http.HttpResponse	getConnectionsForHttpResponse(String accessToken, UUID authEventId)	Retrieves the connections for this user Override the base server url that include version
static IdentityApi	getInstance(ApiClient apiClient)	IdentityApi getInstance
String	getUserAgent()	get user agent
void	setApiClient(ApiClient apiClient)	set ApiClient
void	setUserAgent(String userAgent)	set user agent

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityApi

public IdentityApi()

IdentityApi

IdentityApi

public IdentityApi(ApiClient apiClient)

IdentityApi

Parameters:

apiClient - ApiClient pass into the new instance of this class

Method Detail

getInstance

public static IdentityApi getInstance(ApiClient apiClient)

IdentityApi getInstance

Parameters:

apiClient - ApiClient pass into the new instance of this class

Returns:

instance of this class

getApiClient

public ApiClient getApiClient()

get ApiClient

Returns:

apiClient the current ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

set ApiClient

Parameters:

apiClient - ApiClient pass into the new instance of this class

setUserAgent

public void setUserAgent(String userAgent)

set user agent

Parameters:

userAgent - string to override the user agent

getUserAgent

public String getUserAgent()

get user agent

Returns:

String of user agent

deleteConnection

public void deleteConnection(String accessToken,
                             UUID id)
                      throws IOException

Deletes a connection for this user (i.e. disconnect a tenant) Override the base server url that include version

204 - Success - connection has been deleted no content returned

404 - Resource not found

Parameters:

id - Unique identifier for retrieving single object

accessToken - Authorization token for user set in header of each request

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteConnectionForHttpResponse

public com.google.api.client.http.HttpResponse deleteConnectionForHttpResponse(String accessToken,
                                                                               UUID id)
                                                                        throws IOException

Deletes a connection for this user (i.e. disconnect a tenant) Override the base server url that include version

204 - Success - connection has been deleted no content returned

404 - Resource not found

Parameters:

id - Unique identifier for retrieving single object

accessToken - Authorization token for user set in header of each request

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getConnections

public List<Connection> getConnections(String accessToken,
                                       UUID authEventId)
                                throws IOException

Retrieves the connections for this user Override the base server url that include version

200 - Success - return response of type Connections array with 0 to n Connection

Parameters:

authEventId - Filter by authEventId

accessToken - Authorization token for user set in header of each request

Returns:

List<Connection>

Throws:

IOException - if an error occurs while attempting to invoke the API *

getConnectionsForHttpResponse

public com.google.api.client.http.HttpResponse getConnectionsForHttpResponse(String accessToken,
                                                                             UUID authEventId)
                                                                      throws IOException

Retrieves the connections for this user Override the base server url that include version

200 - Success - return response of type Connections array with 0 to n Connection

Parameters:

authEventId - Filter by authEventId

accessToken - Authorization token for user set in header of each request

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

convertInputToByteArray

public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException

convert intput to byte array

Parameters:

is - InputStream the server status code returned

Returns:

byteArrayInputStream a ByteArrayInputStream

Throws:

IOException - for failed or interrupted I/O operations