reference.md

Reference

Deployment

client.deployment.licenseStatus() -> CloudPDF.DeploymentLicenseStatusResponse

🔌 Usage

await client.deployment.licenseStatus();

⚙️ Parameters

requestOptions: DeploymentClient.RequestOptions

Doc

client.doc.head({ ...params }) -> CloudPDF.DocHead200Response

🔌 Usage

await client.doc.head({
    docId: "docId"
});

⚙️ Parameters

request: CloudPDF.HeadDocRequest

requestOptions: DocClient.RequestOptions

client.doc.download({ ...params }) -> core.BinaryResponse

🔌 Usage

await client.doc.download({
    docId: "docId",
    layerName: "layerName"
});

⚙️ Parameters

request: CloudPDF.DownloadDocRequest

requestOptions: DocClient.RequestOptions

client.doc.manifest({ ...params }) -> CloudPDF.DocManifest200Response

🔌 Usage

await client.doc.manifest({
    docId: "docId",
    layerName: "layerName"
});

⚙️ Parameters

request: CloudPDF.ManifestDocRequest

requestOptions: DocClient.RequestOptions

client.doc.render({ ...params }) -> core.BinaryResponse

📝 Description

Render parameters (viewport, format) pass as flat dotted query keys, e.g. ?viewport.kind=width&viewport.width=800; the full grammar is documented with the viewer.

🔌 Usage

await client.doc.render({
    docId: "docId",
    layerName: "layerName",
    pon: 1
});

⚙️ Parameters

request: CloudPDF.RenderDocRequest

requestOptions: DocClient.RequestOptions

client.doc.text({ ...params }) -> CloudPDF.DocText200Response

🔌 Usage

await client.doc.text({
    docId: "docId",
    layerName: "layerName",
    pon: 1
});

⚙️ Parameters

request: CloudPDF.TextDocRequest

requestOptions: DocClient.RequestOptions

Tenants

client.tenants.list({ ...params }) -> CloudPDF.TenantsList200Response

🔌 Usage

await client.tenants.list();

⚙️ Parameters

request: CloudPDF.ListTenantsRequest

requestOptions: TenantsClient.RequestOptions

client.tenants.create({ ...params }) -> CloudPDF.TenantsCreate200Response

🔌 Usage

await client.tenants.create({
    id: "id"
});

⚙️ Parameters

request: CloudPDF.TenantsCreateRequest

requestOptions: TenantsClient.RequestOptions

client.tenants.get({ ...params }) -> CloudPDF.TenantsGet200Response

🔌 Usage

await client.tenants.get({
    tenantId: "tenantId"
});

⚙️ Parameters

request: CloudPDF.GetTenantsRequest

requestOptions: TenantsClient.RequestOptions

client.tenants.delete({ ...params }) -> void

📝 Description

Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.

🔌 Usage

await client.tenants.delete({
    tenantId: "tenantId"
});

⚙️ Parameters

request: CloudPDF.DeleteTenantsRequest

requestOptions: TenantsClient.RequestOptions

Documents

client.documents.list({ ...params }) -> CloudPDF.DocumentsList200Response

🔌 Usage

await client.documents.list({
    tenantId: "tenantId"
});

⚙️ Parameters

request: CloudPDF.ListDocumentsRequest

requestOptions: DocumentsClient.RequestOptions

client.documents.get({ ...params }) -> CloudPDF.DocumentsGet200Response

🔌 Usage

await client.documents.get({
    tenantId: "tenantId",
    id: "id"
});

⚙️ Parameters

request: CloudPDF.GetDocumentsRequest

requestOptions: DocumentsClient.RequestOptions

client.documents.delete({ ...params }) -> void

🔌 Usage

await client.documents.delete({
    tenantId: "tenantId",
    id: "id"
});

⚙️ Parameters

request: CloudPDF.DeleteDocumentsRequest

requestOptions: DocumentsClient.RequestOptions

client.documents.commit({ ...params }) -> CloudPDF.DocumentsCommit200Response

🔌 Usage

await client.documents.commit({
    tenantId: "tenantId",
    id: "id",
    sha256: "sha256"
});

⚙️ Parameters

request: CloudPDF.DocumentsCommitRequest

requestOptions: DocumentsClient.RequestOptions

client.documents.download({ ...params }) -> core.BinaryResponse

🔌 Usage

await client.documents.download({
    tenantId: "tenantId",
    id: "id"
});

⚙️ Parameters

request: CloudPDF.DownloadDocumentsRequest

requestOptions: DocumentsClient.RequestOptions

client.documents.thumbnail({ ...params }) -> core.BinaryResponse

🔌 Usage

await client.documents.thumbnail({
    tenantId: "tenantId",
    id: "id"
});

⚙️ Parameters

request: CloudPDF.ThumbnailDocumentsRequest

requestOptions: DocumentsClient.RequestOptions

client.documents.init({ ...params }) -> CloudPDF.DocumentsInit200Response

🔌 Usage

await client.documents.init({
    tenantId: "tenantId",
    contentLength: 1.1,
    contentSha256: "contentSha256"
});

⚙️ Parameters

request: CloudPDF.DocumentsInitRequest

requestOptions: DocumentsClient.RequestOptions

Tokens

client.tokens.issue({ ...params }) -> CloudPDF.TokensIssue200Response

📝 Description

kind "tenant" requires the API token — authority mints only downward. Mounted only when the deployment can sign (HS256 mode); asymmetric deployments mint with their own private key.

🔌 Usage

await client.tokens.issue({
    tenantId: "tenantId",
    body: {
        kind: "doc",
        sub: "sub",
        docId: "docId",
        scope: ["scope"],
        expiresIn: 1
    }
});

⚙️ Parameters

request: CloudPDF.IssueTokensRequest

requestOptions: TokensClient.RequestOptions

client.tokens.revoke({ ...params }) -> void

📝 Description

Mounted only when the deployment enables token revocation.

🔌 Usage

await client.tokens.revoke({
    tenantId: "tenantId",
    jti: "jti"
});

⚙️ Parameters

request: CloudPDF.TokensRevokeRequest

requestOptions: TokensClient.RequestOptions

Doc Annotations

client.doc.annotations.list({ ...params }) -> CloudPDF.DocAnnotationsList200Response

🔌 Usage

await client.doc.annotations.list({
    docId: "docId",
    layerName: "layerName",
    pon: 1
});

⚙️ Parameters

request: CloudPDF.doc.ListAnnotationsRequest

requestOptions: AnnotationsClient.RequestOptions

client.doc.annotations.create({ ...params }) -> CloudPDF.DocAnnotationsCreate200Response

📝 Description

Doc JWTs may instead carry collab scopes (annotations:create:self, …) that refine per-annotation authorship rules; the API token is exempt from both.

🔌 Usage

await client.doc.annotations.create({
    docId: "docId",
    layerName: "layerName",
    pon: 1,
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.CreateAnnotationsRequest

requestOptions: AnnotationsClient.RequestOptions

client.doc.annotations.delete({ ...params }) -> CloudPDF.DocAnnotationsDelete200Response

🔌 Usage

await client.doc.annotations.delete({
    docId: "docId",
    layerName: "layerName",
    pon: 1,
    annotKey: "annotKey"
});

⚙️ Parameters

request: CloudPDF.doc.DeleteAnnotationsRequest

requestOptions: AnnotationsClient.RequestOptions

client.doc.annotations.update({ ...params }) -> CloudPDF.DocAnnotationsUpdate200Response

🔌 Usage

await client.doc.annotations.update({
    docId: "docId",
    layerName: "layerName",
    pon: 1,
    annotKey: "annotKey",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.UpdateAnnotationsRequest

requestOptions: AnnotationsClient.RequestOptions

Doc Forms

client.doc.forms.get({ ...params }) -> CloudPDF.DocFormsGet200Response

🔌 Usage

await client.doc.forms.get({
    docId: "docId",
    layerName: "layerName"
});

⚙️ Parameters

request: CloudPDF.doc.GetFormsRequest

requestOptions: FormsClient.RequestOptions

client.doc.forms.exportData({ ...params }) -> core.BinaryResponse

🔌 Usage

await client.doc.forms.exportData({
    docId: "docId",
    layerName: "layerName"
});

⚙️ Parameters

request: CloudPDF.doc.ExportDataFormsRequest

requestOptions: FormsClient.RequestOptions

client.doc.forms.importData({ ...params }) -> CloudPDF.DocFormsImportData200Response

🔌 Usage

await client.doc.forms.importData({
    docId: "docId",
    layerName: "layerName",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.ImportDataFormsRequest

requestOptions: FormsClient.RequestOptions

client.doc.forms.reset({ ...params }) -> CloudPDF.DocFormsReset200Response

🔌 Usage

await client.doc.forms.reset({
    docId: "docId",
    layerName: "layerName",
    fieldKey: "fieldKey"
});

⚙️ Parameters

request: CloudPDF.doc.ResetFormsRequest

requestOptions: FormsClient.RequestOptions

client.doc.forms.setValue({ ...params }) -> CloudPDF.DocFormsSetValue200Response

🔌 Usage

await client.doc.forms.setValue({
    docId: "docId",
    layerName: "layerName",
    fieldKey: "fieldKey",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.SetValueFormsRequest

requestOptions: FormsClient.RequestOptions

Doc Metadata

client.doc.metadata.get({ ...params }) -> CloudPDF.DocMetadataGet200Response

🔌 Usage

await client.doc.metadata.get({
    docId: "docId",
    layerName: "layerName"
});

⚙️ Parameters

request: CloudPDF.doc.GetMetadataRequest

requestOptions: MetadataClient.RequestOptions

Doc Pages

client.doc.pages.delete({ ...params }) -> CloudPDF.DocPagesDelete200Response

🔌 Usage

await client.doc.pages.delete({
    docId: "docId",
    layerName: "layerName",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.DeletePagesRequest

requestOptions: PagesClient.RequestOptions

client.doc.pages.flatten({ ...params }) -> CloudPDF.DocPagesFlatten200Response

🔌 Usage

await client.doc.pages.flatten({
    docId: "docId",
    layerName: "layerName",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.FlattenPagesRequest

requestOptions: PagesClient.RequestOptions

client.doc.pages.move({ ...params }) -> CloudPDF.DocPagesMove200Response

🔌 Usage

await client.doc.pages.move({
    docId: "docId",
    layerName: "layerName",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.MovePagesRequest

requestOptions: PagesClient.RequestOptions

client.doc.pages.rotate({ ...params }) -> CloudPDF.DocPagesRotate200Response

🔌 Usage

await client.doc.pages.rotate({
    docId: "docId",
    layerName: "layerName",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.RotatePagesRequest

requestOptions: PagesClient.RequestOptions

Doc Redactions

client.doc.redactions.apply({ ...params }) -> CloudPDF.DocRedactionsApply200Response

🔌 Usage

await client.doc.redactions.apply({
    docId: "docId",
    layerName: "layerName",
    body: {
        "key": "value"
    }
});

⚙️ Parameters

request: CloudPDF.doc.ApplyRedactionsRequest

requestOptions: RedactionsClient.RequestOptions