cloudpdf 3.0.0.alpha.15 → 3.0.0.alpha.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8712af6cdd04a8378753059169ea945e24388ca03db87b9f4980fcc915a75b86
-  data.tar.gz: 9ea6f0d5d975cf6ddbacc1cf815f439c20f43593e9e4684a45e23f76f20a786d
+  metadata.gz: 6e95ed59ffc794a7e8f609249f54ae8776c826a6fa0b9ab2924339ff7021c5ca
+  data.tar.gz: b029d01ffb43183c13b30f52c9a854e0ee8ae4796bf922a722fc43a695eabba8
 SHA512:
-  metadata.gz: c317dc7fb0b5ff76d7f40490c52d3f632dd66e42bf8d2e41288193bb44af043d909ae0c511eac8751c4585abe3df914e885e70aed0546150b6fd7ada39dddee2
-  data.tar.gz: 91ffbfed788b35e60db7911c0356158e7a726972d3367ea04b1f903ff42eb3092b649c73670072e4debe5d1001e60f0ebef3e21fb842a615b997ee2baefa470d
+  metadata.gz: 47c9670feae8fd960afb50c873552be12bd6698666f384a36ec4e1ebe8415ea97f6e714e4a630dd0c8694e75578122520f8adf983842b5e2b453a6db2dbf2845
+  data.tar.gz: 05e5c4076118baa3cba478feb0f59a0d088b142e795ecb80e02e112adb25c97ed9fb9161886982f4b0884351a4511101cafba8e1c5ccfd8b102b5d8f63ede18d

data/.fern/metadata.json

@@ -5,9 +5,9 @@
   "generatorConfig": {
     "moduleName": "CloudPDF"
   },
-  "originGitCommit": "c6f87eecf9636e7ef367946a7fd7f3729401ce90",
+  "originGitCommit": "07aa3f26c82243b36a5ec94f7072130c7298d977",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.0.alpha.15",
+  "requestedVersion": "3.0.0.alpha.17",
   "ciProvider": "github"
 }

data/lib/CloudPDF/doc/annotations/client.rb

@@ -315,6 +315,54 @@ module CloudPDF
           raise error_class.new(response.body, code: code)
         end
 
+        # A file that decodes past the server's limit is refused (PayloadTooLarge).
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :doc_id
+        # @option params [String] :layer_name
+        # @option params [String] :page_key
+        # @option params [String] :annot_key
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.annotations.read_file(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     page_key: "pageKey",
+        #     annot_key: "annotKey"
+        #   )
+        #
+        # @return [untyped]
+        def read_file(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          headers = {}
+          headers["X-Document-Password"] = params[:document_password] if params[:document_password]
+
+          request = CloudPDF::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/annotations/pages/#{URI.encode_uri_component(params[:page_key].to_s)}/items/#{URI.encode_uri_component(params[:annot_key].to_s)}/resources/file",
+            headers: headers,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise CloudPDF::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          return if code.between?(200, 299)
+
+          error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+
         # @param request_options [Hash]
         # @param params [CloudPDF::Types::DocAnnotationsExportAppearanceRequest]
         # @option request_options [String] :base_url

data/lib/CloudPDF/doc/{pages/types/delete_pages_request.rb → annotations/types/read_file_annotations_request.rb}

@@ -2,18 +2,18 @@
 
 module CloudPDF
   module Doc
-    module Pages
+    module Annotations
       module Types
-        class DeletePagesRequest < Internal::Types::Model
+        class ReadFileAnnotationsRequest < Internal::Types::Model
           field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
 
           field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
 
-          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
+          field :page_key, -> { String }, optional: false, nullable: false, api_name: "pageKey"
 
-          field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "Idempotency-Key"
+          field :annot_key, -> { String }, optional: false, nullable: false, api_name: "annotKey"
 
-          field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
         end
       end
     end

data/lib/CloudPDF/doc/attachments/client.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Attachments
+      class Client
+        # @param client [CloudPDF::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # A file that decodes past the server's limit is refused (PayloadTooLarge).
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :doc_id
+        # @option params [String] :layer_name
+        # @option params [String] :file_key
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.attachments.download(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     file_key: "fileKey"
+        #   )
+        #
+        # @return [untyped]
+        def download(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          headers = {}
+          headers["X-Document-Password"] = params[:document_password] if params[:document_password]
+
+          request = CloudPDF::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/attachment-files/#{URI.encode_uri_component(params[:file_key].to_s)}/data",
+            headers: headers,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise CloudPDF::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          return if code.between?(200, 299)
+
+          error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+
+        # A file-attachment annotation's file is listed with the annotation; read its bytes with
+        # `doc.annotations.readFile`.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :doc_id
+        # @option params [String] :layer_name
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.attachments.list(
+        #     doc_id: "docId",
+        #     layer_name: "layerName"
+        #   )
+        #
+        # @return [CloudPDF::Types::AttachmentList]
+        def list(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          headers = {}
+          headers["X-Document-Password"] = params[:document_password] if params[:document_password]
+
+          request = CloudPDF::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/attachments",
+            headers: headers,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise CloudPDF::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : CloudPDF::Types::DocAttachmentsList200Response.load(response.body))
+          else
+            error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/doc/{pages/types/insert_pages_request.rb → attachments/types/download_attachments_request.rb}

@@ -2,16 +2,16 @@
 
 module CloudPDF
   module Doc
-    module Pages
+    module Attachments
       module Types
-        class InsertPagesRequest < Internal::Types::Model
+        class DownloadAttachmentsRequest < Internal::Types::Model
           field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
 
           field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
 
-          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
+          field :file_key, -> { String }, optional: false, nullable: false, api_name: "fileKey"
 
-          field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "Idempotency-Key"
+          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
         end
       end
     end

data/lib/CloudPDF/doc/{pages/types/rotate_pages_request.rb → attachments/types/list_attachments_request.rb}

@@ -2,18 +2,14 @@
 
 module CloudPDF
   module Doc
-    module Pages
+    module Attachments
       module Types
-        class RotatePagesRequest < Internal::Types::Model
+        class ListAttachmentsRequest < Internal::Types::Model
           field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
 
           field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
 
           field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
-
-          field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "Idempotency-Key"
-
-          field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
         end
       end
     end

data/lib/CloudPDF/doc/client.rb

@@ -57,10 +57,11 @@ module CloudPDF
       # request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a
       # form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked
       # against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form
-      # structure `doc.forms.modify`, metadata `doc.metadata.modify`. Bytes (a stamp's drawing, an attached file, a
-      # signature's artwork) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: {
-      # <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per
-      # change.
+      # structure `doc.forms.modify`, metadata `doc.metadata.modify`, outline `doc.outline.modify`, pages
+      # `doc.pages.assemble`, embedded files `doc.attachments.modify`. Bytes (a stamp's drawing, an attached file, a
+      # signature's artwork, a PDF whose pages come in) travel as multipart: a JSON `body` part, each op naming its
+      # files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64
+      # changes per request and 512 ops per change.
       #
       # @param request_options [Hash]
       # @param params [CloudPDF::Doc::Types::DocChangesRequest]
@@ -156,6 +157,61 @@ module CloudPDF
         raise error_class.new(response.body, code: code)
       end
 
+      # The link opens the layer as it is when created: once the layer changes, it answers 404, so create it right
+      # before handing it over. It downloads that one file and nothing else, and a password-protected document is
+      # checked when the link is created. Deployments that verify tokens with their own keys (JWKS) mint links on their
+      # backend: a doc token with `layer_name`, a `download: { docVersion, mode: "incremental" }` claim and a short
+      # `exp`, passed as `link` on the versioned download URL.
+      #
+      # @param request_options [Hash]
+      # @param params [CloudPDF::Doc::Types::DocDownloadLinkRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :doc_id
+      # @option params [String] :layer_name
+      # @option params [String, nil] :document_password
+      #
+      # @example
+      #   client.doc.download_link(
+      #     doc_id: "docId",
+      #     layer_name: "layerName"
+      #   )
+      #
+      # @return [CloudPDF::Types::DocDownloadLink200Response]
+      def download_link(request_options: {}, **params)
+        params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+        request_data = CloudPDF::Doc::Types::DocDownloadLinkRequest.new(params).to_h
+        non_body_param_names = %w[docId layerName X-Document-Password]
+        body = request_data.except(*non_body_param_names)
+
+        headers = {}
+        headers["X-Document-Password"] = params[:document_password] if params[:document_password]
+
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/download-link",
+          headers: headers,
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise CloudPDF::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : CloudPDF::Types::DocDownloadLink200Response.load(response.body))
+        else
+          error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # @param request_options [Hash]
       # @param params [Hash]
       # @option request_options [String] :base_url
@@ -298,6 +354,11 @@ module CloudPDF
         @annotations ||= CloudPDF::Doc::Annotations::Client.new(client: @client)
       end
 
+      # @return [CloudPDF::Attachments::Client]
+      def attachments
+        @attachments ||= CloudPDF::Doc::Attachments::Client.new(client: @client)
+      end
+
       # @return [CloudPDF::Forms::Client]
       def forms
         @forms ||= CloudPDF::Doc::Forms::Client.new(client: @client)
@@ -308,6 +369,11 @@ module CloudPDF
         @metadata ||= CloudPDF::Doc::Metadata::Client.new(client: @client)
       end
 
+      # @return [CloudPDF::Outline::Client]
+      def outline
+        @outline ||= CloudPDF::Doc::Outline::Client.new(client: @client)
+      end
+
       # @return [CloudPDF::Pages::Client]
       def pages
         @pages ||= CloudPDF::Doc::Pages::Client.new(client: @client)

data/lib/CloudPDF/doc/outline/client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Outline
+      class Client
+        # @param client [CloudPDF::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :doc_id
+        # @option params [String] :layer_name
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.outline.get(
+        #     doc_id: "docId",
+        #     layer_name: "layerName"
+        #   )
+        #
+        # @return [CloudPDF::Types::DocumentOutline]
+        def get(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          headers = {}
+          headers["X-Document-Password"] = params[:document_password] if params[:document_password]
+
+          request = CloudPDF::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/outline",
+            headers: headers,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise CloudPDF::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : CloudPDF::Types::DocOutlineGet200Response.load(response.body))
+          else
+            error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/doc/{pages/types/insert_blank_pages_request.rb → outline/types/get_outline_request.rb}

@@ -2,18 +2,14 @@
 
 module CloudPDF
   module Doc
-    module Pages
+    module Outline
       module Types
-        class InsertBlankPagesRequest < Internal::Types::Model
+        class GetOutlineRequest < Internal::Types::Model
           field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
 
           field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
 
           field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
-
-          field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "Idempotency-Key"
-
-          field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
         end
       end
     end