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	createStandardOrClassicSubscription(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean, String organizationId) Create a Standard or Classic Subscription Create or update an already existing classic or standard subscription.
okhttp3.Call	createStandardOrClassicSubscriptionAsync(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean, String organizationId, ApiCallback<Void> callback) Create a Standard or Classic Subscription (asynchronously) Create or update an already existing classic or standard subscription.
okhttp3.Call	createStandardOrClassicSubscriptionCall(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createStandardOrClassicSubscription
ApiResponse<Void>	createStandardOrClassicSubscriptionWithHttpInfo(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean, String organizationId) Create a Standard or Classic Subscription Create or update an already existing classic or standard subscription.
void	createSubscription(CreateReportSubscriptionRequest createReportSubscriptionRequest, String organizationId) Create Report Subscription for a Report Name by Organization Create a report subscription for your organization.
okhttp3.Call	createSubscriptionAsync(CreateReportSubscriptionRequest createReportSubscriptionRequest, String organizationId, ApiCallback<Void> callback) Create Report Subscription for a Report Name by Organization (asynchronously) Create a report subscription for your organization.
okhttp3.Call	createSubscriptionCall(CreateReportSubscriptionRequest createReportSubscriptionRequest, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createSubscription
ApiResponse<Void>	createSubscriptionWithHttpInfo(CreateReportSubscriptionRequest createReportSubscriptionRequest, String organizationId) Create Report Subscription for a Report Name by Organization Create a report subscription for your organization.
void	deleteSubscription(String reportName, String organizationId) Delete Subscription of a Report Name by Organization Delete a report subscription for your organization.
okhttp3.Call	deleteSubscriptionAsync(String reportName, String organizationId, ApiCallback<Void> callback) Delete Subscription of a Report Name by Organization (asynchronously) Delete a report subscription for your organization.
okhttp3.Call	deleteSubscriptionCall(String reportName, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteSubscription
ApiResponse<Void>	deleteSubscriptionWithHttpInfo(String reportName, String organizationId) Delete Subscription of a Report Name by Organization Delete a report subscription for your organization.
ReportingV3ReportSubscriptionsGet200Response	getAllSubscriptions(String organizationId) Get All Subscriptions View a summary of all report subscriptions.
okhttp3.Call	getAllSubscriptionsAsync(String organizationId, ApiCallback<ReportingV3ReportSubscriptionsGet200Response> callback) Get All Subscriptions (asynchronously) View a summary of all report subscriptions.
okhttp3.Call	getAllSubscriptionsCall(String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllSubscriptions
ApiResponse<ReportingV3ReportSubscriptionsGet200Response>	getAllSubscriptionsWithHttpInfo(String organizationId) Get All Subscriptions View a summary of all report subscriptions.
ApiClient	getApiClient()
ReportingV3ReportSubscriptionsGet200ResponseSubscriptions	getSubscription(String reportName, String organizationId) Get Subscription for Report Name View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
okhttp3.Call	getSubscriptionAsync(String reportName, String organizationId, ApiCallback<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> callback) Get Subscription for Report Name (asynchronously) View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
okhttp3.Call	getSubscriptionCall(String reportName, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSubscription
ApiResponse<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions>	getSubscriptionWithHttpInfo(String reportName, String organizationId) Get Subscription for Report Name View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
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)

createStandardOrClassicSubscriptionCall

public okhttp3.Call createStandardOrClassicSubscriptionCall(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
                                                            String organizationId,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for createStandardOrClassicSubscription

Parameters:

predefinedSubscriptionRequestBean - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createStandardOrClassicSubscription

public void createStandardOrClassicSubscription(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
                                                String organizationId)
                                         throws ApiException

Create a Standard or Classic Subscription Create or update an already existing classic or standard subscription.

Parameters:

predefinedSubscriptionRequestBean - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

Throws:

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

createStandardOrClassicSubscriptionWithHttpInfo

public ApiResponse<Void> createStandardOrClassicSubscriptionWithHttpInfo(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
                                                                         String organizationId)
                                                                  throws ApiException

Create a Standard or Classic Subscription Create or update an already existing classic or standard subscription.

Parameters:

predefinedSubscriptionRequestBean - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<Void>

Throws:

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

createStandardOrClassicSubscriptionAsync

public okhttp3.Call createStandardOrClassicSubscriptionAsync(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
                                                             String organizationId,
                                                             ApiCallback<Void> callback)
                                                      throws ApiException

Create a Standard or Classic Subscription (asynchronously) Create or update an already existing classic or standard subscription.

Parameters:

predefinedSubscriptionRequestBean - Report subscription request payload (required)

organizationId - Valid Organization Id (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

createSubscriptionCall

public okhttp3.Call createSubscriptionCall(CreateReportSubscriptionRequest createReportSubscriptionRequest,
                                           String organizationId,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for createSubscription

Parameters:

createReportSubscriptionRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

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(CreateReportSubscriptionRequest createReportSubscriptionRequest,
                               String organizationId)
                        throws ApiException

Create Report Subscription for a Report Name by Organization Create a report subscription for your organization. The report name must be unique.

Parameters:

createReportSubscriptionRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

Throws:

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

createSubscriptionWithHttpInfo

public ApiResponse<Void> createSubscriptionWithHttpInfo(CreateReportSubscriptionRequest createReportSubscriptionRequest,
                                                        String organizationId)
                                                 throws ApiException

Create Report Subscription for a Report Name by Organization Create a report subscription for your organization. The report name must be unique.

Parameters:

createReportSubscriptionRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<Void>

Throws:

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

createSubscriptionAsync

public okhttp3.Call createSubscriptionAsync(CreateReportSubscriptionRequest createReportSubscriptionRequest,
                                            String organizationId,
                                            ApiCallback<Void> callback)
                                     throws ApiException

Create Report Subscription for a Report Name by Organization (asynchronously) Create a report subscription for your organization. The report name must be unique.

Parameters:

createReportSubscriptionRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (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

deleteSubscriptionCall

public okhttp3.Call deleteSubscriptionCall(String reportName,
                                           String organizationId,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for deleteSubscription

Parameters:

reportName - Name of the Report to Delete (required)

organizationId - Valid Organization Id (optional)

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,
                               String organizationId)
                        throws ApiException

Delete Subscription of a Report Name by Organization Delete a report subscription for your organization. You must know the unique name of the report you want to delete.

Parameters:

reportName - Name of the Report to Delete (required)

organizationId - Valid Organization Id (optional)

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,
                                                        String organizationId)
                                                 throws ApiException

Delete Subscription of a Report Name by Organization Delete a report subscription for your organization. You must know the unique name of the report you want to delete.

Parameters:

reportName - Name of the Report to Delete (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<Void>

Throws:

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

deleteSubscriptionAsync

public okhttp3.Call deleteSubscriptionAsync(String reportName,
                                            String organizationId,
                                            ApiCallback<Void> callback)
                                     throws ApiException

Delete Subscription of a Report Name by Organization (asynchronously) Delete a report subscription for your organization. You must know the unique name of the report you want to delete.

Parameters:

reportName - Name of the Report to Delete (required)

organizationId - Valid Organization Id (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

getAllSubscriptionsCall

public okhttp3.Call getAllSubscriptionsCall(String organizationId,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getAllSubscriptions

Parameters:

organizationId - Valid Organization Id (optional)

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(String organizationId)
                                                                 throws ApiException

Get All Subscriptions View a summary of all report subscriptions.

Parameters:

organizationId - Valid Organization Id (optional)

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(String organizationId)
                                                                                          throws ApiException

Get All Subscriptions View a summary of all report subscriptions.

Parameters:

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<ReportingV3ReportSubscriptionsGet200Response>

Throws:

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

getAllSubscriptionsAsync

public okhttp3.Call getAllSubscriptionsAsync(String organizationId,
                                             ApiCallback<ReportingV3ReportSubscriptionsGet200Response> callback)
                                      throws ApiException

Get All Subscriptions (asynchronously) View a summary of all report subscriptions.

Parameters:

organizationId - Valid Organization Id (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

getSubscriptionCall

public okhttp3.Call getSubscriptionCall(String reportName,
                                        String organizationId,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException

Build call for getSubscription

Parameters:

reportName - Name of the Report to Retrieve (required)

organizationId - Valid Organization Id (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSubscription

public ReportingV3ReportSubscriptionsGet200ResponseSubscriptions getSubscription(String reportName,
                                                                                 String organizationId)
                                                                          throws ApiException

Get Subscription for Report Name View the details of a report subscription, such as the report format or report frequency, using the report's unique name.

Parameters:

reportName - Name of the Report to Retrieve (required)

organizationId - Valid Organization Id (optional)

Returns:

ReportingV3ReportSubscriptionsGet200ResponseSubscriptions

Throws:

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

getSubscriptionWithHttpInfo

public ApiResponse<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> getSubscriptionWithHttpInfo(String reportName,
                                                                                                          String organizationId)
                                                                                                   throws ApiException

Get Subscription for Report Name View the details of a report subscription, such as the report format or report frequency, using the report's unique name.

Parameters:

reportName - Name of the Report to Retrieve (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions>

Throws:

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

getSubscriptionAsync

public okhttp3.Call getSubscriptionAsync(String reportName,
                                         String organizationId,
                                         ApiCallback<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> callback)
                                  throws ApiException

Get Subscription for Report Name (asynchronously) View the details of a report subscription, such as the report format or report frequency, using the report's unique name.

Parameters:

reportName - Name of the Report to Retrieve (required)

organizationId - Valid Organization Id (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