cloudpdf 3.0.0.alpha.18 → 3.0.0.alpha.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60b08232398dd3b69b7047deb1604b0f0c8923a86e3bdab1b001a9d1e6444ff4
-  data.tar.gz: be28a21f10968317e529e58a51fdc54b9e69b758a6ecb4bf8c482f46a9dd1d7e
+  metadata.gz: a62e737365a4ab440bf04753fbabbf635d6d7028dc8804c66e5bb98dcc241374
+  data.tar.gz: b196ceb5e909449fdd6082a2827391dad356b9f611298eb1a7034705798b6000
 SHA512:
-  metadata.gz: f45952c49aa1914d94edd9230406ab102e293062f3c4708bf18763ce7909608d8249673c28d364d831ec3a025281ee63af76fbd28ee6e243b5cad72f3e7cc04a
-  data.tar.gz: 25eb38175721c461c143b3da952b74147c05ae5923eb34c00184c39f8dafa6d54731baeaa9bcd56ce7dcf1dc89766e7f7124d9ba9c817d11c4264d3d902c6ff1
+  metadata.gz: 70a698ea37dd5fe9f4567c231fc3c4dfd43ee1deea87dff05de0c7c26d0510bfd86c00c9b3240399aac7d2b25d597c740a9f3b20e4b9469d28e60e9fb003c6e6
+  data.tar.gz: bdf1ff5df5da9758f85310ddf339e50dd8cc71150d830c894e6e8686a8603986fc2084b9c5ce3f1846b8d8f47d059edc2fd85cf01d2ebeba449c6648de9b245f

data/.fern/metadata.json

@@ -5,9 +5,9 @@
   "generatorConfig": {
     "moduleName": "CloudPDF"
   },
-  "originGitCommit": "3a88df90980e5c0546a5ebbfd1252d8fca77ff9b",
+  "originGitCommit": "622018abaf6e4578d1f4d8377982c48b92c9ced3",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.0.alpha.18",
+  "requestedVersion": "3.0.0.alpha.20",
   "ciProvider": "github"
 }

data/README.md

@@ -41,7 +41,15 @@ client.doc.changes(
 
 ## Environments
 
-This SDK allows you to configure different custom URLs for API requests. You can specify your own custom URL.
+This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.
+### Environments
+```ruby
+require "cloudpdf"
+
+CloudPDF = CloudPDF::Client.new(
+    base_url: CloudPDF::Environment::SAAS
+)
+```
 
 ### Custom URL
 ```ruby

data/lib/CloudPDF/client.rb

@@ -9,7 +9,7 @@ module CloudPDF
     # @return [void]
     def initialize(token:, base_url: nil, max_retries: 2)
       @raw_client = CloudPDF::Internal::Http::RawClient.new(
-        base_url: base_url,
+        base_url: base_url || CloudPDF::Environment::SAAS,
         headers: {
           "X-Fern-Language" => "Ruby",
           Authorization: "Bearer #{token}"
@@ -28,9 +28,9 @@ module CloudPDF
       @doc ||= CloudPDF::Doc::Client.new(client: @raw_client)
     end
 
-    # @return [CloudPDF::Shares::Client]
-    def shares
-      @shares ||= CloudPDF::Shares::Client.new(client: @raw_client)
+    # @return [CloudPDF::Grants::Client]
+    def grants
+      @grants ||= CloudPDF::Grants::Client.new(client: @raw_client)
     end
 
     # @return [CloudPDF::Tenants::Client]

data/lib/CloudPDF/doc/client.rb

@@ -359,6 +359,11 @@ module CloudPDF
         @attachments ||= CloudPDF::Doc::Attachments::Client.new(client: @client)
       end
 
+      # @return [CloudPDF::Fonts::Client]
+      def fonts
+        @fonts ||= CloudPDF::Doc::Fonts::Client.new(client: @client)
+      end
+
       # @return [CloudPDF::Forms::Client]
       def forms
         @forms ||= CloudPDF::Doc::Forms::Client.new(client: @client)

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Fonts
+      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.fonts.list(
+        #     doc_id: "docId",
+        #     layer_name: "layerName"
+        #   )
+        #
+        # @return [CloudPDF::Types::FontList]
+        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)}/fonts",
+            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::DocFontsList200Response.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::DocFontsResolveRequest]
+        # @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.fonts.resolve(
+        #     doc_id: "docId",
+        #     layer_name: "layerName",
+        #     runs: [{
+        #       text: "text"
+        #     }]
+        #   )
+        #
+        # @return [CloudPDF::Types::FontResolution]
+        def resolve(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)}/fonts/resolve",
+            headers: headers,
+            body: CloudPDF::Types::FontResolveRequest.new(body_params).to_h,
+            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::DocFontsResolve200Response.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::Programs::Client]
+        def programs
+          @programs ||= CloudPDF::Doc::Fonts::Programs::Client.new(client: @client)
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/doc/fonts/programs/client.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Fonts
+      module Programs
+        class Client
+          # @param client [CloudPDF::Internal::Http::RawClient]
+          #
+          # @return [void]
+          def initialize(client:)
+            @client = client
+          end
+
+          # A document token needs any one of the listed capabilities: one that may write text in the document. A file
+          # the list says can't be downloaded (`canDownload: false`) is not found.
+          #
+          # @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] :display_hash
+          # @option params [String, nil] :document_password
+          #
+          # @example
+          #   client.doc.fonts.programs.download(
+          #     doc_id: "docId",
+          #     layer_name: "layerName",
+          #     display_hash: "displayHash"
+          #   )
+          #
+          # @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)}/font-program-files/#{URI.encode_uri_component(params[:display_hash].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
+            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] :display_hash
+          # @option params [String, nil] :document_password
+          #
+          # @example
+          #   client.doc.fonts.programs.get(
+          #     doc_id: "docId",
+          #     layer_name: "layerName",
+          #     display_hash: "displayHash"
+          #   )
+          #
+          # @return [CloudPDF::Types::FontProgramInfo]
+          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)}/font-programs/#{URI.encode_uri_component(params[:display_hash].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)
+              (response.body.to_s.empty? ? nil : CloudPDF::Types::DocFontsProgramsGet200Response.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
+end

data/lib/CloudPDF/doc/fonts/programs/types/download_programs_request.rb

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

data/lib/CloudPDF/doc/fonts/programs/types/get_programs_request.rb

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

data/lib/CloudPDF/doc/fonts/types/list_fonts_request.rb

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

data/lib/CloudPDF/doc/fonts/types/resolve_fonts_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Doc
+    module Fonts
+      module Types
+        class ResolveFontsRequest < 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, -> { CloudPDF::Types::FontResolveRequest }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/documents/client.rb

@@ -185,6 +185,8 @@ module CloudPDF
         end
       end
 
+      # An upload token commits only the documents it started; any other document answers 404.
+      #
       # @param request_options [Hash]
       # @param params [CloudPDF::Documents::Types::DocumentsCommitRequest]
       # @option request_options [String] :base_url
@@ -305,7 +307,8 @@ module CloudPDF
       end
 
       # This bounded origin-mediated fallback must only be used after documents.init returns upload.kind=proxy. Auto
-      # mode prefers a presigned object-store PUT whenever available.
+      # mode prefers a presigned object-store PUT whenever available. An upload token sends files only to the documents
+      # it started.
       #
       # @param request_options [Hash]
       # @param params [void]
@@ -404,6 +407,11 @@ module CloudPDF
         end
       end
 
+      # With an upload token, the document goes into the token's folder with the token's metadata, whatever the request
+      # says; contentLength must be within the token's maxBytes, and the token makes at most maxFiles documents (403
+      # after). docId, idempotencyKey and dedupMode reuse-existing are refused (400): each could reach a document the
+      # token didn't make.
+      #
       # @param request_options [Hash]
       # @param params [CloudPDF::Documents::Types::DocumentsInitRequest]
       # @option request_options [String] :base_url

data/lib/CloudPDF/documents/layers/client.rb

@@ -22,7 +22,7 @@ module CloudPDF
         # @option params [String] :id
         # @option params [Integer, nil] :limit
         # @option params [String, nil] :cursor
-        # @option params [String, nil] :share_id
+        # @option params [String, nil] :grant_id
         #
         # @example
         #   client.documents.layers.list(
@@ -36,7 +36,7 @@ module CloudPDF
           query_params = {}
           query_params["limit"] = params[:limit] if params.key?(:limit)
           query_params["cursor"] = params[:cursor] if params.key?(:cursor)
-          query_params["shareId"] = params[:share_id] if params.key?(:share_id)
+          query_params["grantId"] = params[:grant_id] if params.key?(:grant_id)
 
           request = CloudPDF::Internal::JSON::Request.new(
             base_url: request_options[:base_url],

data/lib/CloudPDF/documents/layers/types/list_layers_request.rb

@@ -13,7 +13,7 @@ module CloudPDF
 
           field :cursor, -> { String }, optional: true, nullable: false
 
-          field :share_id, -> { String }, optional: true, nullable: false, api_name: "shareId"
+          field :grant_id, -> { String }, optional: true, nullable: false, api_name: "grantId"
         end
       end
     end

data/lib/CloudPDF/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  class Environment
+    SAAS = "https://engine.cloudpdf.com"
+  end
+end

data/lib/CloudPDF/folders/client.rb

@@ -142,7 +142,7 @@ module CloudPDF
       # Without recursive, a folder with anything inside is refused: 409 Conflict with `details.reason` `not-empty` and
       # what it holds, counted over every level below, in `details.folders` and `details.documents`. With
       # recursive=true, the folder and every folder under it go at once, and every document in them stops opening,
-      # leaves every list and stops answering its share links at once; their stored files and links are removed in the
+      # leaves every list and stops answering its grants at once; their stored files and grants are removed in the
       # background. Uploads into those folders that have not committed cannot commit.
       #
       # @param request_options [Hash]