Class TemplateClient
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.
Inheritance
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class TemplateClient : object, ITemplateClient, IApiAccessor
Constructors
| Improve this Doc View SourceTemplateClient()
Initializes a new instance of the TemplateClient class.
Declaration
public TemplateClient()
TemplateClient(ApiClient)
Initializes a new instance of the
Declaration
public TemplateClient(ApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
ApiClient | apiClient | An instance of ApiClient |
TemplateClient(Configuration)
Initializes a new instance of the TemplateClient class using Configuration object.
Declaration
public TemplateClient(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
Configuration | configuration | An instance of Configuration |
TemplateClient(String)
Initializes a new instance of the TemplateClient class.
Declaration
public TemplateClient(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |
Properties
| Improve this Doc View SourceConfiguration
Gets or sets the configuration object.
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
Configuration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
| Improve this Doc View SourceCreateEmbeddedRequestUrl(EmbeddedTemplateRequest)
Embedded send a document for signature using a template.
Declaration
public EmbeddedSendCreated CreateEmbeddedRequestUrl(EmbeddedTemplateRequest send = null)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateRequest | send | It contains page,page size and status details. |
Returns
Type | Description |
---|---|
EmbeddedSendCreated | An ApiResponse (DocumentCreated). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateEmbeddedRequestUrlAsync(EmbeddedTemplateRequest)
Embedded send a document for signature using a template.
Declaration
public async Task<EmbeddedSendCreated> CreateEmbeddedRequestUrlAsync(EmbeddedTemplateRequest send = null)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateRequest | send | It contains page,page size and status details. |
Returns
Type | Description |
---|---|
Task<EmbeddedSendCreated> | Task of ApiResponse (DocumentCreated). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public async Task<ApiResponse<EmbeddedSendCreated>> CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedTemplateRequest send = null)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateRequest | send | It contains page,page size and status details. |
Returns
Type | Description |
---|---|
Task<ApiResponse<EmbeddedSendCreated>> | Task of ApiResponse (DocumentCreated). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedTemplateRequest)
Embedded send a document for signature using a template.
Declaration
public ApiResponse<EmbeddedSendCreated> CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedTemplateRequest send = null)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateRequest | send | It contains page,page size and status details. |
Returns
Type | Description |
---|---|
ApiResponse<EmbeddedSendCreated> | An ApiResponse (DocumentCreated). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public EmbeddedTemplateCreated CreateEmbeddedTemplateUrl(CreateEmbeddedTemplateRequest createTemplate)
Parameters
Type | Name | Description |
---|---|---|
CreateEmbeddedTemplateRequest | createTemplate | The create template request. |
Returns
Type | Description |
---|---|
EmbeddedTemplateCreated | Task of ApiResponse (EmbeddedTemplateCreated). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public async Task<EmbeddedTemplateCreated> CreateEmbeddedTemplateUrlAsync(CreateEmbeddedTemplateRequest createRequest)
Parameters
Type | Name | Description |
---|---|---|
CreateEmbeddedTemplateRequest | createRequest | The create template request. |
Returns
Type | Description |
---|---|
Task<EmbeddedTemplateCreated> | Task of ApiResponse (EmbeddedTemplateCreated). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public ApiResponse<EmbeddedTemplateCreated> CreateEmbeddedTemplateUrlWithHttpInfo(CreateEmbeddedTemplateRequest createTemplate)
Parameters
Type | Name | Description |
---|---|---|
CreateEmbeddedTemplateRequest | createTemplate | The create template request. |
Returns
Type | Description |
---|---|
ApiResponse<EmbeddedTemplateCreated> | Task of ApiResponse (EmbeddedTemplateCreated). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public async Task<ApiResponse<EmbeddedTemplateCreated>> CreateEmbeddedTemplateUrlWithHttpInfoAsync(CreateEmbeddedTemplateRequest createRequest)
Parameters
Type | Name | Description |
---|---|---|
CreateEmbeddedTemplateRequest | createRequest | The create template request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<EmbeddedTemplateCreated>> | Task of ApiResponse (EmbeddedTemplateCreated). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateTemplate(CreateTemplateRequest)
Creates a template.
Declaration
public TemplateCreated CreateTemplate(CreateTemplateRequest createTemplate)
Parameters
Type | Name | Description |
---|---|---|
CreateTemplateRequest | createTemplate | The create template request. |
Returns
Type | Description |
---|---|
TemplateCreated | Template Created. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateTemplateAsync(CreateTemplateRequest)
Creates a template.
Declaration
public async Task<TemplateCreated> CreateTemplateAsync(CreateTemplateRequest createTemplate)
Parameters
Type | Name | Description |
---|---|---|
CreateTemplateRequest | createTemplate | The create template request. |
Returns
Type | Description |
---|---|
Task<TemplateCreated> | Template created. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateTemplateWithHttpInfo(CreateTemplateRequest)
Creates a template.
Declaration
public ApiResponse<TemplateCreated> CreateTemplateWithHttpInfo(CreateTemplateRequest createTemplate)
Parameters
Type | Name | Description |
---|---|---|
CreateTemplateRequest | createTemplate | The create template request. |
Returns
Type | Description |
---|---|
ApiResponse<TemplateCreated> | ApiResponse of Template created. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateTemplateWithHttpInfoAsync(CreateTemplateRequest)
Creates a template.
Declaration
public async Task<ApiResponse<TemplateCreated>> CreateTemplateWithHttpInfoAsync(CreateTemplateRequest createTemplate)
Parameters
Type | Name | Description |
---|---|---|
CreateTemplateRequest | createTemplate | The create template request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<TemplateCreated>> | ApiResponse of Template Created. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteTemplate(String)
Deletes a template with the given template ID.
Declaration
public void DeleteTemplate(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | The template id. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteTemplateAsync(String)
Deletes a template with the given template ID.
Declaration
public async Task DeleteTemplateAsync(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | The template id. |
Returns
Type | Description |
---|---|
Task | Task of void |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteTemplateAsyncWithHttpInfo(String)
Deletes a template with the given template ID.
Declaration
public async Task<ApiResponse<object>> DeleteTemplateAsyncWithHttpInfo(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | The template id. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteTemplateWithHttpInfo(String)
Deletes a template with the given template ID.
Declaration
public ApiResponse<object> DeleteTemplateWithHttpInfo(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | The template id. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DownloadTemplate(String)
Download the template for given template ID.
Declaration
public Stream DownloadTemplate(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
Stream | System.IO.Stream. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadTemplateAsync(String)
Download the template for given template ID.
Declaration
public async Task<Stream> DownloadTemplateAsync(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
Task<Stream> | Task of System.IO.Stream. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadTemplateAsyncWithHttpInfo(String)
Download the template for given template ID.
Declaration
public async Task<ApiResponse<Stream>> DownloadTemplateAsyncWithHttpInfo(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
Task<ApiResponse<Stream>> | Task of ApiResponse (System.IO.Stream). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadTemplateWithHttpInfo(String)
Download the template for given template ID.
Declaration
public ApiResponse<Stream> DownloadTemplateWithHttpInfo(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
ApiResponse<Stream> | ApiResponse of System.IO.Stream. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |
GetEmbeddedTemplateEditUrl(EmbeddedTemplateEditRequest)
Generates a edit embed URL using a template id which embeds template edit process into your application.
Declaration
public EmbeddedTemplateEdited GetEmbeddedTemplateEditUrl(EmbeddedTemplateEditRequest embedTemplateEdit)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateEditRequest | embedTemplateEdit | The embed template edit request. |
Returns
Type | Description |
---|---|
EmbeddedTemplateEdited | Task of ApiResponse (EmbeddedTemplateEdited). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public async Task<EmbeddedTemplateEdited> GetEmbeddedTemplateEditUrlAsync(EmbeddedTemplateEditRequest embeddedTemplateEditRequest)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateEditRequest | embeddedTemplateEditRequest | The embedded template edit request. |
Returns
Type | Description |
---|---|
Task<EmbeddedTemplateEdited> | Task of ApiResponse (EmbeddedTemplateEdited). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public ApiResponse<EmbeddedTemplateEdited> GetEmbeddedTemplateEditUrlWithHttpInfo(EmbeddedTemplateEditRequest embedTemplateEdit)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateEditRequest | embedTemplateEdit | The embed template edit request. |
Returns
Type | Description |
---|---|
ApiResponse<EmbeddedTemplateEdited> | Task of ApiResponse (EmbeddedTemplateEdited). |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public async Task<ApiResponse<EmbeddedTemplateEdited>> GetEmbeddedTemplateEditUrlWithHttpInfoAsync(EmbeddedTemplateEditRequest embeddedTemplateEditRequest)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedTemplateEditRequest | embeddedTemplateEditRequest | The embedded template edit request. |
Returns
Type | Description |
---|---|
Task<ApiResponse<EmbeddedTemplateEdited>> | Task of ApiResponse (EmbeddedTemplateEdited). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetProperties(String)
Get summary of the template for the given template ID.
Declaration
public TemplateProperties GetProperties(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
TemplateProperties | TemplateProperties. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetPropertiesAsync(String)
Get summary of the template for the given template ID.
Declaration
public async Task<TemplateProperties> GetPropertiesAsync(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
Task<TemplateProperties> | Task of TemplateProperties. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetPropertiesAsyncWithHttpInfo(String)
Get summary of the template for the given template ID.
Declaration
public async Task<ApiResponse<TemplateProperties>> GetPropertiesAsyncWithHttpInfo(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
Task<ApiResponse<TemplateProperties>> | Task of ApiResponse (TemplateProperties). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetPropertiesWithHttpInfo(String)
Get summary of the template for the given template ID.
Declaration
public ApiResponse<TemplateProperties> GetPropertiesWithHttpInfo(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | Template Id. |
Returns
Type | Description |
---|---|
ApiResponse<TemplateProperties> | ApiResponse of TemplateProperties. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListTemplates(Int32, Nullable<Int32>, String, Nullable<TemplateType>)
List all the templates created.
Declaration
public TemplateRecords ListTemplates(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
System.String | searchKey | |
System.Nullable<TemplateType> | templateType | Gets or sets the templateType. (optional, default to all). |
Returns
Type | Description |
---|---|
TemplateRecords | TemplateRecords |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListTemplatesAsync(Int32, Nullable<Int32>, String, Nullable<TemplateType>)
List all the templates created.
Declaration
public async Task<TemplateRecords> ListTemplatesAsync(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
System.String | searchKey | |
System.Nullable<TemplateType> | templateType | Gets or sets the templateType. (optional, default to all). |
Returns
Type | Description |
---|---|
Task<TemplateRecords> | Task of TemplateRecords |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListTemplatesAsyncWithHttpInfo(Int32, Nullable<Int32>, String, Nullable<TemplateType>)
List all the templates created.
Declaration
public async Task<ApiResponse<TemplateRecords>> ListTemplatesAsyncWithHttpInfo(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
System.String | searchKey | |
System.Nullable<TemplateType> | templateType | Gets or sets the templateType. (optional, default to all). |
Returns
Type | Description |
---|---|
Task<ApiResponse<TemplateRecords>> | Task of ApiResponse (TemplateRecords) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListTemplatesWithHttpInfo(Int32, Nullable<Int32>, String, Nullable<TemplateType>)
List all the templates created.
Declaration
public ApiResponse<TemplateRecords> ListTemplatesWithHttpInfo(int page, int? pageSize = null, string searchKey = null, TemplateType? templateType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
System.String | searchKey | |
System.Nullable<TemplateType> | templateType | Gets or sets the templateType. (optional, default to all). |
Returns
Type | Description |
---|---|
ApiResponse<TemplateRecords> | ApiResponse of TemplateRecords |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SendUsingTemplate(SendForSignFromTemplate)
Send a document for signature using a Template.
Declaration
public DocumentCreated SendUsingTemplate(SendForSignFromTemplate sendForSignFromTemplate = null)
Parameters
Type | Name | Description |
---|---|---|
SendForSignFromTemplate | sendForSignFromTemplate | It contains page,page size and status details. (optional) |
Returns
Type | Description |
---|---|
DocumentCreated | DocumentCreated |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SendUsingTemplateAsync(SendForSignFromTemplate)
Send a document for signature using a Template.
Declaration
public async Task<DocumentCreated> SendUsingTemplateAsync(SendForSignFromTemplate sendForSignFromTemplate = null)
Parameters
Type | Name | Description |
---|---|---|
SendForSignFromTemplate | sendForSignFromTemplate | It contains page,page size and status details. (optional) |
Returns
Type | Description |
---|---|
Task<DocumentCreated> | Task of DocumentCreated |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SendUsingTemplateAsyncWithHttpInfo(SendForSignFromTemplate)
Send a document for signature using a Template.
Declaration
public async Task<ApiResponse<DocumentCreated>> SendUsingTemplateAsyncWithHttpInfo(SendForSignFromTemplate sendForSignFromTemplate = null)
Parameters
Type | Name | Description |
---|---|---|
SendForSignFromTemplate | sendForSignFromTemplate | It contains page,page size and status details. (optional) |
Returns
Type | Description |
---|---|
Task<ApiResponse<DocumentCreated>> | Task of ApiResponse (DocumentCreated) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SendUsingTemplateWithHttpInfo(SendForSignFromTemplate)
Send a document for signature using a Template.
Declaration
public ApiResponse<DocumentCreated> SendUsingTemplateWithHttpInfo(SendForSignFromTemplate sendForSignFromTemplate = null)
Parameters
Type | Name | Description |
---|---|---|
SendForSignFromTemplate | sendForSignFromTemplate | It contains page,page size and status details. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<DocumentCreated> | ApiResponse of DocumentCreated |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |