RubyGems - cloudpdf - Versions diffs - 3.0.0.alpha.8 → 3.0.0.alpha.10 - Mend

cloudpdf 3.0.0.alpha.8 → 3.0.0.alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1369) hide show

data/reference.md CHANGED Viewed

@@ -2146,6 +2146,87 @@ client.tokens.revoke(
 </details>
 ## Doc Annotations
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">list_all</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocAnnotationsListAll200Response</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `pageState.pageObjectNumber` when display order matters.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.doc.annotations.list_all(
+  doc_id: "docId",
+  layer_name: "layerName"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**doc_id:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**layer_name:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**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.
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `CloudPDF::Doc::Annotations::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
 <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">list</a>(doc_id:, layer_name:, pon:) -> CloudPDF::Types::DocAnnotationsList200Response</code></summary>
 <dl>
 <dd>
@@ -3031,6 +3112,100 @@ client.doc.pages.delete(
 </dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">extract</a>(doc_id:, layer_name:, request) -> String</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+A read, not a mutation: the source document is untouched and no event is published. Body is `{"pageObjectNumbers": number[]}`; the response body is the new PDF.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.doc.pages.extract(
+  doc_id: "docId",
+  layer_name: "layerName",
+  request: {
+    string: {
+      key: "value"
+    }
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**doc_id:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**layer_name:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**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.
+</dd>
+</dl>
+<dl>
+<dd>
+**request:** `Internal::Types::Hash[String, Object]`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `CloudPDF::Doc::Pages::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
 </dd>
 </dl>
 </details>
@@ -3109,6 +3284,179 @@ client.doc.pages.flatten(
 </dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">insert</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsert200Response</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Multipart mutation envelope: a `body` field holding `{"destIndex"?: number}` (omitted → append) plus a `resource:source` file part carrying the standalone PDF whose pages are copied in. The inserted copies get fresh page object numbers, returned in insertion order.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.doc.pages.insert(
+  doc_id: "docId",
+  layer_name: "layerName"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**doc_id:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**layer_name:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**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.
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `CloudPDF::Doc::Pages::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">insert_blank</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsertBlank200Response</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Body is `{"size": {"width", "height"}, "count"?, "destIndex"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.doc.pages.insert_blank(
+  doc_id: "docId",
+  layer_name: "layerName",
+  request: {
+    key: "value"
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**doc_id:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**layer_name:** `String`
+</dd>
+</dl>
+<dl>
+<dd>
+**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.
+</dd>
+</dl>
+<dl>
+<dd>
+**request:** `Internal::Types::Hash[String, Object]`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `CloudPDF::Doc::Pages::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
 </dd>
 </dl>
 </details>