Document
Document methods
Static Method Summary
| Static Public Methods | ||
| public static |
cancelFieldInvite(data: DocumentFieldInviteCancelParams, callback: function(err: ApiErrorResponse, res: DocumentFieldInviteCancelResponse)) Cancels an invite to a document |
|
| public static |
cancelFreeFormInvite(data: CancelFreeformInviteParams, callback: function(err: ApiErrorResponse, res: CancelFreeformInviteResponse)) Cancels sent freeform invite |
|
| public static |
cancelInvite(data: DocumentFieldInviteCancelParams, callback: function(err: ApiErrorResponse, res: DocumentFieldInviteCancelResponse)) this method was deprecated. use Document.cancelFieldInvite instead of this
Cancels an invite to a document |
|
| public static |
create(data: DocumentCreateParams, callback: function(err: ApiErrorResponse, res: DocumentCreateResponse)) Uploads a file and creates a document. |
|
| public static |
download(data: DocumentDownloadParams, callback: function(err: ApiErrorResponse, res: DocumentDownloadResponse)) Downloads document with embedded fields and elements. |
|
| public static |
fieldextract(data: DocumentFieldExtractParams, callback: function(err: ApiErrorResponse, res: DocumentFieldExtractResponse)) Uploads a file that contains SignNow Document Field Tags. |
|
| public static |
history(data: DocumentHistoryParams, callback: function(err: ApiErrorResponse, res: DocumentHistoryResponse)) 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, originalCallback: function(err: ApiErrorResponse, res: DocumentRemoveResponse)) Removes a specified document from folder |
|
| public static |
share(data: DocumentShareParams, callback: function(err: ApiErrorResponse, res: DocumentShareResponse)) Requests a link to download document with embedded fields and elements Link can be used once and then will expire |
|
| public static |
signers(data: DocumentSignersParams, callback: function(err: ApiErrorResponse, res: DocumentSignersResponse)) this method is experimental. this class includes breaking change.
Retrieves all signers of specific document |
|
| 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 cancelFieldInvite(data: DocumentFieldInviteCancelParams, callback: function(err: ApiErrorResponse, res: DocumentFieldInviteCancelResponse)) source
Cancels an invite to a document
Params:
| Name | Type | Attribute | Description |
| data | DocumentFieldInviteCancelParams | cancel field invite payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentFieldInviteCancelResponse) |
|
error first node.js callback |
public static cancelFreeFormInvite(data: CancelFreeformInviteParams, callback: function(err: ApiErrorResponse, res: CancelFreeformInviteResponse)) source
Cancels sent freeform invite
Params:
| Name | Type | Attribute | Description |
| data | CancelFreeformInviteParams | cancel freeform invite payload |
|
| callback | function(err: ApiErrorResponse, res: CancelFreeformInviteResponse) |
|
error first node.js callback |
public static cancelInvite(data: DocumentFieldInviteCancelParams, callback: function(err: ApiErrorResponse, res: DocumentFieldInviteCancelResponse)) source
Cancels an invite to a document
Params:
| Name | Type | Attribute | Description |
| data | DocumentFieldInviteCancelParams | cancel field invite payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentFieldInviteCancelResponse) |
|
error first node.js 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:
| Name | Type | Attribute | Description |
| data | DocumentCreateParams | create document payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentCreateResponse) |
|
error first node.js callback |
public static download(data: DocumentDownloadParams, callback: function(err: ApiErrorResponse, res: DocumentDownloadResponse)) source
Downloads document with embedded fields and elements.
By default document is downloaded without history. To download document with history set withHistory option to true.
Params:
| Name | Type | Attribute | Description |
| data | DocumentDownloadParams | download document request payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentDownloadResponse) |
|
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:
| Name | Type | Attribute | Description |
| data | DocumentFieldExtractParams | upload document with field extract payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentFieldExtractResponse) |
|
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:
| Name | Type | Attribute | Description |
| data | DocumentHistoryParams | payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentHistoryResponse) |
|
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:
| Name | Type | Attribute | Description |
| data | DocumentInviteParams | create document invite payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentInviteResponse) |
|
error first node.js callback |
public static list(data: DocumentListParams, callback: function(err: ApiErrorResponse, res: DocumentListItem)) source
Retrieve user's document list
Params:
| Name | Type | Attribute | Description |
| data | DocumentListParams | payload to receive user's document list |
|
| callback | function(err: ApiErrorResponse, res: DocumentListItem) |
|
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:
| Name | Type | Attribute | Description |
| data | DocumentMergeParams | merge documents payload |
|
| originalCallback | function(err: ApiErrorResponse, res: DocumentMergeResponse) |
|
error first node.js callback |
public static remove(data: DocumentRemoveParams, originalCallback: function(err: ApiErrorResponse, res: DocumentRemoveResponse)) source
Removes a specified document from folder
Params:
| Name | Type | Attribute | Description |
| data | DocumentRemoveParams | remove document payload |
|
| originalCallback | function(err: ApiErrorResponse, res: DocumentRemoveResponse) |
|
error first node.js callback |
public static share(data: DocumentShareParams, callback: function(err: ApiErrorResponse, res: DocumentShareResponse)) source
Requests a link to download document with embedded fields and elements Link can be used once and then will expire
Params:
| Name | Type | Attribute | Description |
| data | DocumentShareParams | share document request payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentShareResponse) |
|
error first node.js callback |
public static signers(data: DocumentSignersParams, callback: function(err: ApiErrorResponse, res: DocumentSignersResponse)) source
Retrieves all signers of specific document
Params:
| Name | Type | Attribute | Description |
| data | DocumentSignersParams | get document signers payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentSignersResponse) |
|
error first node.js 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:
| Name | Type | Attribute | Description |
| data | DocumentUpdateParams | update document request payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentUpdateResponse) |
|
error first node.js callback |
public static view(data: DocumentViewParams, callback: function(err: ApiErrorResponse, res: DocumentViewResponse)) source
Retrieves a document detailed data
Params:
| Name | Type | Attribute | Description |
| data | DocumentViewParams | view document details payload |
|
| callback | function(err: ApiErrorResponse, res: DocumentViewResponse) |
|
error first node.js callback |