cloudmersive-convert-api-client 1.2.8 → 1.2.9

data/lib/cloudmersive-convert-api-client/models/get_image_info_result.rb

@@ -0,0 +1,350 @@
+=begin
+#convertapi
+
+#Convert API lets you effortlessly convert file formats and types.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module CloudmersiveConvertApiClient
+  # Result of running a get-info operation on an image
+  class GetImageInfoResult
+    attr_accessor :successful
+
+    # Color space of the image
+    attr_accessor :color_space
+
+    # Color type of the image
+    attr_accessor :color_type
+
+    # Width in pixels of the image
+    attr_accessor :width
+
+    # Height in pixels of the image
+    attr_accessor :height
+
+    # Compression level value from 0 (lowest quality) to 100 (highest quality)
+    attr_accessor :compression_level
+
+    # SHA256 hash signature of the image
+    attr_accessor :image_hash_signature
+
+    # True if the image contains transparency, otherwise false
+    attr_accessor :has_transparency
+
+    # MIME type of the image format
+    attr_accessor :mime_type
+
+    # Image format
+    attr_accessor :image_format
+
+    # Units of the DPI measurement; can be either in Inches or Centimeters
+    attr_accessor :dpi_unit
+
+    # DPI (pixels per unit, e.g. pixels per inch) of the image
+    attr_accessor :dpi
+
+    # Unique colors in the image
+    attr_accessor :color_count
+
+    # Bit depth of the image
+    attr_accessor :bit_depth
+
+    # Comment string in the image
+    attr_accessor :comment
+
+    # Name of the EXIF profile used
+    attr_accessor :exif_profile_name
+
+    # EXIF tags and values embedded in the image
+    attr_accessor :exif_values
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'color_space' => :'ColorSpace',
+        :'color_type' => :'ColorType',
+        :'width' => :'Width',
+        :'height' => :'Height',
+        :'compression_level' => :'CompressionLevel',
+        :'image_hash_signature' => :'ImageHashSignature',
+        :'has_transparency' => :'HasTransparency',
+        :'mime_type' => :'MimeType',
+        :'image_format' => :'ImageFormat',
+        :'dpi_unit' => :'DPIUnit',
+        :'dpi' => :'DPI',
+        :'color_count' => :'ColorCount',
+        :'bit_depth' => :'BitDepth',
+        :'comment' => :'Comment',
+        :'exif_profile_name' => :'ExifProfileName',
+        :'exif_values' => :'ExifValues'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'color_space' => :'String',
+        :'color_type' => :'String',
+        :'width' => :'Integer',
+        :'height' => :'Integer',
+        :'compression_level' => :'Integer',
+        :'image_hash_signature' => :'String',
+        :'has_transparency' => :'BOOLEAN',
+        :'mime_type' => :'String',
+        :'image_format' => :'String',
+        :'dpi_unit' => :'String',
+        :'dpi' => :'Float',
+        :'color_count' => :'Integer',
+        :'bit_depth' => :'Integer',
+        :'comment' => :'String',
+        :'exif_profile_name' => :'String',
+        :'exif_values' => :'Array<ExifValue>'
+      }
+    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.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'ColorSpace')
+        self.color_space = attributes[:'ColorSpace']
+      end
+
+      if attributes.has_key?(:'ColorType')
+        self.color_type = attributes[:'ColorType']
+      end
+
+      if attributes.has_key?(:'Width')
+        self.width = attributes[:'Width']
+      end
+
+      if attributes.has_key?(:'Height')
+        self.height = attributes[:'Height']
+      end
+
+      if attributes.has_key?(:'CompressionLevel')
+        self.compression_level = attributes[:'CompressionLevel']
+      end
+
+      if attributes.has_key?(:'ImageHashSignature')
+        self.image_hash_signature = attributes[:'ImageHashSignature']
+      end
+
+      if attributes.has_key?(:'HasTransparency')
+        self.has_transparency = attributes[:'HasTransparency']
+      end
+
+      if attributes.has_key?(:'MimeType')
+        self.mime_type = attributes[:'MimeType']
+      end
+
+      if attributes.has_key?(:'ImageFormat')
+        self.image_format = attributes[:'ImageFormat']
+      end
+
+      if attributes.has_key?(:'DPIUnit')
+        self.dpi_unit = attributes[:'DPIUnit']
+      end
+
+      if attributes.has_key?(:'DPI')
+        self.dpi = attributes[:'DPI']
+      end
+
+      if attributes.has_key?(:'ColorCount')
+        self.color_count = attributes[:'ColorCount']
+      end
+
+      if attributes.has_key?(:'BitDepth')
+        self.bit_depth = attributes[:'BitDepth']
+      end
+
+      if attributes.has_key?(:'Comment')
+        self.comment = attributes[:'Comment']
+      end
+
+      if attributes.has_key?(:'ExifProfileName')
+        self.exif_profile_name = attributes[:'ExifProfileName']
+      end
+
+      if attributes.has_key?(:'ExifValues')
+        if (value = attributes[:'ExifValues']).is_a?(Array)
+          self.exif_values = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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 true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          successful == o.successful &&
+          color_space == o.color_space &&
+          color_type == o.color_type &&
+          width == o.width &&
+          height == o.height &&
+          compression_level == o.compression_level &&
+          image_hash_signature == o.image_hash_signature &&
+          has_transparency == o.has_transparency &&
+          mime_type == o.mime_type &&
+          image_format == o.image_format &&
+          dpi_unit == o.dpi_unit &&
+          dpi == o.dpi &&
+          color_count == o.color_count &&
+          bit_depth == o.bit_depth &&
+          comment == o.comment &&
+          exif_profile_name == o.exif_profile_name &&
+          exif_values == o.exif_values
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [successful, color_space, color_type, width, height, compression_level, image_hash_signature, has_transparency, mime_type, image_format, dpi_unit, dpi, color_count, bit_depth, comment, exif_profile_name, exif_values].hash
+    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|
+        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 attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        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
+        DateTime.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 = CloudmersiveConvertApiClient.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/cloudmersive-convert-api-client/models/get_xlsx_columns_request.rb

@@ -0,0 +1,225 @@
+=begin
+#convertapi
+
+#Convert API lets you effortlessly convert file formats and types.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module CloudmersiveConvertApiClient
+  # Input to a Get Columns request
+  class GetXlsxColumnsRequest
+    # Optional: Bytes of the input file to operate on
+    attr_accessor :input_file_bytes
+
+    # Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
+    attr_accessor :input_file_url
+
+    # Optional; Worksheet (tab) within the spreadsheet to get the columns of; leave blank to default to the first worksheet
+    attr_accessor :worksheet_to_query
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_file_bytes' => :'InputFileBytes',
+        :'input_file_url' => :'InputFileUrl',
+        :'worksheet_to_query' => :'WorksheetToQuery'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'input_file_bytes' => :'String',
+        :'input_file_url' => :'String',
+        :'worksheet_to_query' => :'XlsxWorksheet'
+      }
+    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.has_key?(:'InputFileBytes')
+        self.input_file_bytes = attributes[:'InputFileBytes']
+      end
+
+      if attributes.has_key?(:'InputFileUrl')
+        self.input_file_url = attributes[:'InputFileUrl']
+      end
+
+      if attributes.has_key?(:'WorksheetToQuery')
+        self.worksheet_to_query = attributes[:'WorksheetToQuery']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        invalid_properties.push("invalid value for 'input_file_bytes', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
+      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 !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] input_file_bytes Value to be assigned
+    def input_file_bytes=(input_file_bytes)
+
+      if !input_file_bytes.nil? && input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        fail ArgumentError, "invalid value for 'input_file_bytes', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
+      end
+
+      @input_file_bytes = input_file_bytes
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          input_file_bytes == o.input_file_bytes &&
+          input_file_url == o.input_file_url &&
+          worksheet_to_query == o.worksheet_to_query
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [input_file_bytes, input_file_url, worksheet_to_query].hash
+    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|
+        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 attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        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
+        DateTime.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 = CloudmersiveConvertApiClient.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