Skip to content

reference.md

Latest commit

 

History

History
2334 lines (1668 loc) · 26.7 KB

reference.md

File metadata and controls

2334 lines (1668 loc) · 26.7 KB
Raw

Reference

Deployment

client.deployment.licenseStatus() -> DeploymentLicenseStatusResponse

🔌 Usage

client.deployment().licenseStatus();

Doc

client.doc.head(docId) -> DocHead200Response

🔌 Usage

client.doc().head(
    "docId",
    HeadDocRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.download(docId, layerName) -> InputStream

🔌 Usage

client.doc().download(
    "docId",
    "layerName",
    DownloadDocRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.manifest(docId, layerName) -> DocManifest200Response

🔌 Usage

client.doc().manifest(
    "docId",
    "layerName",
    ManifestDocRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.render(docId, layerName, pon) -> InputStream

📝 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

client.doc().render(
    "docId",
    "layerName",
    1,
    RenderDocRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

pon: Integer

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.text(docId, layerName, pon) -> DocText200Response

🔌 Usage

client.doc().text(
    "docId",
    "layerName",
    1,
    TextDocRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

pon: Integer

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

Tenants

client.tenants.list() -> TenantsList200Response

🔌 Usage

client.tenants().list(
    ListTenantsRequest
        .builder()
        .build()
);

⚙️ Parameters

limit: Optional<Integer>

cursor: Optional<String>

client.tenants.create(request) -> TenantsCreate200Response

🔌 Usage

client.tenants().create(
    TenantsCreateRequest
        .builder()
        .id("id")
        .build()
);

⚙️ Parameters

id: String

name: Optional<String>

client.tenants.get(tenantId) -> TenantsGet200Response

🔌 Usage

client.tenants().get(
    "tenantId",
    GetTenantsRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

client.tenants.delete(tenantId)

📝 Description

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

🔌 Usage

client.tenants().delete(
    "tenantId",
    DeleteTenantsRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

Documents

client.documents.list(tenantId) -> DocumentsList200Response

🔌 Usage

client.documents().list(
    "tenantId",
    ListDocumentsRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

limit: Optional<Integer>

cursor: Optional<String>

state: Optional<ListDocumentsRequestState>

client.documents.get(tenantId, id) -> DocumentsGet200Response

🔌 Usage

client.documents().get(
    "tenantId",
    "id",
    GetDocumentsRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

id: String

client.documents.delete(tenantId, id)

🔌 Usage

client.documents().delete(
    "tenantId",
    "id",
    DeleteDocumentsRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

id: String

client.documents.commit(tenantId, id, request) -> DocumentsCommit200Response

🔌 Usage

client.documents().commit(
    "tenantId",
    "id",
    DocumentsCommitRequest
        .builder()
        .sha256("sha256")
        .build()
);

⚙️ Parameters

tenantId: String

id: String

sha256: String

client.documents.download(tenantId, id) -> InputStream

🔌 Usage

client.documents().download(
    "tenantId",
    "id",
    DownloadDocumentsRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

id: String

client.documents.thumbnail(tenantId, id) -> InputStream

🔌 Usage

client.documents().thumbnail(
    "tenantId",
    "id",
    ThumbnailDocumentsRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

id: String

client.documents.init(tenantId, request) -> DocumentsInit200Response

🔌 Usage

client.documents().init(
    "tenantId",
    DocumentsInitRequest
        .builder()
        .contentLength(1.1)
        .contentSha256("contentSha256")
        .build()
);

⚙️ Parameters

tenantId: String

contentLength: Double

contentSha256: String

metadata: Optional<Map<String, Object>>

idempotencyKey: Optional<String>

dedupMode: Optional<DocumentsInitRequestDedupMode>

docId: Optional<String>

uploadTtlSec: Optional<Double>

Tokens

client.tokens.issue(tenantId, request) -> 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

client.tokens().issue(
    "tenantId",
    IssueTokensRequest
        .builder()
        .body(
            TokensIssueRequest.doc(
                TokensIssueRequestDoc
                    .builder()
                    .sub("sub")
                    .docId("docId")
                    .expiresIn(1)
                    .scope(
                        Arrays.asList("scope")
                    )
                    .build()
            )
        )
        .build()
);

⚙️ Parameters

tenantId: String

request: TokensIssueRequest

client.tokens.revoke(tenantId, jti, request)

📝 Description

Mounted only when the deployment enables token revocation.

🔌 Usage

client.tokens().revoke(
    "tenantId",
    "jti",
    TokensRevokeRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

jti: String

reason: Optional<String>

expiresAtSeconds: Optional<Integer>

Doc Annotations

client.doc.annotations.list(docId, layerName, pon) -> DocAnnotationsList200Response

🔌 Usage

client.doc().annotations().list(
    "docId",
    "layerName",
    1,
    ListAnnotationsRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

pon: Integer

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.annotations.create(docId, layerName, pon, request) -> 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

client.doc().annotations().create(
    "docId",
    "layerName",
    1,
    CreateAnnotationsRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

pon: Integer

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

client.doc.annotations.delete(docId, layerName, pon, annotKey) -> DocAnnotationsDelete200Response

🔌 Usage

client.doc().annotations().delete(
    "docId",
    "layerName",
    1,
    "annotKey",
    DeleteAnnotationsRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

pon: Integer

annotKey: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.annotations.update(docId, layerName, pon, annotKey, request) -> DocAnnotationsUpdate200Response

🔌 Usage

client.doc().annotations().update(
    "docId",
    "layerName",
    1,
    "annotKey",
    UpdateAnnotationsRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

pon: Integer

annotKey: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

Doc Forms

client.doc.forms.get(docId, layerName) -> DocFormsGet200Response

🔌 Usage

client.doc().forms().get(
    "docId",
    "layerName",
    GetFormsRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.forms.exportData(docId, layerName) -> InputStream

🔌 Usage

client.doc().forms().exportData(
    "docId",
    "layerName",
    ExportDataFormsRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

format: Optional<ExportDataFormsRequestFormat>

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.forms.importData(docId, layerName, request) -> DocFormsImportData200Response

🔌 Usage

client.doc().forms().importData(
    "docId",
    "layerName",
    ImportDataFormsRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

client.doc.forms.reset(docId, layerName, fieldKey) -> DocFormsReset200Response

🔌 Usage

client.doc().forms().reset(
    "docId",
    "layerName",
    "fieldKey",
    ResetFormsRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

fieldKey: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

client.doc.forms.setValue(docId, layerName, fieldKey, request) -> DocFormsSetValue200Response

🔌 Usage

client.doc().forms().setValue(
    "docId",
    "layerName",
    "fieldKey",
    SetValueFormsRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

fieldKey: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

Doc Metadata

client.doc.metadata.get(docId, layerName) -> DocMetadataGet200Response

🔌 Usage

client.doc().metadata().get(
    "docId",
    "layerName",
    GetMetadataRequest
        .builder()
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

Doc Pages

client.doc.pages.delete(docId, layerName, request) -> DocPagesDelete200Response

🔌 Usage

client.doc().pages().delete(
    "docId",
    "layerName",
    DeletePagesRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

client.doc.pages.flatten(docId, layerName, request) -> DocPagesFlatten200Response

🔌 Usage

client.doc().pages().flatten(
    "docId",
    "layerName",
    FlattenPagesRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

client.doc.pages.move(docId, layerName, request) -> DocPagesMove200Response

🔌 Usage

client.doc().pages().move(
    "docId",
    "layerName",
    MovePagesRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

client.doc.pages.rotate(docId, layerName, request) -> DocPagesRotate200Response

🔌 Usage

client.doc().pages().rotate(
    "docId",
    "layerName",
    RotatePagesRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>

Doc Redactions

client.doc.redactions.apply(docId, layerName, request) -> DocRedactionsApply200Response

🔌 Usage

client.doc().redactions().apply(
    "docId",
    "layerName",
    ApplyRedactionsRequest
        .builder()
        .body(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

docId: String

layerName: String

documentPassword: Optional<String> — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

request: Map<String, Object>