cloudpdf 1.0.0 → 3.0.0.alpha.1

data/lib/CloudPDF/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  class Client
+    # @param token [String]
+    # @param base_url [String, nil]
+    # @param max_retries [Integer]
+    #
+    # @return [void]
+    def initialize(token:, base_url: nil, max_retries: 2)
+      @raw_client = CloudPDF::Internal::Http::RawClient.new(
+        base_url: base_url,
+        headers: {
+          "X-Fern-Language" => "Ruby",
+          Authorization: "Bearer #{token}"
+        },
+        max_retries: max_retries
+      )
+    end
+
+    # @return [CloudPDF::Deployment::Client]
+    def deployment
+      @deployment ||= CloudPDF::Deployment::Client.new(client: @raw_client)
+    end
+
+    # @return [CloudPDF::Doc::Client]
+    def doc
+      @doc ||= CloudPDF::Doc::Client.new(client: @raw_client)
+    end
+
+    # @return [CloudPDF::Tenants::Client]
+    def tenants
+      @tenants ||= CloudPDF::Tenants::Client.new(client: @raw_client)
+    end
+
+    # @return [CloudPDF::Documents::Client]
+    def documents
+      @documents ||= CloudPDF::Documents::Client.new(client: @raw_client)
+    end
+
+    # @return [CloudPDF::Tokens::Client]
+    def tokens
+      @tokens ||= CloudPDF::Tokens::Client.new(client: @raw_client)
+    end
+  end
+end

data/lib/CloudPDF/deployment/client.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Deployment
+    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
+      #
+      # @example
+      #   client.deployment.license_status
+      #
+      # @return [CloudPDF::Types::DeploymentLicenseStatusResponse]
+      def license_status(request_options: {}, **_params)
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/deployment/license/status",
+          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::DeploymentLicenseStatusResponse.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/client.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Annotations
+      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 [Integer] :pon
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.annotations.list(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     pon: 1
+        #   )
+        #
+        # @return [CloudPDF::Types::DocAnnotationsList200Response]
+        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)}/annotations/pages/#{URI.encode_uri_component(params[:pon].to_s)}/items",
+            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::DocAnnotationsList200Response.load(response.body)
+          else
+            error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Doc JWTs may instead carry collab scopes (annotations:create:self, …) that refine per-annotation authorship
+        # rules; the API token is exempt from both.
+        #
+        # @param request_options [Hash]
+        # @param params [CloudPDF::Types::DocAnnotationsCreateRequest]
+        # @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.create(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     pon: 1,
+        #     request: {
+        #       key: "value"
+        #     }
+        #   )
+        #
+        # @return [CloudPDF::Types::DocAnnotationsCreate200Response]
+        def create(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",
+            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::DocAnnotationsCreate200Response.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 [Integer] :pon
+        # @option params [String] :annot_key
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.annotations.delete(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     pon: 1,
+        #     annot_key: "annotKey"
+        #   )
+        #
+        # @return [CloudPDF::Types::DocAnnotationsDelete200Response]
+        def delete(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)}/annotations/pages/#{URI.encode_uri_component(params[:pon].to_s)}/items/#{URI.encode_uri_component(params[:annot_key].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::DocAnnotationsDelete200Response.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::DocAnnotationsUpdateRequest]
+        # @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] :annot_key
+        # @option params [String, nil] :document_password
+        #
+        # @example
+        #   client.doc.annotations.update(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     pon: 1,
+        #     annot_key: "annotKey",
+        #     request: {
+        #       key: "value"
+        #     }
+        #   )
+        #
+        # @return [CloudPDF::Types::DocAnnotationsUpdate200Response]
+        def update(request_options: {}, **params)
+          params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+          path_param_names = %i[doc_id layer_name pon annot_key]
+          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: "PATCH",
+            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/#{URI.encode_uri_component(params[:annot_key].to_s)}",
+            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::DocAnnotationsUpdate200Response.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/annotations/types/create_annotations_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Annotations
+      module Types
+        class CreateAnnotationsRequest < 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/delete_annotations_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Annotations
+      module Types
+        class DeleteAnnotationsRequest < 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 :annot_key, -> { String }, optional: false, nullable: false, api_name: "annotKey"
+
+          field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Annotations
+      module Types
+        class ListAnnotationsRequest < 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"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Annotations
+      module Types
+        class UpdateAnnotationsRequest < 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 :annot_key, -> { String }, optional: false, nullable: false, api_name: "annotKey"
+
+          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

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    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, nil] :document_password
+      #
+      # @example
+      #   client.doc.head(doc_id: "docId")
+      #
+      # @return [CloudPDF::Types::DocHead200Response]
+      def head(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)}/head",
+          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::DocHead200Response.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, nil] :document_password
+      #
+      # @example
+      #   client.doc.download(
+      #     doc_id: "docId",
+      #     layer_name: "layerName"
+      #   )
+      #
+      # @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)}/download",
+          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 [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.manifest(
+      #     doc_id: "docId",
+      #     layer_name: "layerName"
+      #   )
+      #
+      # @return [CloudPDF::Types::DocManifest200Response]
+      def manifest(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)}/manifest",
+          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::DocManifest200Response.load(response.body)
+        else
+          error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # 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.
+      #
+      # @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] :pon
+      # @option params [String, nil] :document_password
+      #
+      # @example
+      #   client.doc.render(
+      #     doc_id: "docId",
+      #     layer_name: "layerName",
+      #     pon: 1
+      #   )
+      #
+      # @return [untyped]
+      def render(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)}/render/pages/#{URI.encode_uri_component(params[:pon].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
+
+      # @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] :pon
+      # @option params [String, nil] :document_password
+      #
+      # @example
+      #   client.doc.text(
+      #     doc_id: "docId",
+      #     layer_name: "layerName",
+      #     pon: 1
+      #   )
+      #
+      # @return [CloudPDF::Types::DocText200Response]
+      def text(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)}/text/pages/#{URI.encode_uri_component(params[:pon].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
+        if code.between?(200, 299)
+          CloudPDF::Types::DocText200Response.load(response.body)
+        else
+          error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @return [CloudPDF::Annotations::Client]
+      def annotations
+        @annotations ||= CloudPDF::Doc::Annotations::Client.new(client: @client)
+      end
+
+      # @return [CloudPDF::Forms::Client]
+      def forms
+        @forms ||= CloudPDF::Doc::Forms::Client.new(client: @client)
+      end
+
+      # @return [CloudPDF::Metadata::Client]
+      def metadata
+        @metadata ||= CloudPDF::Doc::Metadata::Client.new(client: @client)
+      end
+
+      # @return [CloudPDF::Pages::Client]
+      def pages
+        @pages ||= CloudPDF::Doc::Pages::Client.new(client: @client)
+      end
+
+      # @return [CloudPDF::Redactions::Client]
+      def redactions
+        @redactions ||= CloudPDF::Doc::Redactions::Client.new(client: @client)
+      end
+    end
+  end
+end