Skip to content

reference.md

Latest commit

 

History

History
2300 lines (1619 loc) · 25.6 KB

reference.md

File metadata and controls

2300 lines (1619 loc) · 25.6 KB
Raw

Reference

Deployment

$client->deployment->licenseStatus() -> ?DeploymentLicenseStatusResponse

🔌 Usage

$client->deployment->licenseStatus();

Doc

$client->doc->head($docId, $request) -> ?DocHead200Response

🔌 Usage

$client->doc->head(
    'docId',
    new HeadDocRequest([]),
);

⚙️ Parameters

$docId: string

$documentPassword: ?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, $request) -> string

🔌 Usage

$client->doc->download(
    'docId',
    'layerName',
    new DownloadDocRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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, $request) -> ?DocManifest200Response

🔌 Usage

$client->doc->manifest(
    'docId',
    'layerName',
    new ManifestDocRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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, $request) -> string

📝 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,
    new RenderDocRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$pon: int

$documentPassword: ?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, $request) -> ?DocText200Response

🔌 Usage

$client->doc->text(
    'docId',
    'layerName',
    1,
    new TextDocRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$pon: int

$documentPassword: ?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($request) -> ?TenantsList200Response

🔌 Usage

$client->tenants->list(
    new ListTenantsRequest([]),
);

⚙️ Parameters

$limit: ?int

$cursor: ?string

$client->tenants->create($request) -> ?TenantsCreate200Response

🔌 Usage

$client->tenants->create(
    new TenantsCreateRequest([
        'id' => 'id',
    ]),
);

⚙️ Parameters

$id: string

$name: ?string

$client->tenants->get($tenantId) -> ?TenantsGet200Response

🔌 Usage

$client->tenants->get(
    'tenantId',
);

⚙️ 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',
);

⚙️ Parameters

$tenantId: string

Documents

$client->documents->list($tenantId, $request) -> ?DocumentsList200Response

🔌 Usage

$client->documents->list(
    'tenantId',
    new ListDocumentsRequest([]),
);

⚙️ Parameters

$tenantId: string

$limit: ?int

$cursor: ?string

$state: ?string

$client->documents->get($tenantId, $id) -> ?DocumentsGet200Response

🔌 Usage

$client->documents->get(
    'tenantId',
    'id',
);

⚙️ Parameters

$tenantId: string

$id: string

$client->documents->delete($tenantId, $id)

🔌 Usage

$client->documents->delete(
    'tenantId',
    'id',
);

⚙️ Parameters

$tenantId: string

$id: string

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

🔌 Usage

$client->documents->commit(
    'tenantId',
    'id',
    new DocumentsCommitRequest([
        'sha256' => 'sha256',
    ]),
);

⚙️ Parameters

$tenantId: string

$id: string

$sha256: string

$client->documents->download($tenantId, $id) -> string

🔌 Usage

$client->documents->download(
    'tenantId',
    'id',
);

⚙️ Parameters

$tenantId: string

$id: string

$client->documents->thumbnail($tenantId, $id) -> string

🔌 Usage

$client->documents->thumbnail(
    'tenantId',
    'id',
);

⚙️ Parameters

$tenantId: string

$id: string

$client->documents->uploadDirect($tenantId, $id) -> ?DocumentsUploadDirect200Response

🔌 Usage

$client->documents->uploadDirect($tenantId, $id): ?DocumentsUploadDirect200Response;

⚙️ Parameters

$tenantId: string

$id: string

$client->documents->init($tenantId, $request) -> ?DocumentsInit200Response

🔌 Usage

$client->documents->init(
    'tenantId',
    new DocumentsInitRequest([
        'contentLength' => 1.1,
        'contentSha256' => 'contentSha256',
    ]),
);

⚙️ Parameters

$tenantId: string

$contentLength: float

$contentSha256: string

$metadata: ?array

$idempotencyKey: ?string

$dedupMode: ?string

$docId: ?string

$uploadTtlSec: ?float

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',
    new IssueTokensRequest([
        'body' => TokensIssueRequest::doc(new TokensIssueRequestDoc([
            'sub' => 'sub',
            'docId' => 'docId',
            'scope' => [
                'scope',
            ],
            'expiresIn' => 1,
        ])),
    ]),
);

⚙️ 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',
    new TokensRevokeRequest([]),
);

⚙️ Parameters

$tenantId: string

$jti: string

$reason: ?string

$expiresAtSeconds: ?int

Doc Annotations

$client->doc->annotations->list($docId, $layerName, $pon, $request) -> ?DocAnnotationsList200Response

🔌 Usage

$client->doc->annotations->list(
    'docId',
    'layerName',
    1,
    new ListAnnotationsRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$pon: int

$documentPassword: ?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,
    new CreateAnnotationsRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$pon: int

$documentPassword: ?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: array

$client->doc->annotations->delete($docId, $layerName, $pon, $annotKey, $request) -> ?DocAnnotationsDelete200Response

🔌 Usage

$client->doc->annotations->delete(
    'docId',
    'layerName',
    1,
    'annotKey',
    new DeleteAnnotationsRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$pon: int

$annotKey: string

$documentPassword: ?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',
    new UpdateAnnotationsRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$pon: int

$annotKey: string

$documentPassword: ?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: array

Doc Forms

$client->doc->forms->get($docId, $layerName, $request) -> ?DocFormsGet200Response

🔌 Usage

$client->doc->forms->get(
    'docId',
    'layerName',
    new GetFormsRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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, $request) -> string

🔌 Usage

$client->doc->forms->exportData(
    'docId',
    'layerName',
    new ExportDataFormsRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$format: ?string

$documentPassword: ?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',
    new ImportDataFormsRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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: array

$client->doc->forms->reset($docId, $layerName, $fieldKey, $request) -> ?DocFormsReset200Response

🔌 Usage

$client->doc->forms->reset(
    'docId',
    'layerName',
    'fieldKey',
    new ResetFormsRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$fieldKey: string

$documentPassword: ?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',
    new SetValueFormsRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$fieldKey: string

$documentPassword: ?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: array

Doc Metadata

$client->doc->metadata->get($docId, $layerName, $request) -> ?DocMetadataGet200Response

🔌 Usage

$client->doc->metadata->get(
    'docId',
    'layerName',
    new GetMetadataRequest([]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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',
    new DeletePagesRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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: array

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

🔌 Usage

$client->doc->pages->flatten(
    'docId',
    'layerName',
    new FlattenPagesRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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: array

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

🔌 Usage

$client->doc->pages->move(
    'docId',
    'layerName',
    new MovePagesRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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: array

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

🔌 Usage

$client->doc->pages->rotate(
    'docId',
    'layerName',
    new RotatePagesRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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: array

Doc Redactions

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

🔌 Usage

$client->doc->redactions->apply(
    'docId',
    'layerName',
    new ApplyRedactionsRequest([
        'body' => [
            'key' => "value",
        ],
    ]),
);

⚙️ Parameters

$docId: string

$layerName: string

$documentPassword: ?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: array