Class TemplateClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as sending document sign request from template, deleting a template, listing the templates and so on.

public class TemplateClient : ITemplateClient, IApiAccessor

Inheritance

object

TemplateClient

Implements

ITemplateClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TemplateClient()

Initializes a new instance of the TemplateClient class.

public TemplateClient()

TemplateClient(ApiClient)

Initializes a new instance of the TemplateApi class using Configuration object.

public TemplateClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient

TemplateClient(Configuration)

Initializes a new instance of the TemplateClient class using Configuration object.

public TemplateClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration

TemplateClient(string)

Initializes a new instance of the TemplateClient class.

public TemplateClient(string basePath)

Parameters

basePath string

Properties

Configuration

Gets or sets the configuration object.

public Configuration Configuration { get; set; }

Property Value

Configuration

An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

ExceptionFactory

Methods

AddTag(TemplateTag)

Delete the document when a particular document’s ID is given as input.

public void AddTag(TemplateTag addTags)

Parameters

addTags TemplateTag

contains DocumentId and Label Parameter.

Exceptions

ApiException

Thrown when fails to make API call.

AddTagAsync(TemplateTag)

Add the Tag to the document when a particular document’s ID and TagNames are given as input.

public Task AddTagAsync(TemplateTag addTags)

Parameters

addTags TemplateTag

contains DocumentId and Label Parameter.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

AddTagAsyncWithHttpInfo(TemplateTag)

Adding the document's Label when a particular document’s ID and Tag Name is given as input.

public Task<ApiResponse<object>> AddTagAsyncWithHttpInfo(TemplateTag addTags)

Parameters

addTags TemplateTag

contains DocumentId and Label Parameter.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

AddTagWithHttpInfo(TemplateTag)

Adding the document's Label when a particular document’s ID and Tag Name is given as input.

public ApiResponse<object> AddTagWithHttpInfo(TemplateTag addTags)

Parameters

addTags TemplateTag

contains DocumentId and Label Parameter.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrl(EmbeddedTemplateRequest)

Embedded send a document for signature using a template.

public EmbeddedSendCreated CreateEmbeddedRequestUrl(EmbeddedTemplateRequest send = null)

Parameters

send EmbeddedTemplateRequest

It contains page,page size and status details.

Returns

EmbeddedSendCreated

An ApiResponse (DocumentCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrlAsync(EmbeddedTemplateRequest)

Embedded send a document for signature using a template.

public Task<EmbeddedSendCreated> CreateEmbeddedRequestUrlAsync(EmbeddedTemplateRequest send = null)

Parameters

send EmbeddedTemplateRequest

It contains page,page size and status details.

Returns

Task<EmbeddedSendCreated>

Task of ApiResponse (DocumentCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedTemplateRequest)

Generates a send URL using a template which embeds document sending process into your application.

public Task<ApiResponse<EmbeddedSendCreated>> CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedTemplateRequest send = null)

Parameters

send EmbeddedTemplateRequest

It contains page,page size and status details.

Returns

Task<ApiResponse<EmbeddedSendCreated>>

Task of ApiResponse (DocumentCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedTemplateRequest)

Embedded send a document for signature using a template.

public ApiResponse<EmbeddedSendCreated> CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedTemplateRequest send = null)

Parameters

send EmbeddedTemplateRequest

It contains page,page size and status details.

Returns

ApiResponse<EmbeddedSendCreated>

An ApiResponse (DocumentCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedTemplateUrl(CreateEmbeddedTemplateRequest)

Generates a create URL using a template which embeds template create process into your application.

public EmbeddedTemplateCreated CreateEmbeddedTemplateUrl(CreateEmbeddedTemplateRequest createTemplate)

Parameters

createTemplate CreateEmbeddedTemplateRequest

The create template request.

Returns

EmbeddedTemplateCreated

Task of ApiResponse (EmbeddedTemplateCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedTemplateUrlAsync(CreateEmbeddedTemplateRequest)

Generates a create URL using a template which embeds template create process into your application.

public Task<EmbeddedTemplateCreated> CreateEmbeddedTemplateUrlAsync(CreateEmbeddedTemplateRequest createRequest)

Parameters

createRequest CreateEmbeddedTemplateRequest

The create template request.

Returns

Task<EmbeddedTemplateCreated>

Task of ApiResponse (EmbeddedTemplateCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedTemplateUrlWithHttpInfo(CreateEmbeddedTemplateRequest)

Generates a create URL using a template which embeds template create process into your application.

public ApiResponse<EmbeddedTemplateCreated> CreateEmbeddedTemplateUrlWithHttpInfo(CreateEmbeddedTemplateRequest createTemplate)

Parameters

createTemplate CreateEmbeddedTemplateRequest

The create template request.

Returns

ApiResponse<EmbeddedTemplateCreated>

Task of ApiResponse (EmbeddedTemplateCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedTemplateUrlWithHttpInfoAsync(CreateEmbeddedTemplateRequest)

Generates a create URL using a template which embeds template create process into your application.

public Task<ApiResponse<EmbeddedTemplateCreated>> CreateEmbeddedTemplateUrlWithHttpInfoAsync(CreateEmbeddedTemplateRequest createRequest)

Parameters

createRequest CreateEmbeddedTemplateRequest

The create template request.

Returns

Task<ApiResponse<EmbeddedTemplateCreated>>

Task of ApiResponse (EmbeddedTemplateCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateTemplate(CreateTemplateRequest)

Creates a template.

public TemplateCreated CreateTemplate(CreateTemplateRequest createTemplate)

Parameters

createTemplate CreateTemplateRequest

The create template request.

Returns

TemplateCreated

Template Created.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTemplateAsync(CreateTemplateRequest)

Creates a template.

public Task<TemplateCreated> CreateTemplateAsync(CreateTemplateRequest createTemplate)

Parameters

createTemplate CreateTemplateRequest

The create template request.

Returns

Task<TemplateCreated>

Template created.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTemplateWithHttpInfo(CreateTemplateRequest)

Creates a template.

public ApiResponse<TemplateCreated> CreateTemplateWithHttpInfo(CreateTemplateRequest createTemplate)

Parameters

createTemplate CreateTemplateRequest

The create template request.

Returns

ApiResponse<TemplateCreated>

ApiResponse of Template created.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTemplateWithHttpInfoAsync(CreateTemplateRequest)

Creates a template.

public Task<ApiResponse<TemplateCreated>> CreateTemplateWithHttpInfoAsync(CreateTemplateRequest createTemplate)

Parameters

createTemplate CreateTemplateRequest

The create template request.

Returns

Task<ApiResponse<TemplateCreated>>

ApiResponse of Template Created.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTag(TemplateTag)

Delete the document's Tag when a particular document’s ID and Tags Names is given as input.

public void DeleteTag(TemplateTag deleteTags)

Parameters

deleteTags TemplateTag

contains DocumentId and Label Parameter.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTagAsync(TemplateTag)

Delete the document when a particular document’s ID is given as input.

public Task DeleteTagAsync(TemplateTag deleteTags)

Parameters

deleteTags TemplateTag

contains DocumentId and Label Parameter.

Returns

Task

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTagAsyncWithHttpInfo(TemplateTag)

Adding the document's Label when a particular document’s ID and Tag Name is given as input.

public Task<ApiResponse<object>> DeleteTagAsyncWithHttpInfo(TemplateTag deleteTags)

Parameters

deleteTags TemplateTag

contains DocumentId and Label Parameter.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTagWithHttpInfo(TemplateTag)

Delete the document when a particular document’s ID is given as input.

public ApiResponse<object> DeleteTagWithHttpInfo(TemplateTag deleteTags)

Parameters

deleteTags TemplateTag

contains DocumentId and Label Parameter.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTemplate(string, string)

Deletes a template with the given template ID.

public void DeleteTemplate(string templateId, string onBehalfOf = null)

Parameters

templateId string

The template id.

onBehalfOf string

The on behalf of email.

Exceptions

ApiException

Thrown when fails to make API call

DeleteTemplateAsync(string, string)

Deletes a template with the given template ID.

public Task DeleteTemplateAsync(string templateId, string onBehalfOf = null)

Parameters

templateId string

The template id.

onBehalfOf string

The on behalf of email.

Returns

Task

Task of void

Exceptions

ApiException

Thrown when fails to make API call

DeleteTemplateAsyncWithHttpInfo(string, string)

Deletes a template with the given template ID.

public Task<ApiResponse<object>> DeleteTemplateAsyncWithHttpInfo(string templateId, string onBehalfOf = null)

Parameters

templateId string

The template id.

onBehalfOf string

The on behalf of email.

Returns

Task<ApiResponse<object>>

Task of ApiResponse

Exceptions

ApiException

Thrown when fails to make API call

DeleteTemplateWithHttpInfo(string, string)

Deletes a template with the given template ID.

public ApiResponse<object> DeleteTemplateWithHttpInfo(string templateId, string onBehalfOf = null)

Parameters

templateId string

The template id.

onBehalfOf string

The on behalf of email.

Returns

ApiResponse<object>

ApiResponse of Object(void)

Exceptions

ApiException

Thrown when fails to make API call

DownloadTemplate(string, string, bool)

Download the template for given template ID.

public Stream DownloadTemplate(string templateId, string onBehalfOf = null, bool includeFormFieldValues = false)

Parameters

templateId string

Template Id.

onBehalfOf string

The on behalf of email.

includeFormFieldValues bool

Include form field data.

Returns

Stream

System.IO.Stream.

Exceptions

ApiException

Thrown when fails to make API call.

DownloadTemplateAsync(string, string, bool)

Download the template for given template ID.

public Task<Stream> DownloadTemplateAsync(string templateId, string onBehalfOf = null, bool includeFormFieldValues = false)

Parameters

templateId string

Template Id.

onBehalfOf string

The on behalf of email.

includeFormFieldValues bool

Include form field data.

Returns

Task<Stream>

Task of System.IO.Stream.

Exceptions

ApiException

Thrown when fails to make API call.

DownloadTemplateAsyncWithHttpInfo(string, string, bool)

Download the template for given template ID.

public Task<ApiResponse<Stream>> DownloadTemplateAsyncWithHttpInfo(string templateId, string onBehalfOf = null, bool includeFormFieldValues = false)

Parameters

templateId string

Template Id.

onBehalfOf string

The on behalf of email.

includeFormFieldValues bool

Include form field data.

Returns

Task<ApiResponse<Stream>>

Task of ApiResponse (System.IO.Stream).

Exceptions

ApiException

Thrown when fails to make API call.

DownloadTemplateWithHttpInfo(string, string, bool)

Download the template for given template ID.

public ApiResponse<Stream> DownloadTemplateWithHttpInfo(string templateId, string onBehalfOf = null, bool includeFormFieldValues = false)

Parameters

templateId string

Template Id.

onBehalfOf string

The on behalf of email.

includeFormFieldValues bool

Include form field data.

Returns

ApiResponse<Stream>

ApiResponse of System.IO.Stream.

Exceptions

ApiException

Thrown when fails to make API call.

EditTemplate(EditTemplateRequest)

Edit and update a template.

public void EditTemplate(EditTemplateRequest editTemplate)

Parameters

editTemplate EditTemplateRequest

The edit template request.

Exceptions

ApiException

Thrown when fails to make API call.

EditTemplateAsync(EditTemplateRequest)

Edit and update a template.

public Task EditTemplateAsync(EditTemplateRequest editTemplate)

Parameters

editTemplate EditTemplateRequest

The edit template request.

Returns

Task

A Task.

Exceptions

ApiException

Thrown when fails to make API call.

EditTemplateWithHttpInfo(EditTemplateRequest)

Edit and update a template.

public ApiResponse<object> EditTemplateWithHttpInfo(EditTemplateRequest editTemplate)

Parameters

editTemplate EditTemplateRequest

The edit template request.

Returns

ApiResponse<object>

A Task.

EditTemplateWithHttpInfoAsync(EditTemplateRequest)

Edit and update a template.

public Task<ApiResponse<object>> EditTemplateWithHttpInfoAsync(EditTemplateRequest editTemplate)

Parameters

editTemplate EditTemplateRequest

The edit template request.

Returns

Task<ApiResponse<object>>

A Task.

GetBasePath()

Gets the base path of the API client.

public string GetBasePath()

Returns

string

The base path

GetEmbeddedTemplateEditUrl(EmbeddedTemplateEditRequest)

Generates a edit embed URL using a template id which embeds template edit process into your application.

public EmbeddedTemplateEdited GetEmbeddedTemplateEditUrl(EmbeddedTemplateEditRequest embedTemplateEdit)

Parameters

embedTemplateEdit EmbeddedTemplateEditRequest

The embed template edit request.

Returns

EmbeddedTemplateEdited

Task of ApiResponse (EmbeddedTemplateEdited).

Exceptions

ApiException

Thrown when fails to make API call.

GetEmbeddedTemplateEditUrlAsync(EmbeddedTemplateEditRequest)

Generates a edit embed URL using a template id which embeds template edit process into your application.

public Task<EmbeddedTemplateEdited> GetEmbeddedTemplateEditUrlAsync(EmbeddedTemplateEditRequest embeddedTemplateEditRequest)

Parameters

embeddedTemplateEditRequest EmbeddedTemplateEditRequest

The embedded template edit request.

Returns

Task<EmbeddedTemplateEdited>

Task of ApiResponse (EmbeddedTemplateEdited).

Exceptions

ApiException

Thrown when fails to make API call.

GetEmbeddedTemplateEditUrlWithHttpInfo(EmbeddedTemplateEditRequest)

Generates a edit embed URL using a template id which embeds template edit process into your application.

public ApiResponse<EmbeddedTemplateEdited> GetEmbeddedTemplateEditUrlWithHttpInfo(EmbeddedTemplateEditRequest embedTemplateEdit)

Parameters

embedTemplateEdit EmbeddedTemplateEditRequest

The embed template edit request.

Returns

ApiResponse<EmbeddedTemplateEdited>

Task of ApiResponse (EmbeddedTemplateEdited).

Exceptions

ApiException

Thrown when fails to make API call.

GetEmbeddedTemplateEditUrlWithHttpInfoAsync(EmbeddedTemplateEditRequest)

Generates a edit embed URL using a template id which embeds template edit process into your application.

public Task<ApiResponse<EmbeddedTemplateEdited>> GetEmbeddedTemplateEditUrlWithHttpInfoAsync(EmbeddedTemplateEditRequest embeddedTemplateEditRequest)

Parameters

embeddedTemplateEditRequest EmbeddedTemplateEditRequest

The embedded template edit request.

Returns

Task<ApiResponse<EmbeddedTemplateEdited>>

Task of ApiResponse (EmbeddedTemplateEdited).

Exceptions

ApiException

Thrown when fails to make API call.

GetProperties(string)

Get summary of the template for the given template ID.

public TemplateProperties GetProperties(string templateId)

Parameters

templateId string

Template Id.

Returns

TemplateProperties

TemplateProperties.

Exceptions

ApiException

Thrown when fails to make API call.

GetPropertiesAsync(string)

Get summary of the template for the given template ID.

public Task<TemplateProperties> GetPropertiesAsync(string templateId)

Parameters

templateId string

Template Id.

Returns

Task<TemplateProperties>

Task of TemplateProperties.

Exceptions

ApiException

Thrown when fails to make API call.

GetPropertiesAsyncWithHttpInfo(string)

Get summary of the template for the given template ID.

public Task<ApiResponse<TemplateProperties>> GetPropertiesAsyncWithHttpInfo(string templateId)

Parameters

templateId string

Template Id.

Returns

Task<ApiResponse<TemplateProperties>>

Task of ApiResponse (TemplateProperties).

Exceptions

ApiException

Thrown when fails to make API call.

GetPropertiesWithHttpInfo(string)

Get summary of the template for the given template ID.

public ApiResponse<TemplateProperties> GetPropertiesWithHttpInfo(string templateId)

Parameters

templateId string

Template Id.

Returns

ApiResponse<TemplateProperties>

ApiResponse of TemplateProperties.

Exceptions

ApiException

Thrown when fails to make API call.

ListTemplates(int, int?, string, TemplateType?, List<string>, List<string>, List<string>, DateTime?, DateTime?, List<string>)

List all the templates created.

public TemplateRecords ListTemplates(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null, List<string> onBehalfOf = null, List<string> createdBy = null, List<string> templateLabels = null, DateTime? startDate = null, DateTime? endDate = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page.

pageSize int?

Gets or sets the page size. (optional, default to 10)

searchKey string

templateType TemplateType?

Gets or sets the templateType. (optional, default to all).

onBehalfOf List<string>

Gets or sets the on behalf of emails.

createdBy List<string>

Gets or sets the created by.

templateLabels List<string>

Gets or sets the template labels.

startDate DateTime?

Gets or sets the start date.

endDate DateTime?

Gets or sets the end date.

brandIds List<string>

Gets or sets the brandIds.

Returns

TemplateRecords

TemplateRecords

Exceptions

ApiException

Thrown when fails to make API call

ListTemplatesAsync(int, int?, string, TemplateType?, List<string>, List<string>, List<string>, DateTime?, DateTime?, List<string>)

List all the templates created.

public Task<TemplateRecords> ListTemplatesAsync(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null, List<string> onBehalfOf = null, List<string> createdBy = null, List<string> templateLabels = null, DateTime? startDate = null, DateTime? endDate = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page.

pageSize int?

Gets or sets the page size. (optional, default to 10)

searchKey string

templateType TemplateType?

Gets or sets the templateType. (optional, default to all).

onBehalfOf List<string>

Gets or sets the on behalf of emails.

createdBy List<string>

Gets or sets the created by.

templateLabels List<string>

Gets or sets the template labels.

startDate DateTime?

Gets or sets the start date.

endDate DateTime?

Gets or sets the end date.

brandIds List<string>

Gets or sets the brandIds.

Returns

Task<TemplateRecords>

Task of TemplateRecords

Exceptions

ApiException

Thrown when fails to make API call

ListTemplatesAsyncWithHttpInfo(int, int?, string, TemplateType?, List<string>, List<string>, List<string>, DateTime?, DateTime?, List<string>)

List all the templates created.

public Task<ApiResponse<TemplateRecords>> ListTemplatesAsyncWithHttpInfo(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null, List<string> onBehalfOf = null, List<string> createdBy = null, List<string> templateLabels = null, DateTime? startDate = null, DateTime? endDate = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page.

pageSize int?

Gets or sets the page size. (optional, default to 10)

searchKey string

templateType TemplateType?

Gets or sets the templateType. (optional, default to all).

onBehalfOf List<string>

Gets or sets the on behalf of emails.

createdBy List<string>

Gets or sets the created by.

templateLabels List<string>

Gets or sets the template labels.

startDate DateTime?

Gets or sets the start date.

endDate DateTime?

Gets or sets the end date.

brandIds List<string>

Gets or sets the brandIds.

Returns

Task<ApiResponse<TemplateRecords>>

Task of ApiResponse (TemplateRecords)

Exceptions

ApiException

Thrown when fails to make API call

ListTemplatesWithHttpInfo(int, int?, string, TemplateType?, List<string>, List<string>, List<string>, DateTime?, DateTime?, List<string>)

List all the templates created.

public ApiResponse<TemplateRecords> ListTemplatesWithHttpInfo(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null, List<string> onBehalfOf = null, List<string> createdBy = null, List<string> templateLabels = null, DateTime? startDate = null, DateTime? endDate = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page.

pageSize int?

Gets or sets the page size. (optional, default to 10)

searchKey string

templateType TemplateType?

Gets or sets the templateType. (optional, default to all).

onBehalfOf List<string>

Gets or sets the on behalf of emails.

createdBy List<string>

Gets or sets the created by.

templateLabels List<string>

Gets or sets the template labels.

startDate DateTime?

Gets or sets the start date.

endDate DateTime?

Gets or sets the end date.

brandIds List<string>

Gets or sets the brandIds.

Returns

ApiResponse<TemplateRecords>

ApiResponse of TemplateRecords

Exceptions

ApiException

Thrown when fails to make API call

MergeAndSend(MergeAndSendForSign)

Send document using multiple templates.

public DocumentCreated MergeAndSend(MergeAndSendForSign mergeAndSendForSign = null)

Parameters

mergeAndSendForSign MergeAndSendForSign

The merge and send details for sign.

Returns

DocumentCreated

DocumentCreated.

Exceptions

ApiException

Thrown when fails to make API call.

MergeAndSendAsync(MergeAndSendForSign)

Send a document for signature using a Template ids.

public Task<DocumentCreated> MergeAndSendAsync(MergeAndSendForSign mergeAndSendForSign = null)

Parameters

mergeAndSendForSign MergeAndSendForSign

The merge and send for sign details. (optional).

Returns

Task<DocumentCreated>

DocumentCreated.

Exceptions

ApiException

Thrown when fails to make API call.

MergeAndSendAsyncWithHttpInfo(MergeAndSendForSign)

Send a document for signature using a Template.

public Task<ApiResponse<DocumentCreated>> MergeAndSendAsyncWithHttpInfo(MergeAndSendForSign mergeAndSendForSign = null)

Parameters

mergeAndSendForSign MergeAndSendForSign

The merge and send for sign details. (optional).

Returns

Task<ApiResponse<DocumentCreated>>

ApiResponse of DocumentCreated.

Exceptions

ApiException

Thrown when fails to make API call.

MergeAndSendWithHttpInfo(MergeAndSendForSign)

Send document using multiple templates.

public ApiResponse<DocumentCreated> MergeAndSendWithHttpInfo(MergeAndSendForSign mergeAndSendForSign = null)

Parameters

mergeAndSendForSign MergeAndSendForSign

The merge and send details for sign.

Returns

ApiResponse<DocumentCreated>

ApiResponse of DocumentCreated.

Exceptions

ApiException

Thrown when fails to make API call.

MergeCreateEmbeddedRequestUrl(EmbeddedMergeTemplateRequest)

Embedded send document using multiple templates.

public EmbeddedSendCreated MergeCreateEmbeddedRequestUrl(EmbeddedMergeTemplateRequest mergeAndSend = null)

Parameters

mergeAndSend EmbeddedMergeTemplateRequest

It contains template id's, signer details, cc details, files, etc.

Returns

EmbeddedSendCreated

An ApiResponse (EmbeddedSendCreated).

Exceptions

ApiException

Thrown when fails to make API call.

MergeCreateEmbeddedRequestUrlAsync(EmbeddedMergeTemplateRequest)

Embedded send document using multiple templates.

public Task<EmbeddedSendCreated> MergeCreateEmbeddedRequestUrlAsync(EmbeddedMergeTemplateRequest mergeAndSend = null)

Parameters

mergeAndSend EmbeddedMergeTemplateRequest

It contains template id's, signer details, cc details, files, etc.

Returns

Task<EmbeddedSendCreated>

Task of ApiResponse (EmbeddedSendCreated).

Exceptions

ApiException

Thrown when fails to make API call.

MergeCreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedMergeTemplateRequest)

Embedded send document using multiple templates.

public Task<ApiResponse<EmbeddedSendCreated>> MergeCreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedMergeTemplateRequest mergeAndSend = null)

Parameters

mergeAndSend EmbeddedMergeTemplateRequest

It contains template id's, signer details, cc details, files, etc.

Returns

Task<ApiResponse<EmbeddedSendCreated>>

Task of ApiResponse (EmbeddedSendCreated).

Exceptions

ApiException

Thrown when fails to make API call.

MergeCreateEmbeddedRequestUrlWithHttpInfo(EmbeddedMergeTemplateRequest)

Embedded send document using multiple templates.

public ApiResponse<EmbeddedSendCreated> MergeCreateEmbeddedRequestUrlWithHttpInfo(EmbeddedMergeTemplateRequest mergeAndSend = null)

Parameters

mergeAndSend EmbeddedMergeTemplateRequest

It contains template id's, signer details, cc details, files, etc.

Returns

ApiResponse<EmbeddedSendCreated>

An ApiResponse (EmbeddedSendCreated).

Exceptions

ApiException

Thrown when fails to make API call.

SendUsingTemplate(SendForSignFromTemplate)

Send a document for signature using a Template.

public DocumentCreated SendUsingTemplate(SendForSignFromTemplate sendForSignFromTemplate = null)

Parameters

sendForSignFromTemplate SendForSignFromTemplate

It contains page,page size and status details. (optional)

Returns

DocumentCreated

DocumentCreated

Exceptions

ApiException

Thrown when fails to make API call

SendUsingTemplateAsync(SendForSignFromTemplate)

Send a document for signature using a Template.

public Task<DocumentCreated> SendUsingTemplateAsync(SendForSignFromTemplate sendForSignFromTemplate = null)

Parameters

sendForSignFromTemplate SendForSignFromTemplate

It contains page,page size and status details. (optional)

Returns

Task<DocumentCreated>

Task of DocumentCreated

Exceptions

ApiException

Thrown when fails to make API call

SendUsingTemplateAsyncWithHttpInfo(SendForSignFromTemplate)

Send a document for signature using a Template.

public Task<ApiResponse<DocumentCreated>> SendUsingTemplateAsyncWithHttpInfo(SendForSignFromTemplate sendForSignFromTemplate = null)

Parameters

sendForSignFromTemplate SendForSignFromTemplate

It contains page,page size and status details. (optional)

Returns

Task<ApiResponse<DocumentCreated>>

Task of ApiResponse (DocumentCreated)

Exceptions

ApiException

Thrown when fails to make API call

SendUsingTemplateWithHttpInfo(SendForSignFromTemplate)

Send a document for signature using a Template.

public ApiResponse<DocumentCreated> SendUsingTemplateWithHttpInfo(SendForSignFromTemplate sendForSignFromTemplate = null)

Parameters

sendForSignFromTemplate SendForSignFromTemplate

It contains page,page size and status details. (optional)

Returns

ApiResponse<DocumentCreated>

ApiResponse of DocumentCreated

Exceptions

ApiException

Thrown when fails to make API call