Api

Class ReportSubscriptionsApi

java.lang.Object

Api.ReportSubscriptionsApi

public class ReportSubscriptionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ReportSubscriptionsApi()
ReportSubscriptionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	createSubscription(RequestBody requestBody) Create Report Subscription for a report name by organization
com.squareup.okhttp.Call	createSubscriptionAsync(String reportName, RequestBody requestBody, ApiCallback<Void> callback) Create Report Subscription for a report name by organization (asynchronously)
com.squareup.okhttp.Call	createSubscriptionCall(RequestBody requestBody, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createSubscription
ApiResponse<Void>	createSubscriptionWithHttpInfo(RequestBody requestBody) Create Report Subscription for a report name by organization
void	deleteSubscription(String reportName) Delete subscription of a report name by organization
com.squareup.okhttp.Call	deleteSubscriptionAsync(String reportName, ApiCallback<Void> callback) Delete subscription of a report name by organization (asynchronously)
com.squareup.okhttp.Call	deleteSubscriptionCall(String reportName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteSubscription
ApiResponse<Void>	deleteSubscriptionWithHttpInfo(String reportName) Delete subscription of a report name by organization
ReportingV3ReportSubscriptionsGet200Response	getAllSubscriptions() Retrieve all subscriptions by organization
com.squareup.okhttp.Call	getAllSubscriptionsAsync(ApiCallback<ReportingV3ReportSubscriptionsGet200Response> callback) Retrieve all subscriptions by organization (asynchronously)
com.squareup.okhttp.Call	getAllSubscriptionsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllSubscriptions
ApiResponse<ReportingV3ReportSubscriptionsGet200Response>	getAllSubscriptionsWithHttpInfo() Retrieve all subscriptions by organization
ApiClient	getApiClient()
ReportingV3ReportSubscriptionsGet200Response	getSubscription(String reportName) Retrieve subscription for a report name by organization
com.squareup.okhttp.Call	getSubscriptionAsync(String reportName, ApiCallback<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> callback) Retrieve subscription for a report name by organization (asynchronously)
com.squareup.okhttp.Call	getSubscriptionCall(String reportName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSubscription
ApiResponse<ReportingV3ReportSubscriptionsGet200Response>	getSubscriptionWithHttpInfo(String reportName) Retrieve subscription for a report name by organization
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportSubscriptionsApi

public ReportSubscriptionsApi()

ReportSubscriptionsApi

public ReportSubscriptionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSubscriptionCall

public com.squareup.okhttp.Call createSubscriptionCall(RequestBody requestBody,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for createSubscription

Parameters:

requestBody - Report subscription request payload (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createSubscription

public void createSubscription(RequestBody requestBody)
                        throws ApiException

Create Report Subscription for a report name by organization

Parameters:

requestBody - Report subscription request payload (required)

Throws:

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

createSubscriptionWithHttpInfo

public ApiResponse<Void> createSubscriptionWithHttpInfo(RequestBody requestBody)
                                                 throws ApiException

Create Report Subscription for a report name by organization

Parameters:

requestBody - Report subscription request payload (required)

Returns:

ApiResponse<Void>

Throws:

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

createSubscriptionAsync

public com.squareup.okhttp.Call createSubscriptionAsync(String reportName,
                                                        RequestBody requestBody,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException

Create Report Subscription for a report name by organization (asynchronously)

Parameters:

reportName - Name(required)

requestBody - Report subscription request payload (required)

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

deleteSubscriptionCall

public com.squareup.okhttp.Call deleteSubscriptionCall(String reportName,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for deleteSubscription

Parameters:

reportName - Name of the Report to Delete (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteSubscription

public void deleteSubscription(String reportName)
                        throws ApiException

Delete subscription of a report name by organization

Parameters:

reportName - Name of the Report to Delete (required)

Throws:

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

deleteSubscriptionWithHttpInfo

public ApiResponse<Void> deleteSubscriptionWithHttpInfo(String reportName)
                                                 throws ApiException

Delete subscription of a report name by organization

Parameters:

reportName - Name of the Report to Delete (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteSubscriptionAsync

public com.squareup.okhttp.Call deleteSubscriptionAsync(String reportName,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException

Delete subscription of a report name by organization (asynchronously)

Parameters:

reportName - Name of the Report to Delete (required)

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

getAllSubscriptionsCall

public com.squareup.okhttp.Call getAllSubscriptionsCall(ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for getAllSubscriptions

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllSubscriptions

public ReportingV3ReportSubscriptionsGet200Response getAllSubscriptions()
                                                                 throws ApiException

Retrieve all subscriptions by organization

Returns:

ReportingV3ReportSubscriptionsGet200Response

Throws:

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

getAllSubscriptionsWithHttpInfo

public ApiResponse<ReportingV3ReportSubscriptionsGet200Response> getAllSubscriptionsWithHttpInfo()
                                                                                          throws ApiException

Retrieve all subscriptions by organization

Returns:

ApiResponse<ReportingV3ReportSubscriptionsGet200Response>

Throws:

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

getAllSubscriptionsAsync

public com.squareup.okhttp.Call getAllSubscriptionsAsync(ApiCallback<ReportingV3ReportSubscriptionsGet200Response> callback)
                                                  throws ApiException

Retrieve all subscriptions by organization (asynchronously)

Parameters:

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

getSubscriptionCall

public com.squareup.okhttp.Call getSubscriptionCall(String reportName,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getSubscription

Parameters:

reportName - Name of the Report to Retrieve (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSubscription

public ReportingV3ReportSubscriptionsGet200Response getSubscription(String reportName)
                                                             throws ApiException

Retrieve subscription for a report name by organization

Parameters:

reportName - Name of the Report to Retrieve (required)

Returns:

ReportingV3ReportSubscriptionsGet200ResponseSubscriptions

Throws:

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

getSubscriptionWithHttpInfo

public ApiResponse<ReportingV3ReportSubscriptionsGet200Response> getSubscriptionWithHttpInfo(String reportName)
                                                                                      throws ApiException

Retrieve subscription for a report name by organization

Parameters:

reportName - Name of the Report to Retrieve (required)

Returns:

ApiResponse<ReportingV3ReportSubscriptionsGet200Response>

Throws:

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

getSubscriptionAsync

public com.squareup.okhttp.Call getSubscriptionAsync(String reportName,
                                                     ApiCallback<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> callback)
                                              throws ApiException

Retrieve subscription for a report name by organization (asynchronously)

Parameters:

reportName - Name of the Report to Retrieve (required)

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