Package com.hellosign.openapi.api

Class EmbeddedApi

java.lang.Object

com.hellosign.openapi.api.EmbeddedApi

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

Constructor Summary

Constructors

Constructor	Description
EmbeddedApi()
EmbeddedApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
EmbeddedEditUrlResponse	embeddedEditUrl(java.lang.String templateId, EmbeddedEditUrlRequest embeddedEditUrlRequest)	Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame.
ApiResponse<EmbeddedEditUrlResponse>	embeddedEditUrlWithHttpInfo(java.lang.String templateId, EmbeddedEditUrlRequest embeddedEditUrlRequest)	Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame.
EmbeddedSignUrlResponse	embeddedSignUrl(java.lang.String signatureId)	Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame.
ApiResponse<EmbeddedSignUrlResponse>	embeddedSignUrlWithHttpInfo(java.lang.String signatureId)	Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame.
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

EmbeddedApi

public EmbeddedApi()

EmbeddedApi

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

embeddedEditUrl

public EmbeddedEditUrlResponse embeddedEditUrl(java.lang.String templateId,
                                               EmbeddedEditUrlRequest embeddedEditUrlRequest)
                                        throws ApiException

Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.

Parameters:

templateId - The id of the template to edit. (required)

embeddedEditUrlRequest - (required)

Returns:

EmbeddedEditUrlResponse

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	-

embeddedEditUrlWithHttpInfo

public ApiResponse<EmbeddedEditUrlResponse> embeddedEditUrlWithHttpInfo(java.lang.String templateId,
                                                                        EmbeddedEditUrlRequest embeddedEditUrlRequest)
                                                                 throws ApiException

Get Embedded Template Edit URL Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.

Parameters:

templateId - The id of the template to edit. (required)

embeddedEditUrlRequest - (required)

Returns:

ApiResponse<EmbeddedEditUrlResponse>

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	-

embeddedSignUrl

public EmbeddedSignUrlResponse embeddedSignUrl(java.lang.String signatureId)
                                        throws ApiException

Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.

Parameters:

signatureId - The id of the signature to get a signature url for. (required)

Returns:

EmbeddedSignUrlResponse

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	-

embeddedSignUrlWithHttpInfo

public ApiResponse<EmbeddedSignUrlResponse> embeddedSignUrlWithHttpInfo(java.lang.String signatureId)
                                                                 throws ApiException

Get Embedded Sign URL Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.

Parameters:

signatureId - The id of the signature to get a signature url for. (required)

Returns:

ApiResponse<EmbeddedSignUrlResponse>

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	-