Interface ITemplateClient

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 interface ITemplateClient : IApiAccessor

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Methods

CreateEmbeddedRequestUrl(EmbeddedTemplateRequest)

Embedded send a document for signature using a template.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

DeleteTemplate(string, string)

Deletes a template with the given template ID.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

ApiResponse<object> EditTemplateWithHttpInfo(EditTemplateRequest editTemplate)

Parameters

editTemplate EditTemplateRequest

The edit template request.

Returns

ApiResponse<object>

A Task.

EditTemplateWithHttpInfoAsync(EditTemplateRequest)

Edit and update a template.

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

Parameters

editTemplate EditTemplateRequest

The edit template request.

Returns

Task<ApiResponse<object>>

A Task.

GetEmbeddedTemplateEditUrl(EmbeddedTemplateEditRequest)

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

MergeCreateEmbeddedRequestUrl(EmbeddedMergeTemplateRequest)

Embedded send document using multiple templates.

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.

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.

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.

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.

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.

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.

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.

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