Package com.hellosign.openapi.api

Class BulkSendJobApi

java.lang.Object

com.hellosign.openapi.api.BulkSendJobApi

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

Constructor Summary

Constructors

Constructor	Description
BulkSendJobApi()
BulkSendJobApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BulkSendJobGetResponse	bulkSendJobGet(java.lang.String bulkSendJobId)	Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
ApiResponse<BulkSendJobGetResponse>	bulkSendJobGetWithHttpInfo(java.lang.String bulkSendJobId)	Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
BulkSendJobListResponse	bulkSendJobList(java.lang.Integer page, java.lang.Integer pageSize)	List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
ApiResponse<BulkSendJobListResponse>	bulkSendJobListWithHttpInfo(java.lang.Integer page, java.lang.Integer pageSize)	List Bulk Send Jobs Returns a list of BulkSendJob that you can access.
ApiClient	getApiClient()	Get the API client
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

BulkSendJobApi

public BulkSendJobApi()

BulkSendJobApi

public BulkSendJobApi(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

bulkSendJobGet

public BulkSendJobGetResponse bulkSendJobGet(java.lang.String bulkSendJobId)
                                      throws ApiException

Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.

Parameters:

bulkSendJobId - The id of the BulkSendJob to retrieve. (required)

Returns:

BulkSendJobGetResponse

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	-

bulkSendJobGetWithHttpInfo

public ApiResponse<BulkSendJobGetResponse> bulkSendJobGetWithHttpInfo(java.lang.String bulkSendJobId)
                                                               throws ApiException

Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.

Parameters:

bulkSendJobId - The id of the BulkSendJob to retrieve. (required)

Returns:

ApiResponse<BulkSendJobGetResponse>

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	-

bulkSendJobList

public BulkSendJobListResponse bulkSendJobList(java.lang.Integer page,
                                               java.lang.Integer pageSize)
                                        throws ApiException

List Bulk Send Jobs Returns a list of BulkSendJob that you can access.

Parameters:

page - Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20)

Returns:

BulkSendJobListResponse

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	-

bulkSendJobListWithHttpInfo

public ApiResponse<BulkSendJobListResponse> bulkSendJobListWithHttpInfo(java.lang.Integer page,
                                                                        java.lang.Integer pageSize)
                                                                 throws ApiException

List Bulk Send Jobs Returns a list of BulkSendJob that you can access.

Parameters:

page - Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20)

Returns:

ApiResponse<BulkSendJobListResponse>

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	-