groupdocs_signature_cloud 20.7 → 21.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fa984d6ace26ca0b73e9c3be93031929594d219
-  data.tar.gz: d990275e8c301d779c59571859caf8023836f7a1
+  metadata.gz: 8c9a5d0d513bf78b30876315bf66fa535a9dce68
+  data.tar.gz: 15140996c38c2bb7f1ce0f71c3995e5cb901f480
 SHA512:
-  metadata.gz: 22c1e3b614286e022dfe2420e73561c00fe771d0754ffad4fc619e2448533dc94cdecef85facc52cf05f070d2beeabc25f8b5250c3953ce226be779cd78f9dd5
-  data.tar.gz: ea0bae5816f4246b5c5aa96cc8fb7b38647aedb4996948f035c860320b731ff8a39fbf6631f3c73715eb975361bcbb926a374d6257b7b751cc487803b3d25958
+  metadata.gz: d595bf805a5fef25911167e6d4e77db9128c490b47e5b3724f765cb5a228c5638df020ef40f936a87537e602c11d38c122592acbeb31355e8518ee2e378e8358
+  data.tar.gz: a0d1d2bb262fbae93444554cde965409fd65d19a93d1da3259cda06c849ca1af797de3869a59be828f830bf7da9b87e23ea426671f679318494d0ce7ce8e4236

data/lib/groupdocs_signature_cloud.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="groupdocs_signature_cloud.rb">
-#   Copyright (c) 2003-2020 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -53,6 +53,9 @@ require_relative 'groupdocs_signature_cloud/models/options_base'
 require_relative 'groupdocs_signature_cloud/models/padding'
 require_relative 'groupdocs_signature_cloud/models/page_info'
 require_relative 'groupdocs_signature_cloud/models/pages_setup'
+require_relative 'groupdocs_signature_cloud/models/pdf_digital_signature'
+require_relative 'groupdocs_signature_cloud/models/preview_page'
+require_relative 'groupdocs_signature_cloud/models/preview_result'
 require_relative 'groupdocs_signature_cloud/models/qr_code_type'
 require_relative 'groupdocs_signature_cloud/models/qr_codes_result'
 require_relative 'groupdocs_signature_cloud/models/save_options'
@@ -63,6 +66,7 @@ require_relative 'groupdocs_signature_cloud/models/signature_font'
 require_relative 'groupdocs_signature_cloud/models/stamp_line'
 require_relative 'groupdocs_signature_cloud/models/storage_exist'
 require_relative 'groupdocs_signature_cloud/models/storage_file'
+require_relative 'groupdocs_signature_cloud/models/time_stamp'
 require_relative 'groupdocs_signature_cloud/models/update_options'
 require_relative 'groupdocs_signature_cloud/models/update_result'
 require_relative 'groupdocs_signature_cloud/models/verify_result'
@@ -73,6 +77,7 @@ require_relative 'groupdocs_signature_cloud/models/file_version'
 require_relative 'groupdocs_signature_cloud/models/image_signature'
 require_relative 'groupdocs_signature_cloud/models/info_settings'
 require_relative 'groupdocs_signature_cloud/models/linear_gradient_brush'
+require_relative 'groupdocs_signature_cloud/models/preview_settings'
 require_relative 'groupdocs_signature_cloud/models/qr_code_signature'
 require_relative 'groupdocs_signature_cloud/models/radial_gradient_brush'
 require_relative 'groupdocs_signature_cloud/models/search_options'
@@ -103,5 +108,6 @@ require_relative 'groupdocs_signature_cloud/models/verify_qr_code_options'
 require_relative 'groupdocs_signature_cloud/api/file_api'
 require_relative 'groupdocs_signature_cloud/api/folder_api'
 require_relative 'groupdocs_signature_cloud/api/info_api'
+require_relative 'groupdocs_signature_cloud/api/preview_api'
 require_relative 'groupdocs_signature_cloud/api/sign_api'
 require_relative 'groupdocs_signature_cloud/api/storage_api'

data/lib/groupdocs_signature_cloud/api/file_api.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="file.rb">
-#   Copyright (c) 2003-2020 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -454,7 +454,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="copy_file_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -515,7 +515,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="delete_file_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -568,7 +568,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="download_file_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -621,7 +621,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="move_file_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -682,7 +682,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="upload_file_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/groupdocs_signature_cloud/api/folder_api.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="folder.rb">
-#   Copyright (c) 2003-2020 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -435,7 +435,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="copy_folder_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -492,7 +492,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="create_folder_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -541,7 +541,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="delete_folder_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -594,7 +594,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="get_files_list_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -643,7 +643,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="move_folder_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/groupdocs_signature_cloud/api/info_api.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="info.rb">
-#   Copyright (c) 2003-2020 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -320,7 +320,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="get_info_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/groupdocs_signature_cloud/api/preview_api.rb

@@ -0,0 +1,217 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="preview.rb">
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
+# </copyright>
+# <summary>
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+# </summary>
+# -----------------------------------------------------------------------------------
+
+require 'uri'
+require 'date'
+
+module GroupDocsSignatureCloud
+  #
+  # GroupDocs.Signature Cloud API
+  #
+  class PreviewApi
+    attr_accessor :config
+
+    #make PreviewApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of PreviewApi
+    #
+    # @param [config] Configuration 
+    # @return [PreviewApi] New instance of PreviewApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      @access_token = nil
+    end
+
+    # Initializes new instance of PreviewApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [PreviewApi] New instance of PreviewApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of PreviewApi
+    #
+    # @param [config] Configuration 
+    # @return [PreviewApi] New instance of PreviewApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Creates document preview images
+    # 
+    # @param request preview_document_request
+    # @return [PreviewResult]
+    def preview_document(request)
+      data, _status_code, _headers = preview_document_with_http_info(request)
+      data
+    end
+
+    # Creates document preview images
+    # 
+    # @param request preview_document_request
+    # @return [Array<(PreviewResult, Fixnum, Hash)>]
+    # PreviewResult data, response status code and response headers
+    def preview_document_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PreviewDocumentRequest
+
+      @api_client.config.logger.debug 'Calling API: PreviewApi.preview_document ...' if @api_client.config.debugging
+      # verify the required parameter 'preview_settings' is set
+      raise ArgumentError, 'Missing the required parameter preview_settings when calling PreviewApi.preview_document' if @api_client.config.client_side_validation && request.preview_settings.nil?
+      # resource path
+      local_var_path = '/signature/preview'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.preview_settings)
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'PreviewResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        PreviewApi#preview_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    #
+    # Helper method to convert first letter to downcase
+    #
+    private def downcase_first_letter(str)
+      value = str[0].downcase + str[1..-1]
+      value
+    end
+                 
+    #
+    # Retrieves access token
+    #
+    private def get_access_token
+        if @access_token.nil? then
+          request_access_token
+        end
+        
+        @access_token  
+    end
+
+    #
+    # Gets a access token from server
+    #
+    private def request_access_token
+        auth_config = Configuration.new(@config.app_sid, @config.app_key)
+        auth_config.api_base_url = @config.api_base_url
+        auth_config.debugging = @config.debugging
+        auth_config.logger = @config.logger
+        auth_config.temp_folder_path = @config.temp_folder_path
+        auth_config.client_side_validation = @config.client_side_validation
+        auth_config.api_version = ''
+
+        auth_api_client = ApiClient.new(auth_config)
+
+        request_url = "/connect/token"
+        post_data = "grant_type=client_credentials&client_id=#{@config.app_sid}&client_secret=#{@config.app_key}"
+
+        data, _status_code, _header = auth_api_client.call_api(:POST, request_url, :body => post_data, :return_type => 'Object')
+        
+        @access_token = data[:access_token]
+
+        expires_in_seconds = data[:expires_in].to_i - 5 * 60 
+        expires_in_days = Rational(expires_in_seconds, 60 * 60 * 24)
+        @access_token_expires_at = DateTime.now + expires_in_days
+    end
+    
+    # requires all files inside a directory from current dir
+    # @param _dir can be relative path like '/lib' or "../lib"
+    private def require_all(_dir)
+      Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), _dir)) + "/*.rb"].each do |file|
+        require file
+      end
+    end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="preview_document_request.rb">
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
+ # </copyright>
+ # <summary>
+ #  Permission is hereby granted, free of charge, to any person obtaining a copy
+ #  of this software and associated documentation files (the "Software"), to deal
+ #  in the Software without restriction, including without limitation the rights
+ #  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #  copies of the Software, and to permit persons to whom the Software is
+ #  furnished to do so, subject to the following conditions:
+ # 
+ #  The above copyright notice and this permission notice shall be included in all
+ #  copies or substantial portions of the Software.
+ # 
+ #  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ #  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #  SOFTWARE.
+ # </summary>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+module GroupDocsSignatureCloud
+
+  #
+  # Request model for preview_document operation.
+  #
+  class PreviewDocumentRequest
+
+        # Document preview settings
+        attr_accessor :preview_settings
+	
+        #
+        # Initializes a new instance.
+        # @param preview_settings Document preview settings
+        def initialize(preview_settings)
+           self.preview_settings = preview_settings
+        end
+  end
+end

data/lib/groupdocs_signature_cloud/api/sign_api.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="sign.rb">
-#   Copyright (c) 2003-2020 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -381,7 +381,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="create_signatures_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -426,7 +426,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="delete_signatures_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -471,7 +471,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="search_signatures_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -516,7 +516,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="update_signatures_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -561,7 +561,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="verify_signatures_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/groupdocs_signature_cloud/api/storage_api.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="storage.rb">
-#   Copyright (c) 2003-2020 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -353,7 +353,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="get_disc_usage_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -398,7 +398,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="get_file_versions_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -447,7 +447,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="object_exists_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -500,7 +500,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="storage_exists_request.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy