groupdocs_conversion_cloud 24.3 → 24.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74886dfd7d48be4b54ea4ecc554d39346b4c5cfe14dcf18c2b654e94c4d2c068
-  data.tar.gz: 52d625970d1efc95d04653f1bc48a8c6e7f38865faff1dca8536777d2d21da4c
+  metadata.gz: b1354fe62e635aea64e167a58a224ac421eb828ae62e34d8ceb7428a57ca5a79
+  data.tar.gz: 3f11f11e09ef7b69a94c530ebb8595cf4d76eb850167861af5b4c4968688e762
 SHA512:
-  metadata.gz: fd78a4b7c44f32a57c977fe5b8014de6d6d547405753b733bf5a103af65e224e9a6f6360aa90200e4ccbb162fb2d2e56f4bb5ea78d3a7250e3dd4db8b280c32d
-  data.tar.gz: f8ee111daa7d40bcd44a2b0be2c68c7b03f04985a82fd18b8d8208ec92e921de3ef8de786f06f818754741af6f09a633294c92fa87ccbceade58d2ce45bc9ee7
+  metadata.gz: facd18066e84f511bd977f1c080b8e215280883c8878fe575e83dc0ad3227dca150ce0677eed91375052cc00f029228c61fe8390827adaa1d8105955a39626fd
+  data.tar.gz: 06d857ba949f254664e99703ee9c309a224f4e734bc622707dd7b2fa5e55f35c4e96d2d90bbbe99f42bc94ca034b9fd806a11d12daa892d6c31b1aa89782c473

data/lib/groupdocs_conversion_cloud/api/async_api.rb

@@ -0,0 +1,539 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="async.rb">
+#   Copyright (c) 2003-2024 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 GroupDocsConversionCloud
+  #
+  # GroupDocs.Conversion Cloud API
+  #
+  class AsyncApi
+    attr_accessor :config
+
+    #make AsyncApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of AsyncApi
+    #
+    # @param [config] Configuration 
+    # @return [AsyncApi] New instance of AsyncApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      @access_token = nil
+    end
+
+    # Initializes new instance of AsyncApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [AsyncApi] New instance of AsyncApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of AsyncApi
+    #
+    # @param [config] Configuration 
+    # @return [AsyncApi] New instance of AsyncApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Get async operation result
+    # 
+    # @param request get_operation_result_request
+    # @return [File]
+    def get_operation_result(request)
+      data, _status_code, _headers = get_operation_result_with_http_info(request)
+      data
+    end
+
+    # Get async operation result
+    # 
+    # @param request get_operation_result_request
+    # @return [Array<(File, Fixnum, Hash)>]
+    # File data, response status code and response headers
+    def get_operation_result_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetOperationResultRequest
+
+      @api_client.config.logger.debug 'Calling API: AsyncApi.get_operation_result ...' if @api_client.config.debugging
+      # verify the required parameter 'id' is set
+      raise ArgumentError, 'Missing the required parameter id when calling AsyncApi.get_operation_result' if @api_client.config.client_side_validation && request.id.nil?
+      # resource path
+      local_var_path = '/conversion/async/result'
+
+      # query parameters
+      query_params = {}
+      query_params[downcase_first_letter('id')] = request.id
+
+
+      # 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: 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        AsyncApi#get_operation_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Get async operation status
+    # 
+    # @param request get_operation_status_request
+    # @return [OperationResult]
+    def get_operation_status(request)
+      data, _status_code, _headers = get_operation_status_with_http_info(request)
+      data
+    end
+
+    # Get async operation status
+    # 
+    # @param request get_operation_status_request
+    # @return [Array<(OperationResult, Fixnum, Hash)>]
+    # OperationResult data, response status code and response headers
+    def get_operation_status_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetOperationStatusRequest
+
+      @api_client.config.logger.debug 'Calling API: AsyncApi.get_operation_status ...' if @api_client.config.debugging
+      # verify the required parameter 'id' is set
+      raise ArgumentError, 'Missing the required parameter id when calling AsyncApi.get_operation_status' if @api_client.config.client_side_validation && request.id.nil?
+      # resource path
+      local_var_path = '/conversion/async'
+
+      # query parameters
+      query_params = {}
+      query_params[downcase_first_letter('id')] = request.id
+
+
+      # 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: 'OperationResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        AsyncApi#get_operation_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Starts async conversion specified input document, from request body, to format specified
+    # 
+    # @param request start_convert_request
+    # @return [String]
+    def start_convert(request)
+      data, _status_code, _headers = start_convert_with_http_info(request)
+      data
+    end
+
+    # Starts async conversion specified input document, from request body, to format specified
+    # 
+    # @param request start_convert_request
+    # @return [Array<(String, Fixnum, Hash)>]
+    # String data, response status code and response headers
+    def start_convert_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? StartConvertRequest
+
+      @api_client.config.logger.debug 'Calling API: AsyncApi.start_convert ...' if @api_client.config.debugging
+      # verify the required parameter 'format' is set
+      raise ArgumentError, 'Missing the required parameter format when calling AsyncApi.start_convert' if @api_client.config.client_side_validation && request.format.nil?
+      # verify the required parameter 'file' is set
+      raise ArgumentError, 'Missing the required parameter file when calling AsyncApi.start_convert' if @api_client.config.client_side_validation && request.file.nil?
+      # resource path
+      local_var_path = '/conversion/async'
+
+      # query parameters
+      query_params = {}
+      query_params[downcase_first_letter('format')] = request.format
+
+      if local_var_path.include? ('{' + downcase_first_letter('fromPage') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('fromPage') + '}', request.from_page.to_s)
+      else
+        query_params[downcase_first_letter('fromPage')] = request.from_page unless request.from_page.nil?
+      end
+      if local_var_path.include? ('{' + downcase_first_letter('pagesCount') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('pagesCount') + '}', request.pages_count.to_s)
+      else
+        query_params[downcase_first_letter('pagesCount')] = request.pages_count unless request.pages_count.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(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params[downcase_first_letter('File')] = request.file
+
+      # http body (model)
+      post_body = nil
+      data, status_code, headers = @api_client.call_api(:PUT, 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: 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        AsyncApi#start_convert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Starts async conversion specified input document to format specified in the convertSettings with specified options
+    # 
+    # @param request start_convert_and_save_request
+    # @return [String]
+    def start_convert_and_save(request)
+      data, _status_code, _headers = start_convert_and_save_with_http_info(request)
+      data
+    end
+
+    # Starts async conversion specified input document to format specified in the convertSettings with specified options
+    # 
+    # @param request start_convert_and_save_request
+    # @return [Array<(String, Fixnum, Hash)>]
+    # String data, response status code and response headers
+    def start_convert_and_save_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? StartConvertAndSaveRequest
+
+      @api_client.config.logger.debug 'Calling API: AsyncApi.start_convert_and_save ...' if @api_client.config.debugging
+      # verify the required parameter 'convert_settings' is set
+      raise ArgumentError, 'Missing the required parameter convert_settings when calling AsyncApi.start_convert_and_save' if @api_client.config.client_side_validation && request.convert_settings.nil?
+      # resource path
+      local_var_path = '/conversion/async'
+
+      # 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.convert_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: 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        AsyncApi#start_convert_and_save\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_operation_result_request.rb">
+ #   Copyright (c) 2003-2024 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 GroupDocsConversionCloud
+
+  #
+  # Request model for get_operation_result operation.
+  #
+  class GetOperationResultRequest
+
+        # Gets or sets id
+        attr_accessor :id
+	
+        #
+        # Initializes a new instance.
+        # @param id 
+        def initialize(id)
+           self.id = id
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="get_operation_status_request.rb">
+ #   Copyright (c) 2003-2024 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 GroupDocsConversionCloud
+
+  #
+  # Request model for get_operation_status operation.
+  #
+  class GetOperationStatusRequest
+
+        # Gets or sets id
+        attr_accessor :id
+	
+        #
+        # Initializes a new instance.
+        # @param id 
+        def initialize(id)
+           self.id = id
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="start_convert_request.rb">
+ #   Copyright (c) 2003-2024 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 GroupDocsConversionCloud
+
+  #
+  # Request model for start_convert operation.
+  #
+  class StartConvertRequest
+
+        # Requested conversion format
+        attr_accessor :format
+        # Input file to convert
+        attr_accessor :file
+        # Page start conversion from
+        attr_accessor :from_page
+        # Number of pages to convert
+        attr_accessor :pages_count
+	
+        #
+        # Initializes a new instance.
+        # @param format Requested conversion format
+        # @param file Input file to convert
+        # @param from_page Page start conversion from
+        # @param pages_count Number of pages to convert
+        def initialize(format, file, from_page = nil, pages_count = nil)
+           self.format = format
+           self.file = file
+           self.from_page = from_page
+           self.pages_count = pages_count
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="start_convert_and_save_request.rb">
+ #   Copyright (c) 2003-2024 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 GroupDocsConversionCloud
+
+  #
+  # Request model for start_convert_and_save operation.
+  #
+  class StartConvertAndSaveRequest
+
+        # Conversion settings
+        attr_accessor :convert_settings
+	
+        #
+        # Initializes a new instance.
+        # @param convert_settings Conversion settings
+        def initialize(convert_settings)
+           self.convert_settings = convert_settings
+        end
+  end
+end