groupdocs_conversion_cloud 21.4 → 21.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 277b1445c5dc9fde773bc897b52bb2342cd8cbfb
-  data.tar.gz: 82b8f6da1ca19a4f39e21ae43a74520ed96862d6
+  metadata.gz: d3ea7178d044cf5c299a57d1026b116825411bd5
+  data.tar.gz: e0c80aa65e843db6a08baee1d7a78bd7962965e8
 SHA512:
-  metadata.gz: af29f8a41fa98040494ce075226777c0ad6c6026eb070304f24d0bdb576e4d11055c28d12c002fbbe7364fb61b34e92310117249f0ef518769bc7eb2cde81b5b
-  data.tar.gz: d39b339a03f2b5793be791c065c200f286399260253cd16f55237f82981d18d7656ea87f9267346361c3fae1b198a276978fc7d8181092b00607f646f7cbc83b
+  metadata.gz: cf07d6f6d86fd4bbda14bbf3ff7e011ce6cebb35d9cbe525cc9ce7b8bf9cef08bcf730a8f46a862197291a474356ff584b1dc8b57c1ce01567524bfd3e86fa21
+  data.tar.gz: a42a83a0cdf9fe59b382bfd63a0ea20f2e8128cc405872745c9d7e5a1058e8c47e06eca80b59ed77ede106c2563b3c9b7d66d5cda62e2b6aa33569178e69ca96

data/lib/groupdocs_conversion_cloud/api/license_api.rb

@@ -0,0 +1,169 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="license.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 GroupDocsConversionCloud
+  #
+  # GroupDocs.Conversion Cloud API
+  #
+  class LicenseApi
+    attr_accessor :config
+
+    #make LicenseApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of LicenseApi
+    #
+    # @param [config] Configuration 
+    # @return [LicenseApi] New instance of LicenseApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      @access_token = nil
+    end
+
+    # Initializes new instance of LicenseApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [LicenseApi] New instance of LicenseApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of LicenseApi
+    #
+    # @param [config] Configuration 
+    # @return [LicenseApi] New instance of LicenseApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Get license consumption
+    # 
+    # @return [ConsumptionResult]
+    def get_consumption_credit()
+      data, _status_code, _headers = get_consumption_credit_with_http_info()
+      data
+    end
+
+    # Get license consumption
+    # 
+    
+    # @return [Array<(ConsumptionResult, Fixnum, Hash)>]
+    # ConsumptionResult data, response status code and response headers
+    def get_consumption_credit_with_http_info()
+      
+
+      @api_client.config.logger.debug 'Calling API: LicenseApi.get_consumption_credit ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/conversion/consumption'
+
+      # 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: 'ConsumptionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        LicenseApi#get_consumption_credit\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

data/lib/groupdocs_conversion_cloud/api_error.rb

@@ -39,10 +39,23 @@ module GroupDocsConversionCloud
         
         if arg.key?(:response_body) then
           data = JSON.parse(arg[:response_body], :symbolize_names => true)
-          if !data.nil? && !data[:error].nil? then
-            @message = data[:error]
-          elsif !data.nil? && !data[:Error].nil? && !data[:Error][:Message].nil? then
-            @message = data[:Error][:Message]
+          if !data.nil? then
+            if !data[:error].nil? then
+              error = data[:error]
+              if error.kind_of?(String) then
+                @message = error
+              else
+                @message = error[:message]
+              end
+            else
+              message = data[:message]
+              if !message.nil? && message.kind_of?(String) then
+                @message = message
+                @code = data[:code]
+              else
+                @message = data
+              end              
+            end
           end
         end
 

data/lib/groupdocs_conversion_cloud/models/consumption_result.rb

@@ -0,0 +1,234 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="consumption_result.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 'date'
+
+module GroupDocsConversionCloud
+  # Metered license consumption information
+  class ConsumptionResult
+
+    # Amount of used credits
+    attr_accessor :credit
+
+    # Amount of MBs processed
+    attr_accessor :quantity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'credit' => :'Credit',
+        :'quantity' => :'Quantity'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'credit' => :'Float',
+        :'quantity' => :'Float'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'Credit')
+        self.credit = attributes[:'Credit']
+      end
+
+      if attributes.key?(:'Quantity')
+        self.quantity = attributes[:'Quantity']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      if @credit.nil?
+        invalid_properties.push("invalid value for 'credit', credit cannot be nil.")
+      end
+
+      if @quantity.nil?
+        invalid_properties.push("invalid value for 'quantity', quantity cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @credit.nil?
+      return false if @quantity.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if self.equal?(other)
+      self.class == other.class &&
+          credit == other.credit &&
+          quantity == other.quantity
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [credit, quantity].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not                    
+          if value.is_a?(Array)
+            self.send("#{key}=", value.map { |v| _deserialize($1, v) })
+          end
+        elsif !value.nil?
+          self.send("#{key}=", _deserialize(type, value))
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        Date.parse value
+      when :Date
+        Date.parse value
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else
+      # model
+        temp_model = GroupDocsConversionCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/groupdocs_conversion_cloud/models/doc_convert_options.rb

@@ -58,6 +58,30 @@ module GroupDocsConversionCloud
     # Watermark specific options
     attr_accessor :watermark_options
 
+    # Recognition mode when converting from pdf
+    attr_accessor :pdf_recognition_mode
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -69,7 +93,8 @@ module GroupDocsConversionCloud
         :'dpi' => :'Dpi',
         :'password' => :'Password',
         :'zoom' => :'Zoom',
-        :'watermark_options' => :'WatermarkOptions'
+        :'watermark_options' => :'WatermarkOptions',
+        :'pdf_recognition_mode' => :'PdfRecognitionMode'
       }
     end
 
@@ -84,7 +109,8 @@ module GroupDocsConversionCloud
         :'dpi' => :'Float',
         :'password' => :'String',
         :'zoom' => :'Integer',
-        :'watermark_options' => :'WatermarkOptions'
+        :'watermark_options' => :'WatermarkOptions',
+        :'pdf_recognition_mode' => :'String'
       }
     end
 
@@ -134,6 +160,10 @@ module GroupDocsConversionCloud
         self.watermark_options = attributes[:'WatermarkOptions']
       end
 
+      if attributes.key?(:'PdfRecognitionMode')
+        self.pdf_recognition_mode = attributes[:'PdfRecognitionMode']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -164,6 +194,10 @@ module GroupDocsConversionCloud
         invalid_properties.push("invalid value for 'zoom', zoom cannot be nil.")
       end
 
+      if @pdf_recognition_mode.nil?
+        invalid_properties.push("invalid value for 'pdf_recognition_mode', pdf_recognition_mode cannot be nil.")
+      end
+
       return invalid_properties
     end
 
@@ -176,9 +210,26 @@ module GroupDocsConversionCloud
       return false if @height.nil?
       return false if @dpi.nil?
       return false if @zoom.nil?
+      return false if @pdf_recognition_mode.nil?
+      pdf_recognition_mode_validator = EnumAttributeValidator.new('String', ["Textbox", "Flow"])
+      return false unless pdf_recognition_mode_validator.valid?(@pdf_recognition_mode)
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pdf_recognition_mode Object to be assigned
+    def pdf_recognition_mode=(pdf_recognition_mode)
+      validator = EnumAttributeValidator.new('String', ["Textbox", "Flow"])
+      if pdf_recognition_mode.to_i == 0
+        unless validator.valid?(pdf_recognition_mode)
+          raise ArgumentError, "invalid value for 'pdf_recognition_mode', must be one of #{validator.allowable_values}."
+        end
+        @pdf_recognition_mode = pdf_recognition_mode
+      else
+        @pdf_recognition_mode = validator.allowable_values[pdf_recognition_mode.to_i]
+      end
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(other)
@@ -192,7 +243,8 @@ module GroupDocsConversionCloud
           dpi == other.dpi &&
           password == other.password &&
           zoom == other.zoom &&
-          watermark_options == other.watermark_options
+          watermark_options == other.watermark_options &&
+          pdf_recognition_mode == other.pdf_recognition_mode
     end
 
     # @see the `==` method
@@ -204,7 +256,7 @@ module GroupDocsConversionCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [from_page, pages_count, pages, width, height, dpi, password, zoom, watermark_options].hash
+      [from_page, pages_count, pages, width, height, dpi, password, zoom, watermark_options, pdf_recognition_mode].hash
     end
 
     # Downcases first letter.

data/lib/groupdocs_conversion_cloud/models/docm_convert_options.rb

@@ -58,6 +58,30 @@ module GroupDocsConversionCloud
     # Watermark specific options
     attr_accessor :watermark_options
 
+    # Recognition mode when converting from pdf
+    attr_accessor :pdf_recognition_mode
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -69,7 +93,8 @@ module GroupDocsConversionCloud
         :'dpi' => :'Dpi',
         :'password' => :'Password',
         :'zoom' => :'Zoom',
-        :'watermark_options' => :'WatermarkOptions'
+        :'watermark_options' => :'WatermarkOptions',
+        :'pdf_recognition_mode' => :'PdfRecognitionMode'
       }
     end
 
@@ -84,7 +109,8 @@ module GroupDocsConversionCloud
         :'dpi' => :'Float',
         :'password' => :'String',
         :'zoom' => :'Integer',
-        :'watermark_options' => :'WatermarkOptions'
+        :'watermark_options' => :'WatermarkOptions',
+        :'pdf_recognition_mode' => :'String'
       }
     end
 
@@ -134,6 +160,10 @@ module GroupDocsConversionCloud
         self.watermark_options = attributes[:'WatermarkOptions']
       end
 
+      if attributes.key?(:'PdfRecognitionMode')
+        self.pdf_recognition_mode = attributes[:'PdfRecognitionMode']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -164,6 +194,10 @@ module GroupDocsConversionCloud
         invalid_properties.push("invalid value for 'zoom', zoom cannot be nil.")
       end
 
+      if @pdf_recognition_mode.nil?
+        invalid_properties.push("invalid value for 'pdf_recognition_mode', pdf_recognition_mode cannot be nil.")
+      end
+
       return invalid_properties
     end
 
@@ -176,9 +210,26 @@ module GroupDocsConversionCloud
       return false if @height.nil?
       return false if @dpi.nil?
       return false if @zoom.nil?
+      return false if @pdf_recognition_mode.nil?
+      pdf_recognition_mode_validator = EnumAttributeValidator.new('String', ["Textbox", "Flow"])
+      return false unless pdf_recognition_mode_validator.valid?(@pdf_recognition_mode)
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pdf_recognition_mode Object to be assigned
+    def pdf_recognition_mode=(pdf_recognition_mode)
+      validator = EnumAttributeValidator.new('String', ["Textbox", "Flow"])
+      if pdf_recognition_mode.to_i == 0
+        unless validator.valid?(pdf_recognition_mode)
+          raise ArgumentError, "invalid value for 'pdf_recognition_mode', must be one of #{validator.allowable_values}."
+        end
+        @pdf_recognition_mode = pdf_recognition_mode
+      else
+        @pdf_recognition_mode = validator.allowable_values[pdf_recognition_mode.to_i]
+      end
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(other)
@@ -192,7 +243,8 @@ module GroupDocsConversionCloud
           dpi == other.dpi &&
           password == other.password &&
           zoom == other.zoom &&
-          watermark_options == other.watermark_options
+          watermark_options == other.watermark_options &&
+          pdf_recognition_mode == other.pdf_recognition_mode
     end
 
     # @see the `==` method
@@ -204,7 +256,7 @@ module GroupDocsConversionCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [from_page, pages_count, pages, width, height, dpi, password, zoom, watermark_options].hash
+      [from_page, pages_count, pages, width, height, dpi, password, zoom, watermark_options, pdf_recognition_mode].hash
     end
 
     # Downcases first letter.