cloudpdf 3.0.0.alpha.1 → 3.0.0.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7488b5cf7308ffa096afde5f8fa0bd6219ec8f4dbf2fe8cca1700671b7b83cb4
-  data.tar.gz: afd57c62439ba51d770e0c122e0b0ef94031dd134e055ab3b8776097f033a3a5
+  metadata.gz: f7fdb77742ceeaefd0a0ac71e28438252a6dbfa2689eaa1eb8abbb9b28d55b04
+  data.tar.gz: f5c6113005f71a826485beca4913918964b4c1ae4467898ad2e2fd0cbbfa6329
 SHA512:
-  metadata.gz: 7724b409b0a4fd39048a65c15d05305786bb36cd5c78138459bb3e118c70cac1a915a8fcb5c67120d594165b803414903a4015069cec85313c3733c1099dd73f
-  data.tar.gz: 890779b93a00d59f7768c812ffe75f4aa0adb6c0d4bf556455b73051540ddb36d6b4eee77b6537f97e776eb5cd4034c4e74fcbcbde31525e7b8847d1b67f2ed8
+  metadata.gz: 15bcadf646b92f03162188b682a9954d8526934cc03f071f541b725243e9e02159852e4a6bd889770998699f44c1ec1b72c58a9ea216cac62fd5665d8955b210
+  data.tar.gz: d3d4ba66658252c98ba21f90ed485c782fbaffffe0a1a60bfa201452b1fc0e65aa9b6cdfd91c82e6b5226399aea5cc26d548ebf930354df1ee586dbb826409d4

data/.fern/metadata.json

@@ -5,9 +5,9 @@
   "generatorConfig": {
     "moduleName": "CloudPDF"
   },
-  "originGitCommit": "a0adb9e77ef16feaef2358d71b247b4f5a98fd23",
+  "originGitCommit": "81e6a2097d2997ef713a3013668e5eae0e748575",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.0.alpha.1",
+  "requestedVersion": "3.0.0.alpha.5",
   "ciProvider": "github"
 }

data/README.md

@@ -30,7 +30,7 @@ require "cloudpdf"
 
 client = CloudPDF::Client.new(token: "<token>")
 
-client.tenants.create(id: "id")
+client.shares.exchange(share_token: "shareToken")
 ```
 
 ## Environments
@@ -58,7 +58,7 @@ client = CloudPDF::Client.new(
 )
 
 begin
-    result = client.tenants.create
+    result = client.shares.exchange
 rescue CloudPDF::Errors::TimeoutError
     puts "API didn't respond before our timeout elapsed"
 rescue CloudPDF::Errors::ServiceUnavailableError
@@ -108,7 +108,7 @@ The SDK defaults to a 60 second timeout. Use the `timeout` option to configure t
 ```ruby
 require "cloudpdf"
 
-response = client.tenants.create(
+response = client.shares.exchange(
     ...,
     timeout: 30  # 30 second timeout
 )
@@ -121,7 +121,7 @@ If you would like to send additional headers as part of the request, use the `ad
 ```ruby
 require "cloudpdf"
 
-response = client.tenants.create(
+response = client.shares.exchange(
     ...,
     request_options: {
         additional_headers: {
@@ -138,7 +138,7 @@ If you would like to send additional query parameters as part of the request, us
 ```ruby
 require "cloudpdf"
 
-response = client.tenants.create(
+response = client.shares.exchange(
     ...,
     request_options: {
         additional_query_parameters: {

data/lib/CloudPDF/client.rb

@@ -28,6 +28,11 @@ 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)
+    end
+
     # @return [CloudPDF::Tenants::Client]
     def tenants
       @tenants ||= CloudPDF::Tenants::Client.new(client: @raw_client)

data/lib/CloudPDF/documents/client.rb

@@ -249,8 +249,11 @@ module CloudPDF
         raise error_class.new(response.body, code: code)
       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.
+      #
       # @param request_options [Hash]
-      # @param params [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
@@ -258,14 +261,28 @@ module CloudPDF
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :tenant_id
       # @option params [String] :id
+      # @option params [#read] :file
       #
-      # @return [CloudPDF::Types::DocumentsUploadDirect200Response]
-      def upload_direct(request_options: {}, **params)
+      # @example
+      #   client.documents.upload_proxy(
+      #     tenant_id: "tenantId",
+      #     id: "id",
+      #     file: File.open("document.pdf", "rb")
+      #   )
+      #
+      # @return [CloudPDF::Types::DocumentsUploadProxy200Response]
+      def upload_proxy(request_options: {}, **params)
         params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
-        request = CloudPDF::Internal::JSON::Request.new(
+        body = Internal::Multipart::FormData.new
+
+        raise ArgumentError, "file is required" unless params[:file]
+        body.add_file(name: "file", file: params[:file], content_type: "application/pdf")
+
+        request = CloudPDF::Internal::Multipart::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
-          path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/upload-direct",
+          path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/upload-proxy",
+          body: body,
           request_options: request_options
         )
         begin
@@ -275,7 +292,7 @@ module CloudPDF
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          CloudPDF::Types::DocumentsUploadDirect200Response.load(response.body)
+          CloudPDF::Types::DocumentsUploadProxy200Response.load(response.body)
         else
           error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/CloudPDF/documents/types/documents_init_request.rb

@@ -19,6 +19,8 @@ module CloudPDF
         field :doc_id, -> { String }, optional: true, nullable: false, api_name: "docId"
 
         field :upload_ttl_sec, -> { Integer }, optional: true, nullable: false, api_name: "uploadTtlSec"
+
+        field :upload_preference, -> { CloudPDF::Documents::Types::DocumentsInitRequestUploadPreference }, optional: true, nullable: false, api_name: "uploadPreference"
       end
     end
   end

data/lib/CloudPDF/documents/types/documents_init_request_upload_preference.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Documents
+    module Types
+      module DocumentsInitRequestUploadPreference
+        extend CloudPDF::Internal::Types::Enum
+
+        AUTO = "auto"
+        PRESIGNED = "presigned"
+        PROXY = "proxy"
+      end
+    end
+  end
+end

data/lib/CloudPDF/documents/types/upload_proxy_documents_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Documents
+    module Types
+      class UploadProxyDocumentsRequest < Internal::Types::Model
+        field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
+
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :file, -> { Object }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/client.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    class Client
+      # @param client [CloudPDF::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked,
+      # and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired
+      # until `password` is supplied. Mounted only when the deployment can sign (HS256 mode).
+      #
+      # @param request_options [Hash]
+      # @param params [CloudPDF::Shares::Types::SharesExchangeRequest]
+      # @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.shares.exchange(share_token: "shareToken")
+      #
+      # @return [CloudPDF::Types::SharesExchange200Response]
+      def exchange(request_options: {}, **params)
+        params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/share-sessions",
+          body: CloudPDF::Shares::Types::SharesExchangeRequest.new(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)
+          CloudPDF::Types::SharesExchange200Response.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] :tenant_id
+      # @option params [Integer, nil] :limit
+      # @option params [String, nil] :cursor
+      # @option params [String, nil] :doc_id
+      #
+      # @example
+      #   client.shares.list(tenant_id: "tenantId")
+      #
+      # @return [CloudPDF::Types::SharesList200Response]
+      def list(request_options: {}, **params)
+        params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+        query_params["docId"] = params[:doc_id] if params.key?(:doc_id)
+
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares",
+          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::SharesList200Response.load(response.body)
+        else
+          error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # The returned share id IS the public share token. Mounted only when the deployment can sign (HS256 mode) —
+      # exchange mints session JWTs, so grants exist only where minting does.
+      #
+      # @param request_options [Hash]
+      # @param params [CloudPDF::Shares::Types::SharesCreateRequest]
+      # @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] :tenant_id
+      #
+      # @example
+      #   client.shares.create(
+      #     tenant_id: "tenantId",
+      #     doc_id: "docId",
+      #     scope: ["scope"]
+      #   )
+      #
+      # @return [CloudPDF::Types::SharesCreate200Response]
+      def create(request_options: {}, **params)
+        params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+        request_data = CloudPDF::Shares::Types::SharesCreateRequest.new(params).to_h
+        non_body_param_names = %w[tenantId]
+        body = request_data.except(*non_body_param_names)
+
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares",
+          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::SharesCreate200Response.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] :tenant_id
+      # @option params [String] :share_id
+      #
+      # @example
+      #   client.shares.get(
+      #     tenant_id: "tenantId",
+      #     share_id: "shareId"
+      #   )
+      #
+      # @return [CloudPDF::Types::SharesGet200Response]
+      def get(request_options: {}, **params)
+        params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares/#{URI.encode_uri_component(params[:share_id].to_s)}",
+          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::SharesGet200Response.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] :tenant_id
+      # @option params [String] :share_id
+      #
+      # @example
+      #   client.shares.delete(
+      #     tenant_id: "tenantId",
+      #     share_id: "shareId"
+      #   )
+      #
+      # @return [untyped]
+      def delete(request_options: {}, **params)
+        params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares/#{URI.encode_uri_component(params[:share_id].to_s)}",
+          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::Shares::Types::SharesUpdateRequest]
+      # @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] :tenant_id
+      # @option params [String] :share_id
+      #
+      # @example
+      #   client.shares.update(
+      #     tenant_id: "tenantId",
+      #     share_id: "shareId"
+      #   )
+      #
+      # @return [CloudPDF::Types::SharesUpdate200Response]
+      def update(request_options: {}, **params)
+        params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
+        request_data = CloudPDF::Shares::Types::SharesUpdateRequest.new(params).to_h
+        non_body_param_names = %w[tenantId shareId]
+        body = request_data.except(*non_body_param_names)
+
+        request = CloudPDF::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares/#{URI.encode_uri_component(params[:share_id].to_s)}",
+          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::SharesUpdate200Response.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/shares/types/delete_shares_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      class DeleteSharesRequest < Internal::Types::Model
+        field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
+
+        field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/types/get_shares_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      class GetSharesRequest < Internal::Types::Model
+        field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
+
+        field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/types/list_shares_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      class ListSharesRequest < Internal::Types::Model
+        field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :cursor, -> { String }, optional: true, nullable: false
+
+        field :doc_id, -> { String }, optional: true, nullable: false, api_name: "docId"
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/types/shares_create_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      class SharesCreateRequest < Internal::Types::Model
+        field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
+
+        field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
+
+        field :layer_name, -> { String }, optional: true, nullable: false, api_name: "layerName"
+
+        field :scope, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+        field :origins, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :password, -> { String }, optional: true, nullable: false
+
+        field :session_ttl_seconds, -> { Integer }, optional: true, nullable: false, api_name: "sessionTtlSeconds"
+
+        field :expires_at, -> { Integer }, optional: true, nullable: false, api_name: "expiresAt"
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/types/shares_exchange_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      class SharesExchangeRequest < Internal::Types::Model
+        field :share_token, -> { String }, optional: false, nullable: false, api_name: "shareToken"
+
+        field :password, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/types/shares_update_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      class SharesUpdateRequest < Internal::Types::Model
+        field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
+
+        field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
+
+        field :scope, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :origins, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :password, -> { String }, optional: true, nullable: false
+
+        field :session_ttl_seconds, -> { Integer }, optional: true, nullable: false, api_name: "sessionTtlSeconds"
+
+        field :disabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :expires_at, -> { Integer }, optional: true, nullable: false, api_name: "expiresAt"
+      end
+    end
+  end
+end