Skip to main content

Class: DocumentManager

Extends

Constructors

Constructor

new DocumentManager(transport, defaultFormat?): DocumentManager

Parameters

Returns

DocumentManager

Inherited from

BaseManager.constructor

Methods

create()

create(params, options?): Promise<any>
Create a document from a previously direct-uploaded blob.

Parameters

Returns

Promise<any>

delete()

delete(id, options?): Promise<any>
Delete a document.

Parameters

Returns

Promise<any>

downloadUrl()

downloadUrl(id, options?): Promise<any>
Get a short-lived download URL for a document’s file.

Parameters

Returns

Promise<any>

get()

get(id, options?): Promise<any>
Fetch a document by ID.

Parameters

Returns

Promise<any>

list()

list(filters?, options?): Promise<any>
List documents with optional filters and pagination.

Parameters

Returns

Promise<any>

reclassify()

reclassify(id, options?): Promise<any>
Re-run classification on a document.

Parameters

Returns

Promise<any>

reextract()

reextract(id, options?): Promise<any>
Re-run data extraction on a document.

Parameters

Returns

Promise<any>
relink(id, options?): Promise<any>
Re-run shipment/container linking on a document.

Parameters

Returns

Promise<any>

rotate()

rotate(id, degrees, options?): Promise<any>
Rotate a document’s pages by 90, 180, or 270 degrees.

Parameters

Returns

Promise<any>

types()

types(options?): Promise<any>
List the document types Terminal49 can classify.

Parameters

Returns

Promise<any>

update()

update(id, params, options?): Promise<any>
Override a document’s type or extracted data.

Parameters

Returns

Promise<any>