Package com.hellosign.openapi.api

Class UnclaimedDraftApi

java.lang.Object

com.hellosign.openapi.api.UnclaimedDraftApi

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

Constructor Summary

Constructors

Constructor	Description
UnclaimedDraftApi()
UnclaimedDraftApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client
void	setApiClient(ApiClient apiClient)	Set the API client
UnclaimedDraftCreateResponse	unclaimedDraftCreate(UnclaimedDraftCreateRequest unclaimedDraftCreateRequest)	Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL.
UnclaimedDraftCreateResponse	unclaimedDraftCreateEmbedded(UnclaimedDraftCreateEmbeddedRequest unclaimedDraftCreateEmbeddedRequest)	Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame.
ApiResponse<UnclaimedDraftCreateResponse>	unclaimedDraftCreateEmbeddedWithHttpInfo(UnclaimedDraftCreateEmbeddedRequest unclaimedDraftCreateEmbeddedRequest)	Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame.
UnclaimedDraftCreateResponse	unclaimedDraftCreateEmbeddedWithTemplate(UnclaimedDraftCreateEmbeddedWithTemplateRequest unclaimedDraftCreateEmbeddedWithTemplateRequest)	Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame.
ApiResponse<UnclaimedDraftCreateResponse>	unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(UnclaimedDraftCreateEmbeddedWithTemplateRequest unclaimedDraftCreateEmbeddedWithTemplateRequest)	Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame.
ApiResponse<UnclaimedDraftCreateResponse>	unclaimedDraftCreateWithHttpInfo(UnclaimedDraftCreateRequest unclaimedDraftCreateRequest)	Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL.
UnclaimedDraftCreateResponse	unclaimedDraftEditAndResend(java.lang.String signatureRequestId, UnclaimedDraftEditAndResendRequest unclaimedDraftEditAndResendRequest)	Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients.
ApiResponse<UnclaimedDraftCreateResponse>	unclaimedDraftEditAndResendWithHttpInfo(java.lang.String signatureRequestId, UnclaimedDraftEditAndResendRequest unclaimedDraftEditAndResendRequest)	Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnclaimedDraftApi

public UnclaimedDraftApi()

UnclaimedDraftApi

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

unclaimedDraftCreate

public UnclaimedDraftCreateResponse unclaimedDraftCreate(UnclaimedDraftCreateRequest unclaimedDraftCreateRequest)
                                                  throws ApiException

Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.

Parameters:

unclaimedDraftCreateRequest - (required)

Returns:

UnclaimedDraftCreateResponse

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	-

unclaimedDraftCreateWithHttpInfo

public ApiResponse<UnclaimedDraftCreateResponse> unclaimedDraftCreateWithHttpInfo(UnclaimedDraftCreateRequest unclaimedDraftCreateRequest)
                                                                           throws ApiException

Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.

Parameters:

unclaimedDraftCreateRequest - (required)

Returns:

ApiResponse<UnclaimedDraftCreateResponse>

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	-

unclaimedDraftCreateEmbedded

public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbedded(UnclaimedDraftCreateEmbeddedRequest unclaimedDraftCreateEmbeddedRequest)
                                                          throws ApiException

Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.

Parameters:

unclaimedDraftCreateEmbeddedRequest - (required)

Returns:

UnclaimedDraftCreateResponse

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	-

unclaimedDraftCreateEmbeddedWithHttpInfo

public ApiResponse<UnclaimedDraftCreateResponse> unclaimedDraftCreateEmbeddedWithHttpInfo(UnclaimedDraftCreateEmbeddedRequest unclaimedDraftCreateEmbeddedRequest)
                                                                                   throws ApiException

Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.

Parameters:

unclaimedDraftCreateEmbeddedRequest - (required)

Returns:

ApiResponse<UnclaimedDraftCreateResponse>

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	-

unclaimedDraftCreateEmbeddedWithTemplate

public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbeddedWithTemplate(UnclaimedDraftCreateEmbeddedWithTemplateRequest unclaimedDraftCreateEmbeddedWithTemplateRequest)
                                                                      throws ApiException

Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.

Parameters:

unclaimedDraftCreateEmbeddedWithTemplateRequest - (required)

Returns:

UnclaimedDraftCreateResponse

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	-

unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo

public ApiResponse<UnclaimedDraftCreateResponse> unclaimedDraftCreateEmbeddedWithTemplateWithHttpInfo(UnclaimedDraftCreateEmbeddedWithTemplateRequest unclaimedDraftCreateEmbeddedWithTemplateRequest)
                                                                                               throws ApiException

Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.

Parameters:

unclaimedDraftCreateEmbeddedWithTemplateRequest - (required)

Returns:

ApiResponse<UnclaimedDraftCreateResponse>

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	-

unclaimedDraftEditAndResend

public UnclaimedDraftCreateResponse unclaimedDraftEditAndResend(java.lang.String signatureRequestId,
                                                                UnclaimedDraftEditAndResendRequest unclaimedDraftEditAndResendRequest)
                                                         throws ApiException

Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.

Parameters:

signatureRequestId - The ID of the signature request to edit and resend. (required)

unclaimedDraftEditAndResendRequest - (required)

Returns:

UnclaimedDraftCreateResponse

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	-

unclaimedDraftEditAndResendWithHttpInfo

public ApiResponse<UnclaimedDraftCreateResponse> unclaimedDraftEditAndResendWithHttpInfo(java.lang.String signatureRequestId,
                                                                                         UnclaimedDraftEditAndResendRequest unclaimedDraftEditAndResendRequest)
                                                                                  throws ApiException

Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.

Parameters:

signatureRequestId - The ID of the signature request to edit and resend. (required)

unclaimedDraftEditAndResendRequest - (required)

Returns:

ApiResponse<UnclaimedDraftCreateResponse>

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	-