import Template from '@signnow/api-client/lib/template/index.js'

public class | source

Template

Template methods

Static Method Summary

Static Public Methods
public static	bulkInvite(data: TemplateBulkInviteParams, callback: function(err: ApiErrorResponse, res: TemplateBulkInviteResponse)) this method is experimental. internal implementation of this method might be changed Sends invites to sign a specified template to multiple signers at once
public static	create(data: TemplateCreateParams, originalCallback: function(err: ApiErrorResponse, res: TemplateCreateResponse)) Creates a template by copying an existing unfulfilled and not requested for sign document.
public static	duplicate(data: TemplateDuplicateParams, callback: function(err: ApiErrorResponse, res: TemplateDuplicateResponse)) Creates a new document by copying a template.
public static	getRoutingDetails(data: TemplateGetRoutingDetailsParams, callback: function(err: ApiErrorResponse, res: TemplateGetRoutingDetailsResponse)) Retrieves Routing Details of specified Template
public static	invite(data: TemplateInviteParams, callback: function(err: ApiErrorResponse, res: TemplateInviteResponse)) Creates an invite to sign a template.
public static	remove(data: TemplateRemoveParams, callback: function(err: ApiErrorResponse, res: TemplateRemoveResponse)) Removes a specified template from folder
public static	updateRoutingDetails(data: TemplateUpdateRoutingDetailsParams, callback: function(err: ApiErrorResponse, res: TemplateUpdateRoutingDetailsResponse)) Updates Routing Details of specified template

Static Public Methods

public static bulkInvite(data: TemplateBulkInviteParams, callback: function(err: ApiErrorResponse, res: TemplateBulkInviteResponse)) source

this method is experimental. internal implementation of this method might be changed

Sends invites to sign a specified template to multiple signers at once

Params:

Name	Type	Attribute	Description
data	TemplateBulkInviteParams		Bulk Invite payload
callback	function(err: ApiErrorResponse, res: TemplateBulkInviteResponse)	optional	error first node.js callback

public static create(data: TemplateCreateParams, originalCallback: function(err: ApiErrorResponse, res: TemplateCreateResponse)) source

Creates a template by copying an existing unfulfilled and not requested for sign document. By default original document is not removed after template creation. To remove original document set removeOriginalDocument option to true.

Params:

Name	Type	Attribute	Description
data	TemplateCreateParams		create template payload
originalCallback	function(err: ApiErrorResponse, res: TemplateCreateResponse)	optional	error first node.js callback

public static duplicate(data: TemplateDuplicateParams, callback: function(err: ApiErrorResponse, res: TemplateDuplicateResponse)) source

Creates a new document by copying a template. If a name is not supplied then document name will be set to the original template's name by default.

Params:

Name	Type	Attribute	Description
data	TemplateDuplicateParams		duplicate template payload
callback	function(err: ApiErrorResponse, res: TemplateDuplicateResponse)	optional	error first node.js callback

public static getRoutingDetails(data: TemplateGetRoutingDetailsParams, callback: function(err: ApiErrorResponse, res: TemplateGetRoutingDetailsResponse)) source

Retrieves Routing Details of specified Template

Params:

Name	Type	Attribute	Description
data	TemplateGetRoutingDetailsParams		get Routing Details payload
callback	function(err: ApiErrorResponse, res: TemplateGetRoutingDetailsResponse)	optional	error first node.js callback

public static invite(data: TemplateInviteParams, callback: function(err: ApiErrorResponse, res: TemplateInviteResponse)) source

Creates an invite to sign a template. You can create a simple free form invite(s) or a role-based invite(s). The method copies a template into document and creates an invite using created document.

Params:

Name	Type	Attribute	Description
data	TemplateInviteParams		create template invite payload
callback	function(err: ApiErrorResponse, res: TemplateInviteResponse)	optional	error first node.js callback

public static remove(data: TemplateRemoveParams, callback: function(err: ApiErrorResponse, res: TemplateRemoveResponse)) source

Removes a specified template from folder

Params:

Name	Type	Attribute	Description
data	TemplateRemoveParams		remove template payload
callback	function(err: ApiErrorResponse, res: TemplateRemoveResponse)	optional	error first node.js callback

public static updateRoutingDetails(data: TemplateUpdateRoutingDetailsParams, callback: function(err: ApiErrorResponse, res: TemplateUpdateRoutingDetailsResponse)) source

Updates Routing Details of specified template

Params:

Name	Type	Attribute	Description
data	TemplateUpdateRoutingDetailsParams		update Template Routing Details payload
callback	function(err: ApiErrorResponse, res: TemplateUpdateRoutingDetailsResponse)	optional	error first node.js callback