cloudpdf 3.0.0.alpha.16 → 3.0.0.alpha.17

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      module SharesUpdateRequestVisitorIdentityFieldsDisplayName
+        extend CloudPDF::Internal::Types::Enum
+
+        REQUIRED = "required"
+        OPTIONAL = "optional"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      module SharesUpdateRequestVisitorIdentityFieldsEmail
+        extend CloudPDF::Internal::Types::Enum
+
+        REQUIRED = "required"
+        OPTIONAL = "optional"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      module SharesUpdateRequestVisitorIdentityFieldsOrganization
+        extend CloudPDF::Internal::Types::Enum
+
+        REQUIRED = "required"
+        OPTIONAL = "optional"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      module SharesUpdateRequestVisitorIdentityFieldsOrganizationalUnit
+        extend CloudPDF::Internal::Types::Enum
+
+        REQUIRED = "required"
+        OPTIONAL = "optional"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Types
+      module SharesUpdateRequestVisitorIdentityFieldsTitle
+        extend CloudPDF::Internal::Types::Enum
+
+        REQUIRED = "required"
+        OPTIONAL = "optional"
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/visitors/client.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Visitors
+      class Client
+        # @param client [CloudPDF::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # An archived link's visitors are listed too.
+        #
+        # @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
+        # @option params [Integer, nil] :limit
+        # @option params [String, nil] :cursor
+        #
+        # @example
+        #   client.shares.visitors.list(
+        #     tenant_id: "tenantId",
+        #     share_id: "shareId"
+        #   )
+        #
+        # @return [CloudPDF::Types::SharesVisitorsList200Response]
+        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)
+
+          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)}/visitors",
+            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)
+            (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesVisitorsList200Response.load(response.body))
+          else
+            error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Their handle brings them back as a new visitor, who is asked again. Deleting a visitor already deleted changes
+        # nothing.
+        #
+        # @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
+        # @option params [String] :visitor_id
+        #
+        # @example
+        #   client.shares.visitors.delete(
+        #     tenant_id: "tenantId",
+        #     share_id: "shareId",
+        #     visitor_id: "visitorId"
+        #   )
+        #
+        # @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)}/visitors/#{URI.encode_uri_component(params[:visitor_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
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/visitors/types/delete_visitors_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Visitors
+      module Types
+        class DeleteVisitorsRequest < 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 :visitor_id, -> { String }, optional: false, nullable: false, api_name: "visitorId"
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/shares/visitors/types/list_visitors_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Shares
+    module Visitors
+      module Types
+        class ListVisitorsRequest < 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 :limit, -> { Integer }, optional: true, nullable: false
+
+          field :cursor, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/admin_error_payload_error.rb

@@ -6,6 +6,8 @@ module CloudPDF
       field :code, -> { String }, optional: false, nullable: false
 
       field :message, -> { String }, optional: false, nullable: false
+
+      field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
     end
   end
 end

data/lib/CloudPDF/types/doc_download_link200response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocDownloadLink200Response < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+
+      field :expires_at, -> { Integer }, optional: false, nullable: false, api_name: "expiresAt"
+    end
+  end
+end

data/lib/CloudPDF/types/doc_download_link404response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocDownloadLink404Response
+      # DocDownloadLink404Response is an alias for EngineErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/doc_download_link501response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocDownloadLink501Response
+      # DocDownloadLink501Response is an alias for EngineErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_delete403response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocumentsLayersDelete403Response
+      # DocumentsLayersDelete403Response is an alias for AdminErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_delete404response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocumentsLayersDelete404Response
+      # DocumentsLayersDelete404Response is an alias for AdminErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_delete409response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocumentsLayersDelete409Response
+      # DocumentsLayersDelete409Response is an alias for AdminErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_list200response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocumentsLayersList200Response < Internal::Types::Model
+      field :layers, -> { Internal::Types::Array[CloudPDF::Types::DocumentsLayersList200ResponseLayersItem] }, optional: false, nullable: false
+
+      field :next_cursor, -> { String }, optional: true, nullable: false, api_name: "nextCursor"
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_list200response_layers_item.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class DocumentsLayersList200ResponseLayersItem < 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 :share_id, -> { String }, optional: false, nullable: true, api_name: "shareId"
+
+      field :visitor_id, -> { String }, optional: false, nullable: true, api_name: "visitorId"
+
+      field :storage_size_bytes, -> { Integer }, optional: false, nullable: true, api_name: "storageSizeBytes"
+
+      field :created_at, -> { Integer }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { Integer }, optional: false, nullable: false, api_name: "updatedAt"
+
+      field :last_seen_at, -> { Integer }, optional: false, nullable: true, api_name: "lastSeenAt"
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_list400response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocumentsLayersList400Response
+      # DocumentsLayersList400Response is an alias for AdminErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_list403response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocumentsLayersList403Response
+      # DocumentsLayersList403Response is an alias for AdminErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/documents_layers_list404response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module DocumentsLayersList404Response
+      # DocumentsLayersList404Response is an alias for AdminErrorPayload
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/CloudPDF/types/engine_error_payload_code.rb

@@ -34,6 +34,8 @@ module CloudPDF
       CHANGE_CONFLICT = "ChangeConflict"
       UNDO_UNAVAILABLE = "UndoUnavailable"
       IDEMPOTENCY_KEY_REUSED = "IdempotencyKeyReused"
+      LAYER_DELETED = "LayerDeleted"
+      VISITOR_IDENTITY_REQUIRED = "VisitorIdentityRequired"
     end
   end
 end

data/lib/CloudPDF/types/shares_archive200response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class SharesArchive200Response < Internal::Types::Model
+      field :share, -> { CloudPDF::Types::SharesArchive200ResponseShare }, optional: false, nullable: false
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class SharesArchive200ResponseShare < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
+
+      field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
+
+      field :layer_mode, -> { CloudPDF::Types::SharesArchive200ResponseShareLayerMode }, optional: false, nullable: false, api_name: "layerMode"
+
+      field :layer_name, -> { String }, optional: false, nullable: true, api_name: "layerName"
+
+      field :keep_visitor_layers, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "keepVisitorLayers"
+
+      field :visitor_idle_seconds, -> { Integer }, optional: false, nullable: true, api_name: "visitorIdleSeconds"
+
+      field :visitor_identity, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentity }, optional: false, nullable: true, api_name: "visitorIdentity"
+
+      field :scope, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :origins, -> { Internal::Types::Array[String] }, optional: false, nullable: true
+
+      field :password_protected, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "passwordProtected"
+
+      field :session_ttl_seconds, -> { Integer }, optional: false, nullable: false, api_name: "sessionTtlSeconds"
+
+      field :disabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :archived_at, -> { Integer }, optional: false, nullable: true, api_name: "archivedAt"
+
+      field :expires_at, -> { Integer }, optional: false, nullable: true, api_name: "expiresAt"
+
+      field :exchange_count, -> { Integer }, optional: false, nullable: false, api_name: "exchangeCount"
+
+      field :last_exchanged_at, -> { Integer }, optional: false, nullable: true, api_name: "lastExchangedAt"
+
+      field :created_by, -> { String }, optional: false, nullable: false, api_name: "createdBy"
+
+      field :created_at, -> { Integer }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { Integer }, optional: false, nullable: false, api_name: "updatedAt"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_layer_mode.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module SharesArchive200ResponseShareLayerMode
+      extend CloudPDF::Internal::Types::Enum
+
+      SHARED = "shared"
+      PER_VISITOR = "per-visitor"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class SharesArchive200ResponseShareVisitorIdentity < Internal::Types::Model
+      field :fields, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentityFields }, optional: false, nullable: false
+
+      field :ask, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentityAsk }, optional: false, nullable: false
+
+      field :purpose, -> { String }, optional: true, nullable: false
+
+      field :privacy_url, -> { String }, optional: true, nullable: false, api_name: "privacyUrl"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_ask.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module SharesArchive200ResponseShareVisitorIdentityAsk
+      extend CloudPDF::Internal::Types::Enum
+
+      ON_OPEN = "on-open"
+      BEFORE_FIRST_CHANGE = "before-first-change"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    class SharesArchive200ResponseShareVisitorIdentityFields < Internal::Types::Model
+      field :display_name, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentityFieldsDisplayName }, optional: true, nullable: false, api_name: "displayName"
+
+      field :email, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentityFieldsEmail }, optional: true, nullable: false
+
+      field :title, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentityFieldsTitle }, optional: true, nullable: false
+
+      field :organization, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentityFieldsOrganization }, optional: true, nullable: false
+
+      field :organizational_unit, -> { CloudPDF::Types::SharesArchive200ResponseShareVisitorIdentityFieldsOrganizationalUnit }, optional: true, nullable: false, api_name: "organizationalUnit"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_display_name.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module SharesArchive200ResponseShareVisitorIdentityFieldsDisplayName
+      extend CloudPDF::Internal::Types::Enum
+
+      REQUIRED = "required"
+      OPTIONAL = "optional"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_email.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module SharesArchive200ResponseShareVisitorIdentityFieldsEmail
+      extend CloudPDF::Internal::Types::Enum
+
+      REQUIRED = "required"
+      OPTIONAL = "optional"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_organization.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module SharesArchive200ResponseShareVisitorIdentityFieldsOrganization
+      extend CloudPDF::Internal::Types::Enum
+
+      REQUIRED = "required"
+      OPTIONAL = "optional"
+    end
+  end
+end

data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_organizational_unit.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CloudPDF
+  module Types
+    module SharesArchive200ResponseShareVisitorIdentityFieldsOrganizationalUnit
+      extend CloudPDF::Internal::Types::Enum
+
+      REQUIRED = "required"
+      OPTIONAL = "optional"
+    end
+  end
+end