Reference Source Test 
import Document from '@signnow/api-client/lib/document.js'
public class | source

Document

Document methods

Static Method Summary

Static Public Methods
public static

cancelInvite(objectPattern: {"id": *, "token": *}, callback: *)

public static

create(data: DocumentCreateParams, callback: function(err: ApiErrorResponse, res: DocumentCreateResponse))

Uploads a file and creates a document.
public static

Downloads document with embedded fields and elements
public static

Uploads a file that contains SignNow Document Field Tags.
public static

Retrieves a document action log (history) data
public static

invite(data: DocumentInviteParams, callback: function(err: ApiErrorResponse, res: DocumentInviteResponse))

Creates an invite to sign a document.
public static

list(data: DocumentListParams, callback: function(err: ApiErrorResponse, res: DocumentListItem))

Retrieve user's document list
public static

merge(data: DocumentMergeParams, originalCallback: function(err: ApiErrorResponse, res: DocumentMergeResponse))

Merges existing documents into one.
public static

remove(data: DocumentRemoveParams, callback: function(err: ApiErrorResponse, res: DocumentRemoveResponse))

Removes a specified document from folder
public static

share(objectPattern: {"id": *, "token": *}, callback: *)

public static

update(data: DocumentUpdateParams, callback: function(err: ApiErrorResponse, res: DocumentUpdateResponse))

Updates an existing document.
public static

view(data: DocumentViewParams, callback: function(err: ApiErrorResponse, res: DocumentViewResponse))

Retrieves a document detailed data

Static Public Methods

public static cancelInvite(objectPattern: {"id": *, "token": *}, callback: *) source

Params:

NameTypeAttributeDescription
objectPattern {"id": *, "token": *}
  • default: {"id":null,"token":null}
callback *

public static create(data: DocumentCreateParams, callback: function(err: ApiErrorResponse, res: DocumentCreateResponse)) source

Uploads a file and creates a document. This endpoint accepts .pdf, .doc, .docx, .odt, .rtf, .png, .jpg, .jpeg, .gif, .bmp, .xml, .xls, .xlsx, .ppt, .pptx file types

Params:

NameTypeAttributeDescription
data DocumentCreateParams

create document payload
callback function(err: ApiErrorResponse, res: DocumentCreateResponse)
  • optional

error first node.js callback

public static download(data: DocumentDownloadParams, callback: function(err: ApiErrorResponse, res: DocumentDownloadResponse)) source

Downloads document with embedded fields and elements

Params:

NameTypeAttributeDescription
data DocumentDownloadParams

download document request payload
callback function(err: ApiErrorResponse, res: DocumentDownloadResponse)
  • optional

error first node.js callback

public static fieldextract(data: DocumentFieldExtractParams, callback: function(err: ApiErrorResponse, res: DocumentFieldExtractResponse)) source

Uploads a file that contains SignNow Document Field Tags. This endpoint only accepts .pdf (you may convert the document from .doc or .docx to .pdf)

Params:

NameTypeAttributeDescription
data DocumentFieldExtractParams

upload document with field extract payload
callback function(err: ApiErrorResponse, res: DocumentFieldExtractResponse)
  • optional

error first node.js callback

public static history(data: DocumentHistoryParams, callback: function(err: ApiErrorResponse, res: DocumentHistoryResponse)) source

Retrieves a document action log (history) data

Params:

NameTypeAttributeDescription
data DocumentHistoryParams

payload
callback function(err: ApiErrorResponse, res: DocumentHistoryResponse)
  • optional

error first node.js callback

public static invite(data: DocumentInviteParams, callback: function(err: ApiErrorResponse, res: DocumentInviteResponse)) source

Creates an invite to sign a document. You can create a simple free form invite(s) or a role-based invite(s).

Params:

NameTypeAttributeDescription
data DocumentInviteParams

create document invite payload
callback function(err: ApiErrorResponse, res: DocumentInviteResponse)
  • optional

error first node.js callback

public static list(data: DocumentListParams, callback: function(err: ApiErrorResponse, res: DocumentListItem)) source

Retrieve user's document list

Params:

NameTypeAttributeDescription
data DocumentListParams

payload to receive user's document list
callback function(err: ApiErrorResponse, res: DocumentListItem)
  • optional

error first node.js callback

public static merge(data: DocumentMergeParams, originalCallback: function(err: ApiErrorResponse, res: DocumentMergeResponse)) source

Merges existing documents into one. By default original documents are not removed after merging. To remove original documents set removeOriginalDocuments option to true.

Params:

NameTypeAttributeDescription
data DocumentMergeParams

merge documents payload
originalCallback function(err: ApiErrorResponse, res: DocumentMergeResponse)
  • optional

error first node.js callback

public static remove(data: DocumentRemoveParams, callback: function(err: ApiErrorResponse, res: DocumentRemoveResponse)) source

Removes a specified document from folder

Params:

NameTypeAttributeDescription
data DocumentRemoveParams

remove document payload
callback function(err: ApiErrorResponse, res: DocumentRemoveResponse)
  • optional

error first node.js callback

public static share(objectPattern: {"id": *, "token": *}, callback: *) source

Params:

NameTypeAttributeDescription
objectPattern {"id": *, "token": *}
  • default: {"id":null,"token":null}
callback *

public static update(data: DocumentUpdateParams, callback: function(err: ApiErrorResponse, res: DocumentUpdateResponse)) source

Updates an existing document. Adds fields (signature, text, initials, checkbox, radiobutton group, calculated) and elements (signature, text, check). Every call of this method will add only specified fields into document. Old fields will be removed

Params:

NameTypeAttributeDescription
data DocumentUpdateParams

update document request payload
callback function(err: ApiErrorResponse, res: DocumentUpdateResponse)
  • optional

error first node.js callback

public static view(data: DocumentViewParams, callback: function(err: ApiErrorResponse, res: DocumentViewResponse)) source

Retrieves a document detailed data

Params:

NameTypeAttributeDescription
data DocumentViewParams

view document details payload
callback function(err: ApiErrorResponse, res: DocumentViewResponse)
  • optional

error first node.js callback