Class DocumentEndpoint

Document upload and download operations.

Index

Constructors

Methods

delete download upload

Constructors

constructor

new DocumentEndpoint(client: IdkollenClient): DocumentEndpoint
Parameters
- client: IdkollenClient
Returns DocumentEndpoint
- Defined in src/endpoints/document.ts:6

Methods

delete

delete(id: string): Promise<void>
Delete a document by ID.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/document.ts:35

download

download(id: string): Promise<Uint8Array<ArrayBufferLike>>
Download a signed PDF by document ID.
Parameters
- id: string
Returns Promise<Uint8Array<ArrayBufferLike>>
Raw PDF bytes.
- Defined in src/endpoints/document.ts:30

upload

upload(
    file: Uint8Array,
    filename: string,
    mimeType?: string,
): Promise<DocumentUploadResponse>
Upload a PDF document. Returns the document ID for use in sign requests.
Parameters
- file: Uint8Array
  Raw file bytes.
- filename: string
  Original filename sent as the multipart part name.
- OptionalmimeType: string
  MIME type of the file. Defaults to "application/pdf".
Returns Promise<DocumentUploadResponse>
- Defined in src/endpoints/document.ts:14