Package com.hellosign.openapi.api

Class ReportApi

java.lang.Object

com.hellosign.openapi.api.ReportApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class ReportApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ReportApi()
ReportApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client
ReportCreateResponse	reportCreate(ReportCreateRequest reportCreateRequest)	Create Report Request the creation of one or more report(s).
ApiResponse<ReportCreateResponse>	reportCreateWithHttpInfo(ReportCreateRequest reportCreateRequest)	Create Report Request the creation of one or more report(s).
void	setApiClient(ApiClient apiClient)	Set the API client

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportApi

public ReportApi()

ReportApi

public ReportApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client

Parameters:

apiClient - an instance of API client

reportCreate

public ReportCreateResponse reportCreate(ReportCreateRequest reportCreateRequest)
                                  throws ApiException

Create Report Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past.

Parameters:

reportCreateRequest - (required)

Returns:

ReportCreateResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

reportCreateWithHttpInfo

public ApiResponse<ReportCreateResponse> reportCreateWithHttpInfo(ReportCreateRequest reportCreateRequest)
                                                           throws ApiException

Create Report Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past.

Parameters:

reportCreateRequest - (required)

Returns:

ApiResponse<ReportCreateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-