groupdocs_signature_cloud 18.8.1 → 19.5

data/lib/groupdocs_signature_cloud/api/storage_api.rb

@@ -0,0 +1,544 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="storage.rb">
+#   Copyright (c) 2003-2019 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 StorageApi
+    attr_accessor :config
+
+    #make StorageApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of StorageApi
+    #
+    # @param [config] Configuration 
+    # @return [StorageApi] New instance of StorageApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      @access_token = nil
+    end
+
+    # Initializes new instance of StorageApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [StorageApi] New instance of StorageApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of StorageApi
+    #
+    # @param [config] Configuration 
+    # @return [StorageApi] New instance of StorageApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Get disc usage
+    # 
+    # @param request get_disc_usage_request
+    # @return [DiscUsage]
+    def get_disc_usage(request)
+      data, _status_code, _headers = get_disc_usage_with_http_info(request)
+      data
+    end
+
+    # Get disc usage
+    # 
+    # @param request get_disc_usage_request
+    # @return [Array<(DiscUsage, Fixnum, Hash)>]
+    # DiscUsage data, response status code and response headers
+    def get_disc_usage_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetDiscUsageRequest
+
+      @api_client.config.logger.debug 'Calling API: StorageApi.get_disc_usage ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/signature/storage/disc'
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('storageName') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('storageName') + '}', request.storage_name.to_s)
+      else
+        query_params[downcase_first_letter('storageName')] = request.storage_name unless request.storage_name.nil?
+      end
+
+      # 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 = nil
+      data, status_code, headers = @api_client.call_api(:GET, 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: 'DiscUsage')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        StorageApi#get_disc_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Get file versions
+    # 
+    # @param request get_file_versions_request
+    # @return [FileVersions]
+    def get_file_versions(request)
+      data, _status_code, _headers = get_file_versions_with_http_info(request)
+      data
+    end
+
+    # Get file versions
+    # 
+    # @param request get_file_versions_request
+    # @return [Array<(FileVersions, Fixnum, Hash)>]
+    # FileVersions data, response status code and response headers
+    def get_file_versions_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetFileVersionsRequest
+
+      @api_client.config.logger.debug 'Calling API: StorageApi.get_file_versions ...' if @api_client.config.debugging
+      # verify the required parameter 'path' is set
+      raise ArgumentError, 'Missing the required parameter path when calling StorageApi.get_file_versions' if @api_client.config.client_side_validation && request.path.nil?
+      # resource path
+      local_var_path = '/signature/storage/version/{path}'
+      escaped = request.path.to_s.sub("\\", "\\\\\\\\")
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('path') + '}', escaped)
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('storageName') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('storageName') + '}', request.storage_name.to_s)
+      else
+        query_params[downcase_first_letter('storageName')] = request.storage_name unless request.storage_name.nil?
+      end
+
+      # 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 = nil
+      data, status_code, headers = @api_client.call_api(:GET, 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: 'FileVersions')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        StorageApi#get_file_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Check if file or folder exists
+    # 
+    # @param request object_exists_request
+    # @return [ObjectExist]
+    def object_exists(request)
+      data, _status_code, _headers = object_exists_with_http_info(request)
+      data
+    end
+
+    # Check if file or folder exists
+    # 
+    # @param request object_exists_request
+    # @return [Array<(ObjectExist, Fixnum, Hash)>]
+    # ObjectExist data, response status code and response headers
+    def object_exists_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? ObjectExistsRequest
+
+      @api_client.config.logger.debug 'Calling API: StorageApi.object_exists ...' if @api_client.config.debugging
+      # verify the required parameter 'path' is set
+      raise ArgumentError, 'Missing the required parameter path when calling StorageApi.object_exists' if @api_client.config.client_side_validation && request.path.nil?
+      # resource path
+      local_var_path = '/signature/storage/exist/{path}'
+      escaped = request.path.to_s.sub("\\", "\\\\\\\\")
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('path') + '}', escaped)
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('storageName') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('storageName') + '}', request.storage_name.to_s)
+      else
+        query_params[downcase_first_letter('storageName')] = request.storage_name unless request.storage_name.nil?
+      end
+      if local_var_path.include? ('{' + downcase_first_letter('versionId') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('versionId') + '}', request.version_id.to_s)
+      else
+        query_params[downcase_first_letter('versionId')] = request.version_id unless request.version_id.nil?
+      end
+
+      # 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 = nil
+      data, status_code, headers = @api_client.call_api(:GET, 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: 'ObjectExist')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        StorageApi#object_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Check if storage exists
+    # 
+    # @param request storage_exists_request
+    # @return [StorageExist]
+    def storage_exists(request)
+      data, _status_code, _headers = storage_exists_with_http_info(request)
+      data
+    end
+
+    # Check if storage exists
+    # 
+    # @param request storage_exists_request
+    # @return [Array<(StorageExist, Fixnum, Hash)>]
+    # StorageExist data, response status code and response headers
+    def storage_exists_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? StorageExistsRequest
+
+      @api_client.config.logger.debug 'Calling API: StorageApi.storage_exists ...' if @api_client.config.debugging
+      # verify the required parameter 'storage_name' is set
+      raise ArgumentError, 'Missing the required parameter storage_name when calling StorageApi.storage_exists' if @api_client.config.client_side_validation && request.storage_name.nil?
+      # resource path
+      local_var_path = '/signature/storage/{storageName}/exist'
+      escaped = request.storage_name.to_s.sub("\\", "\\\\\\\\")
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('storageName') + '}', escaped)
+
+      # 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 = nil
+      data, status_code, headers = @api_client.call_api(:GET, 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: 'StorageExist')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        StorageApi#storage_exists\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="get_disc_usage_request.rb">
+ #   Copyright (c) 2003-2019 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 get_disc_usage operation.
+  #
+  class GetDiscUsageRequest
+
+        # Storage name
+        attr_accessor :storage_name
+	
+        #
+        # Initializes a new instance.
+        # @param storage_name Storage name
+        def initialize(storage_name = nil)
+           self.storage_name = storage_name
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="get_file_versions_request.rb">
+ #   Copyright (c) 2003-2019 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 get_file_versions operation.
+  #
+  class GetFileVersionsRequest
+
+        # File path e.g. '/file.ext'
+        attr_accessor :path
+        # Storage name
+        attr_accessor :storage_name
+	
+        #
+        # Initializes a new instance.
+        # @param path File path e.g. '/file.ext'
+        # @param storage_name Storage name
+        def initialize(path, storage_name = nil)
+           self.path = path
+           self.storage_name = storage_name
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="object_exists_request.rb">
+ #   Copyright (c) 2003-2019 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 object_exists operation.
+  #
+  class ObjectExistsRequest
+
+        # File or folder path e.g. '/file.ext' or '/folder'
+        attr_accessor :path
+        # Storage name
+        attr_accessor :storage_name
+        # File version ID
+        attr_accessor :version_id
+	
+        #
+        # Initializes a new instance.
+        # @param path File or folder path e.g. '/file.ext' or '/folder'
+        # @param storage_name Storage name
+        # @param version_id File version ID
+        def initialize(path, storage_name = nil, version_id = nil)
+           self.path = path
+           self.storage_name = storage_name
+           self.version_id = version_id
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="storage_exists_request.rb">
+ #   Copyright (c) 2003-2019 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 storage_exists operation.
+  #
+  class StorageExistsRequest
+
+        # Storage name
+        attr_accessor :storage_name
+	
+        #
+        # Initializes a new instance.
+        # @param storage_name Storage name
+        def initialize(storage_name)
+           self.storage_name = storage_name
+        end
+  end
+end