cloudpdf 3.0.0.alpha.8 → 3.0.0.alpha.9

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMeta < Internal::Types::Model
+      field :affected_pages, -> { Internal::Types::Array[CloudPDF::Types::DocPagesInsertBlank200ResponseMetaAffectedPagesItem] }, optional: false, nullable: false, api_name: "affectedPages"
+
+      field :cache_delta, -> { CloudPDF::Types::DocPagesInsertBlank200ResponseMetaCacheDelta }, optional: false, nullable: true, api_name: "cacheDelta"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaAffectedPagesItem < Internal::Types::Model
+      field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber"
+
+      field :revision, -> { CloudPDF::Types::DocPagesInsertBlank200ResponseMetaAffectedPagesItemRevision }, optional: false, nullable: false
+
+      field :weak_annotation_state, -> { CloudPDF::Types::DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationState }, optional: false, nullable: false, api_name: "weakAnnotationState"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_revision.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaAffectedPagesItemRevision < Internal::Types::Model
+      field :doc_session_id, -> { String }, optional: false, nullable: false, api_name: "docSessionId"
+
+      field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber"
+
+      field :generation, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_weak_annotation_state.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationState < Internal::Types::Model
+      extend CloudPDF::Internal::Types::Union
+
+      discriminant :kind
+
+      member -> { CloudPDF::Types::DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown }, key: "UNKNOWN"
+
+      member -> { CloudPDF::Types::DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown }, key: "KNOWN"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_weak_annotation_state_known.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown < Internal::Types::Model
+      field :has_any_weak_annotations, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "hasAnyWeakAnnotations"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_weak_annotation_state_unknown.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown < Internal::Types::Model; end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_cache_delta.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaCacheDelta < Internal::Types::Model
+      field :previous_doc_version, -> { Integer }, optional: false, nullable: false, api_name: "previousDocVersion"
+
+      field :doc_version, -> { Integer }, optional: false, nullable: false, api_name: "docVersion"
+
+      field :pages, -> { Internal::Types::Array[CloudPDF::Types::DocPagesInsertBlank200ResponseMetaCacheDeltaPagesItem] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_cache_delta_pages_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaCacheDeltaPagesItem < Internal::Types::Model
+      field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber"
+
+      field :cache, -> { CloudPDF::Types::DocPagesInsertBlank200ResponseMetaCacheDeltaPagesItemCache }, optional: false, nullable: false
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_cache_delta_pages_item_cache.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank200ResponseMetaCacheDeltaPagesItemCache < Internal::Types::Model
+      field :content_version, -> { Integer }, optional: false, nullable: false, api_name: "contentVersion"
+
+      field :annotation_version, -> { Integer }, optional: false, nullable: false, api_name: "annotationVersion"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank400response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank400Response < Internal::Types::Model
+      field :name, -> { CloudPDF::Types::DocPagesInsertBlank400ResponseName }, optional: false, nullable: false
+
+      field :code, -> { CloudPDF::Types::DocPagesInsertBlank400ResponseCode }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+
+      field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank400response_code.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocPagesInsertBlank400ResponseCode
+      extend CloudPDF::Internal::Types::Enum
+
+      UNKNOWN = "Unknown"
+      INVALID_ARG = "InvalidArg"
+      DOC_NOT_OPEN = "DocNotOpen"
+      DOC_OPEN_FAILED = "DocOpenFailed"
+      DOC_PASSWORD_REQUIRED = "DocPasswordRequired"
+      DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect"
+      SHARE_PASSWORD_REQUIRED = "SharePasswordRequired"
+      ABORTED = "Aborted"
+      NETWORK = "Network"
+      UNAUTHENTICATED = "Unauthenticated"
+      FORBIDDEN = "Forbidden"
+      NOT_FOUND = "NotFound"
+      WIRE_FORMAT = "WireFormat"
+      RUNTIME_UNAVAILABLE = "RuntimeUnavailable"
+      INVALID_REFERENCE = "InvalidReference"
+      WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict"
+      LAYER_VERSION_CONFLICT = "LayerVersionConflict"
+      NOT_IMPLEMENTED = "NotImplemented"
+      MALFORMED_PDF = "MalformedPdf"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank400response_name.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocPagesInsertBlank400ResponseName
+      extend CloudPDF::Internal::Types::Enum
+
+      ENGINE_ERROR = "EngineError"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank404response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocPagesInsertBlank404Response < Internal::Types::Model
+      field :name, -> { CloudPDF::Types::DocPagesInsertBlank404ResponseName }, optional: false, nullable: false
+
+      field :code, -> { CloudPDF::Types::DocPagesInsertBlank404ResponseCode }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+
+      field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank404response_code.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocPagesInsertBlank404ResponseCode
+      extend CloudPDF::Internal::Types::Enum
+
+      UNKNOWN = "Unknown"
+      INVALID_ARG = "InvalidArg"
+      DOC_NOT_OPEN = "DocNotOpen"
+      DOC_OPEN_FAILED = "DocOpenFailed"
+      DOC_PASSWORD_REQUIRED = "DocPasswordRequired"
+      DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect"
+      SHARE_PASSWORD_REQUIRED = "SharePasswordRequired"
+      ABORTED = "Aborted"
+      NETWORK = "Network"
+      UNAUTHENTICATED = "Unauthenticated"
+      FORBIDDEN = "Forbidden"
+      NOT_FOUND = "NotFound"
+      WIRE_FORMAT = "WireFormat"
+      RUNTIME_UNAVAILABLE = "RuntimeUnavailable"
+      INVALID_REFERENCE = "InvalidReference"
+      WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict"
+      LAYER_VERSION_CONFLICT = "LayerVersionConflict"
+      NOT_IMPLEMENTED = "NotImplemented"
+      MALFORMED_PDF = "MalformedPdf"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank404response_name.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocPagesInsertBlank404ResponseName
+      extend CloudPDF::Internal::Types::Enum
+
+      ENGINE_ERROR = "EngineError"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_pages_insert_blank_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocPagesInsertBlankRequest
+      # DocPagesInsertBlankRequest is an alias for Hash
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloudPDF
-  VERSION = "3.0.0.alpha.8"
+  VERSION = "3.0.0.alpha.9"
 end

data/lib/cloudpdf.rb

@@ -1977,6 +1977,46 @@ require_relative "CloudPDF/types/doc_pages_flatten400response"
 require_relative "CloudPDF/types/doc_pages_flatten404response_name"
 require_relative "CloudPDF/types/doc_pages_flatten404response_code"
 require_relative "CloudPDF/types/doc_pages_flatten404response"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_affected_pages_item_revision"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_affected_pages_item_weak_annotation_state_unknown"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_affected_pages_item_weak_annotation_state_known"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_affected_pages_item_weak_annotation_state"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_affected_pages_item"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_cache_delta_pages_item_cache"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_cache_delta_pages_item"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta_cache_delta"
+require_relative "CloudPDF/types/doc_pages_insert200response_meta"
+require_relative "CloudPDF/types/doc_pages_insert200response"
+require_relative "CloudPDF/types/doc_pages_insert400response_name"
+require_relative "CloudPDF/types/doc_pages_insert400response_code"
+require_relative "CloudPDF/types/doc_pages_insert400response"
+require_relative "CloudPDF/types/doc_pages_insert404response_name"
+require_relative "CloudPDF/types/doc_pages_insert404response_code"
+require_relative "CloudPDF/types/doc_pages_insert404response"
+require_relative "CloudPDF/types/doc_pages_insert_blank_request"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_revision"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_weak_annotation_state_unknown"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_weak_annotation_state_known"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item_weak_annotation_state"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_affected_pages_item"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_cache_delta_pages_item_cache"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_cache_delta_pages_item"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta_cache_delta"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response_meta"
+require_relative "CloudPDF/types/doc_pages_insert_blank200response"
+require_relative "CloudPDF/types/doc_pages_insert_blank400response_name"
+require_relative "CloudPDF/types/doc_pages_insert_blank400response_code"
+require_relative "CloudPDF/types/doc_pages_insert_blank400response"
+require_relative "CloudPDF/types/doc_pages_insert_blank404response_name"
+require_relative "CloudPDF/types/doc_pages_insert_blank404response_code"
+require_relative "CloudPDF/types/doc_pages_insert_blank404response"
+require_relative "CloudPDF/types/doc_pages_extract_request"
+require_relative "CloudPDF/types/doc_pages_extract400response_name"
+require_relative "CloudPDF/types/doc_pages_extract400response_code"
+require_relative "CloudPDF/types/doc_pages_extract400response"
+require_relative "CloudPDF/types/doc_pages_extract404response_name"
+require_relative "CloudPDF/types/doc_pages_extract404response_code"
+require_relative "CloudPDF/types/doc_pages_extract404response"
 require_relative "CloudPDF/types/doc_redactions_apply_request"
 require_relative "CloudPDF/types/doc_redactions_apply200response_meta_affected_pages_item_revision"
 require_relative "CloudPDF/types/doc_redactions_apply200response_meta_affected_pages_item_weak_annotation_state_unknown"
@@ -2048,7 +2088,10 @@ require_relative "CloudPDF/doc/metadata/client"
 require_relative "CloudPDF/doc/metadata/types/get_metadata_request"
 require_relative "CloudPDF/doc/pages/client"
 require_relative "CloudPDF/doc/pages/types/delete_pages_request"
+require_relative "CloudPDF/doc/pages/types/extract_pages_request"
 require_relative "CloudPDF/doc/pages/types/flatten_pages_request"
+require_relative "CloudPDF/doc/pages/types/insert_pages_request"
+require_relative "CloudPDF/doc/pages/types/insert_blank_pages_request"
 require_relative "CloudPDF/doc/pages/types/move_pages_request"
 require_relative "CloudPDF/doc/pages/types/rotate_pages_request"
 require_relative "CloudPDF/doc/redactions/client"

data/reference.md

@@ -3031,6 +3031,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 +3203,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>