cloudpdf 3.0.0.alpha.11 → 3.0.0.alpha.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55e5d83694aaa77cdd6b7f90bfd7d437aaf7116719ab68d883f98d9e10324a1
-  data.tar.gz: 46fb5b2251ae2a69214428f1a0ac7ad9eb0ed0cecab4f5c150a0f5bef228e403
+  metadata.gz: b114f23450a7caa616991c2993852831c785f770aa566d55d53f42d283666022
+  data.tar.gz: 229f7d95c9a7cd6bc29226e928f01b2b81f3c9f6485dd9926b23fff210ef504d
 SHA512:
-  metadata.gz: 16b04647f912d9c784b39be5b386b4d60459bc30a3e62557f2a5a633aae0b0a652d1cbceab499baf69a0a9392e596bff8186d78a073a1bb116afa62357a2b76d
-  data.tar.gz: febd7fa7e375c16979c65901b4ba3b415e366cffb99f0d8c4ef250bb143ac27eb205bd3fa8496b754d321c0b7104837983011617aa38b489cf8ddde0e14a19c8
+  metadata.gz: 1e2b3106c2c54690fce08c711faf453b2b564bd411b6b1172ecec4606997c43759a6203b610442eb6d165d81135f36a91fcc16da8b7c760e4f692790e027d1f9
+  data.tar.gz: 42eeb3e6de8c6232e600b4426024576029f5201d7b63824220d984cd27db3f3bdfa9c210bb3b07be8dc400f62b383fca5efe166561f1aebdeb46838dd435449a

data/.fern/metadata.json

@@ -5,9 +5,9 @@
   "generatorConfig": {
     "moduleName": "CloudPDF"
   },
-  "originGitCommit": "08782e4eef6cd6ccce4b6a6883408d9915a2d7c4",
+  "originGitCommit": "5f2d480665034420df58c19fd1328b0823104e0f",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.0.alpha.11",
+  "requestedVersion": "3.0.0.alpha.13",
   "ciProvider": "github"
 }

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

@@ -262,6 +262,112 @@ module CloudPDF
             raise error_class.new(response.body, code: code)
           end
         end
+
+        # @param request_options [Hash]
+        # @param params [CloudPDF::Types::DocAnnotationsExportAppearanceRequest]
+        # @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 [Integer] :pon
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.annotations.export_appearance(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     pon: 1,
+        #     request: {
+        #       string: {
+        #         key: "value"
+        #       }
+        #     }
+        #   )
+        #
+        # @return [untyped]
+        def export_appearance(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          path_param_names = %i[doc_id layer_name pon]
+          body_params = params.except(*path_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)}/annotations/pages/#{URI.encode_uri_component(params[:pon].to_s)}/items/appearance",
+            headers: headers,
+            body: body_params,
+            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::DocAnnotationsFlattenRequest]
+        # @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 [Integer] :pon
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.annotations.flatten(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     pon: 1,
+        #     request: {
+        #       key: "value"
+        #     }
+        #   )
+        #
+        # @return [CloudPDF::Types::DocAnnotationsFlatten200Response]
+        def flatten(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          path_param_names = %i[doc_id layer_name pon]
+          body_params = params.except(*path_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)}/annotations/pages/#{URI.encode_uri_component(params[:pon].to_s)}/items/flatten",
+            headers: headers,
+            body: body_params,
+            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)
+            CloudPDF::Types::DocAnnotationsFlatten200Response.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

data/lib/CloudPDF/doc/annotations/types/export_appearance_annotations_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Annotations
+      module Types
+        class ExportAppearanceAnnotationsRequest < 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 :pon, -> { Integer }, optional: false, nullable: false
+
+          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
+
+          field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/doc/annotations/types/flatten_annotations_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Annotations
+      module Types
+        class FlattenAnnotationsRequest < 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 :pon, -> { Integer }, optional: false, nullable: false
+
+          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
+
+          field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/doc/client.rb

@@ -253,6 +253,16 @@ module CloudPDF
       def redactions
         @redactions ||= CloudPDF::Doc::Redactions::Client.new(client: @client)
       end
+
+      # @return [CloudPDF::Signatures::Client]
+      def signatures
+        @signatures ||= CloudPDF::Doc::Signatures::Client.new(client: @client)
+      end
+
+      # @return [CloudPDF::Versions::Client]
+      def versions
+        @versions ||= CloudPDF::Doc::Versions::Client.new(client: @client)
+      end
     end
   end
 end

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

@@ -321,6 +321,108 @@ module CloudPDF
           end
         end
 
+        # @param request_options [Hash]
+        # @param params [CloudPDF::Types::DocPagesSetNameRequest]
+        # @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.pages.set_name(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     request: {
+        #       key: "value"
+        #     }
+        #   )
+        #
+        # @return [CloudPDF::Types::DocPagesSetName200Response]
+        def set_name(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          path_param_names = %i[doc_id layer_name]
+          body_params = params.except(*path_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)}/pages/names",
+            headers: headers,
+            body: body_params,
+            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)
+            CloudPDF::Types::DocPagesSetName200Response.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 [CloudPDF::Types::DocPagesRemoveNameRequest]
+        # @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.pages.remove_name(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     request: {
+        #       key: "value"
+        #     }
+        #   )
+        #
+        # @return [CloudPDF::Types::DocPagesRemoveName200Response]
+        def remove_name(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          path_param_names = %i[doc_id layer_name]
+          body_params = params.except(*path_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)}/pages/names/delete",
+            headers: headers,
+            body: body_params,
+            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)
+            CloudPDF::Types::DocPagesRemoveName200Response.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 [CloudPDF::Types::DocPagesRotateRequest]
         # @option request_options [String] :base_url

data/lib/CloudPDF/doc/pages/types/remove_name_pages_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Pages
+      module Types
+        class RemoveNamePagesRequest < 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 :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/doc/pages/types/set_name_pages_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Pages
+      module Types
+        class SetNamePagesRequest < 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 :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Signatures
+      class Client
+        # @param client [CloudPDF::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Describes the bytes the layer is over: the base version's signatures plus the layer's own edits as the last
+        # revision. Signed bytes (contents, digests, revision prefixes) are served per base version under /versions.
+        #
+        # @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.signatures.list(
+        #     doc_id: "docId",
+        #     layer_name: "layerName"
+        #   )
+        #
+        # @return [CloudPDF::Types::DocSignaturesList200Response]
+        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)}/signatures",
+            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)
+            CloudPDF::Types::DocSignaturesList200Response.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
+        # @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] :signing_id
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.signatures.abort(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     signing_id: "signingId"
+        #   )
+        #
+        # @return [CloudPDF::Types::DocSignaturesAbort200Response]
+        def abort(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: "DELETE",
+            path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/signatures/#{URI.encode_uri_component(params[:signing_id].to_s)}",
+            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)
+            CloudPDF::Types::DocSignaturesAbort200Response.load(response.body)
+          else
+            error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # `cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned.
+        # Idempotent by signing id: the same CMS again answers `already-completed`. Every layer of the document then
+        # sits over the new version; refetch the manifest after a completion.
+        #
+        # @param request_options [Hash]
+        # @param params [CloudPDF::Doc::Signatures::Types::DocSignaturesCompleteRequest]
+        # @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] :signing_id
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.signatures.complete(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     signing_id: "signingId",
+        #     cms: "cms",
+        #     expected_version: {
+        #       base_sha256: "baseSha256",
+        #       edits_version: 1
+        #     }
+        #   )
+        #
+        # @return [CloudPDF::Types::DocSignaturesComplete200Response]
+        def complete(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          request_data = CloudPDF::Doc::Signatures::Types::DocSignaturesCompleteRequest.new(params).to_h
+          non_body_param_names = %w[docId layerName signingId 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)}/signatures/#{URI.encode_uri_component(params[:signing_id].to_s)}/complete",
+            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)
+            CloudPDF::Types::DocSignaturesComplete200Response.load(response.body)
+          else
+            error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Exactly one of `since.signature=<index>` or `since.revision=<index>`; the layer's pending edits are the end.
+        # `level=fill|annotate|lta|none` evaluates exploratorily and never becomes a verdict. For history between two
+        # base revisions use the version analysis.
+        #
+        # @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 [Integer, nil] :since_signature
+        # @option params [Integer, nil] :since_revision
+        # @option params [CloudPDF::Doc::Signatures::Types::AnalysisSignaturesRequestLevel, nil] :level
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.signatures.analysis(
+        #     doc_id: "docId",
+        #     layer_name: "layerName"
+        #   )
+        #
+        # @return [CloudPDF::Types::DocSignaturesAnalysis200Response]
+        def analysis(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["since.signature"] = params[:since_signature] if params.key?(:since_signature)
+          query_params["since.revision"] = params[:since_revision] if params.key?(:since_revision)
+          query_params["level"] = params[:level] if params.key?(:level)
+
+          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)}/signatures/analysis",
+            headers: headers,
+            query: query_params,
+            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)
+            CloudPDF::Types::DocSignaturesAnalysis200Response.load(response.body)
+          else
+            error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # The multipart envelope: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock,
+        # appearance) and an optional `resource:<key>` PDF part the body's `appearance.resource` names. A certification
+        # (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing
+        # completes, is aborted, or expires (15 minutes). A layer behind the document head cannot sign (StaleBase).
+        #
+        # @param request_options [Hash]
+        # @param params [void]
+        # @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.signatures.prepare(
+        #     doc_id: "docId",
+        #     layer_name: "layerName"
+        #   )
+        #
+        # @return [CloudPDF::Types::DocSignaturesPrepare200Response]
+        def prepare(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          body = Internal::Multipart::FormData.new
+
+          body.add_part(params[:file].to_form_data_part(name: "file")) if params[:file]
+
+          request = CloudPDF::Internal::Multipart::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)}/signatures/prepare",
+            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)
+            CloudPDF::Types::DocSignaturesPrepare200Response.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/signatures/types/abort_signatures_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Signatures
+      module Types
+        class AbortSignaturesRequest < 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 :signing_id, -> { String }, optional: false, nullable: false, api_name: "signingId"
+
+          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/doc/signatures/types/analysis_signatures_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Signatures
+      module Types
+        class AnalysisSignaturesRequest < 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 :since_signature, -> { Integer }, optional: true, nullable: false, api_name: "since.signature"
+
+          field :since_revision, -> { Integer }, optional: true, nullable: false, api_name: "since.revision"
+
+          field :level, -> { CloudPDF::Doc::Signatures::Types::AnalysisSignaturesRequestLevel }, optional: true, nullable: false
+
+          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
+        end
+      end
+    end
+  end
+end