reference.md

Reference

Deployment

client.deployment.license_status() -> CloudPDF::Types::DeploymentLicenseStatusResponse

🔌 Usage

client.deployment.license_status

⚙️ Parameters

request_options: CloudPDF::Deployment::RequestOptions

Doc

client.doc.head(doc_id:) -> CloudPDF::Types::DocHead200Response

🔌 Usage

client.doc.head(doc_id: "docId")

⚙️ Parameters

doc_id: String

document_password: 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_options: CloudPDF::Doc::RequestOptions

client.doc.download(doc_id:, layer_name:) -> String

🔌 Usage

client.doc.download(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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_options: CloudPDF::Doc::RequestOptions

client.doc.manifest(doc_id:, layer_name:) -> CloudPDF::Types::DocManifest200Response

🔌 Usage

client.doc.manifest(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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_options: CloudPDF::Doc::RequestOptions

client.doc.render(doc_id:, layer_name:, pon:) -> 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(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

document_password: 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_options: CloudPDF::Doc::RequestOptions

client.doc.text(doc_id:, layer_name:, pon:) -> CloudPDF::Types::DocText200Response

🔌 Usage

client.doc.text(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

document_password: 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_options: CloudPDF::Doc::RequestOptions

Tenants

client.tenants.list() -> CloudPDF::Types::TenantsList200Response

🔌 Usage

client.tenants.list

⚙️ Parameters

limit: Integer

cursor: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.create(request) -> CloudPDF::Types::TenantsCreate200Response

🔌 Usage

client.tenants.create(id: "id")

⚙️ Parameters

id: String

name: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.get(tenant_id:) -> CloudPDF::Types::TenantsGet200Response

🔌 Usage

client.tenants.get(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

request_options: CloudPDF::Tenants::RequestOptions

client.tenants.delete(tenant_id:) ->

📝 Description

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

🔌 Usage

client.tenants.delete(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

request_options: CloudPDF::Tenants::RequestOptions

Documents

client.documents.list(tenant_id:) -> CloudPDF::Types::DocumentsList200Response

🔌 Usage

client.documents.list(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

limit: Integer

cursor: String

state: CloudPDF::Documents::Types::ListDocumentsRequestState

request_options: CloudPDF::Documents::RequestOptions

client.documents.get(tenant_id:, id:) -> CloudPDF::Types::DocumentsGet200Response

🔌 Usage

client.documents.get(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.delete(tenant_id:, id:) ->

🔌 Usage

client.documents.delete(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.commit(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsCommit200Response

🔌 Usage

client.documents.commit(
  tenant_id: "tenantId",
  id: "id",
  sha256: "sha256"
)

⚙️ Parameters

tenant_id: String

id: String

sha256: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.download(tenant_id:, id:) -> String

🔌 Usage

client.documents.download(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.thumbnail(tenant_id:, id:) -> String

🔌 Usage

client.documents.thumbnail(
  tenant_id: "tenantId",
  id: "id"
)

⚙️ Parameters

tenant_id: String

id: String

request_options: CloudPDF::Documents::RequestOptions

client.documents.init(tenant_id:, request) -> CloudPDF::Types::DocumentsInit200Response

🔌 Usage

client.documents.init(
  tenant_id: "tenantId",
  content_length: 1.1,
  content_sha256: "contentSha256"
)

⚙️ Parameters

tenant_id: String

content_length: Integer

content_sha256: String

metadata: Internal::Types::Hash[String, Object]

idempotency_key: String

dedup_mode: CloudPDF::Documents::Types::DocumentsInitRequestDedupMode

doc_id: String

upload_ttl_sec: Integer

request_options: CloudPDF::Documents::RequestOptions

Tokens

client.tokens.issue(tenant_id:, request) -> CloudPDF::Types::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(tenant_id: "tenantId")

⚙️ Parameters

tenant_id: String

request: CloudPDF::Types::TokensIssueRequest

request_options: CloudPDF::Tokens::RequestOptions

client.tokens.revoke(tenant_id:, jti:, request) ->

📝 Description

Mounted only when the deployment enables token revocation.

🔌 Usage

client.tokens.revoke(
  tenant_id: "tenantId",
  jti: "jti"
)

⚙️ Parameters

tenant_id: String

jti: String

reason: String

expires_at_seconds: Integer

request_options: CloudPDF::Tokens::RequestOptions

Doc Annotations

client.doc.annotations.list(doc_id:, layer_name:, pon:) -> CloudPDF::Types::DocAnnotationsList200Response

🔌 Usage

client.doc.annotations.list(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

document_password: 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_options: CloudPDF::Doc::Annotations::RequestOptions

client.doc.annotations.create(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::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(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1,
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Annotations::RequestOptions

client.doc.annotations.delete(doc_id:, layer_name:, pon:, annot_key:) -> CloudPDF::Types::DocAnnotationsDelete200Response

🔌 Usage

client.doc.annotations.delete(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1,
  annot_key: "annotKey"
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

annot_key: String

document_password: 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_options: CloudPDF::Doc::Annotations::RequestOptions

client.doc.annotations.update(doc_id:, layer_name:, pon:, annot_key:, request) -> CloudPDF::Types::DocAnnotationsUpdate200Response

🔌 Usage

client.doc.annotations.update(
  doc_id: "docId",
  layer_name: "layerName",
  pon: 1,
  annot_key: "annotKey",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

pon: Integer

annot_key: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Annotations::RequestOptions

Doc Forms

client.doc.forms.get(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsGet200Response

🔌 Usage

client.doc.forms.get(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.export_data(doc_id:, layer_name:) -> String

🔌 Usage

client.doc.forms.export_data(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

format: CloudPDF::Doc::Forms::Types::ExportDataFormsRequestFormat

document_password: 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_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.import_data(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsImportData200Response

🔌 Usage

client.doc.forms.import_data(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.reset(doc_id:, layer_name:, field_key:) -> CloudPDF::Types::DocFormsReset200Response

🔌 Usage

client.doc.forms.reset(
  doc_id: "docId",
  layer_name: "layerName",
  field_key: "fieldKey"
)

⚙️ Parameters

doc_id: String

layer_name: String

field_key: String

document_password: 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_options: CloudPDF::Doc::Forms::RequestOptions

client.doc.forms.set_value(doc_id:, layer_name:, field_key:, request) -> CloudPDF::Types::DocFormsSetValue200Response

🔌 Usage

client.doc.forms.set_value(
  doc_id: "docId",
  layer_name: "layerName",
  field_key: "fieldKey",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

field_key: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Forms::RequestOptions

Doc Metadata

client.doc.metadata.get(doc_id:, layer_name:) -> CloudPDF::Types::DocMetadataGet200Response

🔌 Usage

client.doc.metadata.get(
  doc_id: "docId",
  layer_name: "layerName"
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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_options: CloudPDF::Doc::Metadata::RequestOptions

Doc Pages

client.doc.pages.delete(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesDelete200Response

🔌 Usage

client.doc.pages.delete(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.flatten(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesFlatten200Response

🔌 Usage

client.doc.pages.flatten(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.move(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesMove200Response

🔌 Usage

client.doc.pages.move(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

client.doc.pages.rotate(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRotate200Response

🔌 Usage

client.doc.pages.rotate(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Pages::RequestOptions

Doc Redactions

client.doc.redactions.apply(doc_id:, layer_name:, request) -> CloudPDF::Types::DocRedactionsApply200Response

🔌 Usage

client.doc.redactions.apply(
  doc_id: "docId",
  layer_name: "layerName",
  request: {
    key: "value"
  }
)

⚙️ Parameters

doc_id: String

layer_name: String

document_password: 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: Internal::Types::Hash[String, Object]

request_options: CloudPDF::Doc::Redactions::RequestOptions