Package com.xero.api.client

Class AppStoreApi

java.lang.Object

com.xero.api.client.AppStoreApi

public class AppStoreApi
extends Object

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

Constructor Summary

Constructors

Constructor	Description
AppStoreApi()	AppStoreApi
AppStoreApi(ApiClient apiClient)	AppStoreApi

Method Summary

Modifier and Type	Method	Description
ByteArrayInputStream	convertInputToByteArray(InputStream is)	convert intput to byte array
ApiClient	getApiClient()	get ApiClient
static AppStoreApi	getInstance(ApiClient apiClient)	AppStoreApi getInstance
Subscription	getSubscription(String accessToken, UUID subscriptionId)	Retrieves a subscription for a given subscriptionId
com.google.api.client.http.HttpResponse	getSubscriptionForHttpResponse(String accessToken, UUID subscriptionId)	Retrieves a subscription for a given subscriptionId
UsageRecordsList	getUsageRecords(String accessToken, UUID subscriptionId)	Gets all usage records related to the subscription
com.google.api.client.http.HttpResponse	getUsageRecordsForHttpResponse(String accessToken, UUID subscriptionId)	Gets all usage records related to the subscription
String	getUserAgent()	get user agent
UsageRecord	postUsageRecords(String accessToken, UUID subscriptionId, UUID subscriptionItemId, CreateUsageRecord createUsageRecord, String idempotencyKey)	Send metered usage belonging to this subscription and subscription item
com.google.api.client.http.HttpResponse	postUsageRecordsForHttpResponse(String accessToken, UUID subscriptionId, UUID subscriptionItemId, CreateUsageRecord createUsageRecord, String idempotencyKey)	Send metered usage belonging to this subscription and subscription item
UsageRecord	putUsageRecords(String accessToken, UUID subscriptionId, UUID subscriptionItemId, UUID usageRecordId, UpdateUsageRecord updateUsageRecord, String idempotencyKey)	Update and existing metered usage belonging to this subscription and subscription item
com.google.api.client.http.HttpResponse	putUsageRecordsForHttpResponse(String accessToken, UUID subscriptionId, UUID subscriptionItemId, UUID usageRecordId, UpdateUsageRecord updateUsageRecord, String idempotencyKey)	Update and existing metered usage belonging to this subscription and subscription item
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 Details

AppStoreApi

public AppStoreApi()

AppStoreApi

AppStoreApi

public AppStoreApi(ApiClient apiClient)

AppStoreApi

Parameters:

apiClient - ApiClient pass into the new instance of this class

Method Details

getInstance

public static AppStoreApi getInstance(ApiClient apiClient)

AppStoreApi 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

getSubscription

public Subscription getSubscription(String accessToken,
 UUID subscriptionId)
                             throws IOException

Retrieves a subscription for a given subscriptionId

200 - Success - return response of unique Subscription object

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

Returns:

Subscription

Throws:

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

getSubscriptionForHttpResponse

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

Retrieves a subscription for a given subscriptionId

200 - Success - return response of unique Subscription object

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

Returns:

HttpResponse

Throws:

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

getUsageRecords

public UsageRecordsList getUsageRecords(String accessToken,
 UUID subscriptionId)
                                 throws IOException

Gets all usage records related to the subscription

200 - Success - return a list of all usage record submitted against this subscription for this subscription period

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

Returns:

UsageRecordsList

Throws:

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

getUsageRecordsForHttpResponse

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

Gets all usage records related to the subscription

200 - Success - return a list of all usage record submitted against this subscription for this subscription period

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

Returns:

HttpResponse

Throws:

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

postUsageRecords

public UsageRecord postUsageRecords(String accessToken,
 UUID subscriptionId,
 UUID subscriptionItemId,
 CreateUsageRecord createUsageRecord,
 String idempotencyKey)
                             throws IOException

Send metered usage belonging to this subscription and subscription item

200 - Success - return response of the record submitted

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

subscriptionItemId - The unique identifier of the subscriptionItem

createUsageRecord - Contains the quantity for the usage record to create

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

UsageRecord

Throws:

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

postUsageRecordsForHttpResponse

public com.google.api.client.http.HttpResponse postUsageRecordsForHttpResponse(String accessToken,
 UUID subscriptionId,
 UUID subscriptionItemId,
 CreateUsageRecord createUsageRecord,
 String idempotencyKey)
                                                                        throws IOException

Send metered usage belonging to this subscription and subscription item

200 - Success - return response of the record submitted

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

subscriptionItemId - The unique identifier of the subscriptionItem

createUsageRecord - Contains the quantity for the usage record to create

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

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

putUsageRecords

public UsageRecord putUsageRecords(String accessToken,
 UUID subscriptionId,
 UUID subscriptionItemId,
 UUID usageRecordId,
 UpdateUsageRecord updateUsageRecord,
 String idempotencyKey)
                            throws IOException

Update and existing metered usage belonging to this subscription and subscription item

200 - Success - return response of the modified record

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

subscriptionItemId - The unique identifier of the subscriptionItem

usageRecordId - The unique identifier of the usage record

updateUsageRecord - Contains the quantity for the usage record to update

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

UsageRecord

Throws:

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

putUsageRecordsForHttpResponse

public com.google.api.client.http.HttpResponse putUsageRecordsForHttpResponse(String accessToken,
 UUID subscriptionId,
 UUID subscriptionItemId,
 UUID usageRecordId,
 UpdateUsageRecord updateUsageRecord,
 String idempotencyKey)
                                                                       throws IOException

Update and existing metered usage belonging to this subscription and subscription item

200 - Success - return response of the modified record

404 - When a failure occurs in the endpoint

Parameters:

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

subscriptionId - Unique identifier for Subscription object

subscriptionItemId - The unique identifier of the subscriptionItem

usageRecordId - The unique identifier of the usage record

updateUsageRecord - Contains the quantity for the usage record to update

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

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