Documents | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Documents

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Documents(options: DocumentsOptions, http: Client): Documents

Overrides ThBaseHandler.constructor
- Defined in src/v0/documents.ts:68
Parameters
- options: DocumentsOptions
- http: Client
Returns Documents

Properties

endpoint

endpoint: string

http

http: Client

options

options: DocumentsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/documents'

Methods

bulkDownload

bulkDownload(body: DocumentsBulkDownloadBody): Promise<DocumentsDownloadResponse>

- Defined in src/v0/documents.ts:222
Parameters
- body: DocumentsBulkDownloadBody
Returns Promise<DocumentsDownloadResponse>

bulkPreview

bulkPreview(body: DocumentsBulkPreviewBody): Promise<DocumentsPreviewResponse>

- Defined in src/v0/documents.ts:146
Parameters
- body: DocumentsBulkPreviewBody
Returns Promise<DocumentsPreviewResponse>

bulkSend

bulkSend(body: DocumentsBulkSendBody): Promise<DocumentsSendResponse>

- Defined in src/v0/documents.ts:175
Parameters
- body: DocumentsBulkSendBody
Returns Promise<DocumentsSendResponse>

download

download(documentId: string): Promise<DocumentsDownloadResponse>

- Defined in src/v0/documents.ts:190
Parameters
- documentId: string
Returns Promise<DocumentsDownloadResponse>

getAll

getAll(query?: Record<string, unknown>): Promise<DocumentsMultipleResponse>

- Defined in src/v0/documents.ts:83
Parameters
- Optional query: Record<string, unknown>
Returns Promise<DocumentsMultipleResponse>

meta

meta(query?: Record<string, unknown>): Promise<DocumentsMultipleResponse>

- Defined in src/v0/documents.ts:110
Parameters
- Optional query: Record<string, unknown>
Returns Promise<DocumentsMultipleResponse>

preview

preview(documentId: string): Promise<DocumentsPreviewResponse>

- Defined in src/v0/documents.ts:131
Parameters
- documentId: string
Returns Promise<DocumentsPreviewResponse>

send

send(documentId: string, body: DocumentsSendBody): Promise<DocumentsSendResponse>

- Defined in src/v0/documents.ts:160
Parameters
- documentId: string
- body: DocumentsSendBody
Returns Promise<DocumentsSendResponse>

Generated using TypeDoc