import DocumentGroup from '@signnow/api-client/lib/document-group/index.js'

public class | source

DocumentGroup

Document Group methods

Static Method Summary

Static Public Methods
public static	cancelInvite(data: DocumentGroupCancelInviteParams, callback: function(err: ApiErrorResponse, res: DocumentGroupCancelInviteResponse)) Cancels an Invite to sign a specific Document Group
public static	create(data: DocumentGroupCreateParams, callback: function(err: ApiErrorResponse, res: DocumentGroupCreateResponse)) Creates document group with specified documents or templates.
public static	download(data: DocumentGroupDownloadParams, callback: function(err: ApiErrorResponse, res: DocumentGroupDownloadResponse)) Downloads a document group.
public static	invite(data: DocumentGroupInviteParams, callback: function(err: ApiErrorResponse, res: DocumentGroupInviteResponse)) Creates an invite to sign a Document Group
public static	view(data: DocumentGroupViewParams, callback: function(err: ApiErrorResponse, res: DocumentGroupViewResponse)) Retrieves a Document Group detailed data

Static Public Methods

public static cancelInvite(data: DocumentGroupCancelInviteParams, callback: function(err: ApiErrorResponse, res: DocumentGroupCancelInviteResponse)) source

Cancels an Invite to sign a specific Document Group

Params:

Name	Type	Attribute	Description
data	DocumentGroupCancelInviteParams		cancel Document Group Invite payload
callback	function(err: ApiErrorResponse, res: DocumentGroupCancelInviteResponse)	optional	error first node.js callback

public static create(data: DocumentGroupCreateParams, callback: function(err: ApiErrorResponse, res: DocumentGroupCreateResponse)) source

Creates document group with specified documents or templates. At least one document or template must contain fields. Documents should not contain pending invites.

Params:

Name	Type	Attribute	Description
data	DocumentGroupCreateParams		create document group payload
callback	function(err: ApiErrorResponse, res: DocumentGroupCreateResponse)	optional	error first node.js callback

public static download(data: DocumentGroupDownloadParams, callback: function(err: ApiErrorResponse, res: DocumentGroupDownloadResponse)) source

Downloads a document group. By default document group will be downloaded as a zip archive and without history. To download document group as a single merged PDF set type to merged. To download document group with history set with_history to after_each_document or after_merged_pdf.

Params:

Name	Type	Attribute	Description
data	DocumentGroupDownloadParams		download Document Group request payload
callback	function(err: ApiErrorResponse, res: DocumentGroupDownloadResponse)	optional	error first node.js callback

public static invite(data: DocumentGroupInviteParams, callback: function(err: ApiErrorResponse, res: DocumentGroupInviteResponse)) source

Creates an invite to sign a Document Group

Params:

Name	Type	Attribute	Description
data	DocumentGroupInviteParams		create Document Group invite payload
callback	function(err: ApiErrorResponse, res: DocumentGroupInviteResponse)	optional	error first node.js callback

public static view(data: DocumentGroupViewParams, callback: function(err: ApiErrorResponse, res: DocumentGroupViewResponse)) source

Retrieves a Document Group detailed data

Params:

Name	Type	Attribute	Description
data	DocumentGroupViewParams		view Document Group details payload
callback	function(err: ApiErrorResponse, res: DocumentGroupViewResponse)	optional	error first node.js callback