groupdocs_conversion_cloud 24.3 → 24.8

data/lib/groupdocs_conversion_cloud/models/operation_result.rb

@@ -0,0 +1,354 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="operation_result.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 'date'
+
+module GroupDocsConversionCloud
+  # Operation status result
+  class OperationResult
+    attr_accessor :id
+    attr_accessor :method
+    attr_accessor :status
+    attr_accessor :created
+    attr_accessor :started
+    attr_accessor :failed
+    attr_accessor :canceled
+    attr_accessor :finished
+    attr_accessor :result
+    attr_accessor :error
+    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
+      {
+        :'id' => :'Id',
+        :'method' => :'Method',
+        :'status' => :'Status',
+        :'created' => :'Created',
+        :'started' => :'Started',
+        :'failed' => :'Failed',
+        :'canceled' => :'Canceled',
+        :'finished' => :'Finished',
+        :'result' => :'Result',
+        :'error' => :'Error'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'method' => :'String',
+        :'status' => :'String',
+        :'created' => :'DateTime',
+        :'started' => :'DateTime',
+        :'failed' => :'DateTime',
+        :'canceled' => :'DateTime',
+        :'finished' => :'DateTime',
+        :'result' => :'Array<StoredConvertedResult>',
+        :'error' => :'String'
+      }
+    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?(:'Id')
+        self.id = attributes[:'Id']
+      end
+
+      if attributes.key?(:'Method')
+        self.method = attributes[:'Method']
+      end
+
+      if attributes.key?(:'Status')
+        self.status = attributes[:'Status']
+      end
+
+      if attributes.key?(:'Created')
+        self.created = attributes[:'Created']
+      end
+
+      if attributes.key?(:'Started')
+        self.started = attributes[:'Started']
+      end
+
+      if attributes.key?(:'Failed')
+        self.failed = attributes[:'Failed']
+      end
+
+      if attributes.key?(:'Canceled')
+        self.canceled = attributes[:'Canceled']
+      end
+
+      if attributes.key?(:'Finished')
+        self.finished = attributes[:'Finished']
+      end
+
+      if attributes.key?(:'Result')
+        if (value = attributes[:'Result']).is_a?(Array)
+          self.result = value
+        end
+      end
+
+      if attributes.key?(:'Error')
+        self.error = attributes[:'Error']
+      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 @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @method.nil?
+        invalid_properties.push("invalid value for 'method', method cannot be nil.")
+      end
+
+      if @status.nil?
+        invalid_properties.push("invalid value for 'status', status 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 @id.nil?
+      return false if @method.nil?
+      method_validator = EnumAttributeValidator.new('String', ["Convert", "ConvertAndSave"])
+      return false unless method_validator.valid?(@method)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["Created", "Started", "Failed", "Canceled", "Finished"])
+      return false unless status_validator.valid?(@status)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] method Object to be assigned
+    def method=(method)
+      validator = EnumAttributeValidator.new('String', ["Convert", "ConvertAndSave"])
+      if method.to_i == 0
+        unless validator.valid?(method)
+          raise ArgumentError, "invalid value for 'method', must be one of #{validator.allowable_values}."
+        end
+        @method = method
+      else
+        @method = validator.allowable_values[method.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["Created", "Started", "Failed", "Canceled", "Finished"])
+      if status.to_i == 0
+        unless validator.valid?(status)
+          raise ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
+        end
+        @status = status
+      else
+        @status = validator.allowable_values[status.to_i]
+      end
+    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 &&
+          id == other.id &&
+          method == other.method &&
+          status == other.status &&
+          created == other.created &&
+          started == other.started &&
+          failed == other.failed &&
+          canceled == other.canceled &&
+          finished == other.finished &&
+          result == other.result &&
+          error == other.error
+    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
+      [id, method, status, created, started, failed, canceled, finished, result, error].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/ost_load_options.rb

@@ -40,9 +40,6 @@ module GroupDocsConversionCloud
     # Option to display or hide \"from\" email address. Default: true
     attr_accessor :display_from_email_address
 
-    # Option to display or hide email address. Default: true
-    attr_accessor :display_email_address
-
     # Option to display or hide \"to\" email address. Default: true
     attr_accessor :display_to_email_address
 
@@ -70,7 +67,6 @@ module GroupDocsConversionCloud
         :'format' => :'Format',
         :'display_header' => :'DisplayHeader',
         :'display_from_email_address' => :'DisplayFromEmailAddress',
-        :'display_email_address' => :'DisplayEmailAddress',
         :'display_to_email_address' => :'DisplayToEmailAddress',
         :'display_cc_email_address' => :'DisplayCcEmailAddress',
         :'display_bcc_email_address' => :'DisplayBccEmailAddress',
@@ -87,7 +83,6 @@ module GroupDocsConversionCloud
         :'format' => :'String',
         :'display_header' => :'BOOLEAN',
         :'display_from_email_address' => :'BOOLEAN',
-        :'display_email_address' => :'BOOLEAN',
         :'display_to_email_address' => :'BOOLEAN',
         :'display_cc_email_address' => :'BOOLEAN',
         :'display_bcc_email_address' => :'BOOLEAN',
@@ -118,10 +113,6 @@ module GroupDocsConversionCloud
         self.display_from_email_address = attributes[:'DisplayFromEmailAddress']
       end
 
-      if attributes.key?(:'DisplayEmailAddress')
-        self.display_email_address = attributes[:'DisplayEmailAddress']
-      end
-
       if attributes.key?(:'DisplayToEmailAddress')
         self.display_to_email_address = attributes[:'DisplayToEmailAddress']
       end
@@ -166,10 +157,6 @@ module GroupDocsConversionCloud
         invalid_properties.push("invalid value for 'display_from_email_address', display_from_email_address cannot be nil.")
       end
 
-      if @display_email_address.nil?
-        invalid_properties.push("invalid value for 'display_email_address', display_email_address cannot be nil.")
-      end
-
       if @display_to_email_address.nil?
         invalid_properties.push("invalid value for 'display_to_email_address', display_to_email_address cannot be nil.")
       end
@@ -198,7 +185,6 @@ module GroupDocsConversionCloud
     def valid?
       return false if @display_header.nil?
       return false if @display_from_email_address.nil?
-      return false if @display_email_address.nil?
       return false if @display_to_email_address.nil?
       return false if @display_cc_email_address.nil?
       return false if @display_bcc_email_address.nil?
@@ -215,7 +201,6 @@ module GroupDocsConversionCloud
           format == other.format &&
           display_header == other.display_header &&
           display_from_email_address == other.display_from_email_address &&
-          display_email_address == other.display_email_address &&
           display_to_email_address == other.display_to_email_address &&
           display_cc_email_address == other.display_cc_email_address &&
           display_bcc_email_address == other.display_bcc_email_address &&
@@ -234,7 +219,7 @@ module GroupDocsConversionCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [format, display_header, display_from_email_address, display_email_address, display_to_email_address, display_cc_email_address, display_bcc_email_address, time_zone_offset, convert_attachments, field_labels, preserve_original_date].hash
+      [format, display_header, display_from_email_address, display_to_email_address, display_cc_email_address, display_bcc_email_address, time_zone_offset, convert_attachments, field_labels, preserve_original_date].hash
     end
 
     # Downcases first letter.

data/lib/groupdocs_conversion_cloud/models/plt_load_options.rb

@@ -34,22 +34,43 @@ module GroupDocsConversionCloud
     # The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
     attr_accessor :format
 
-    # Set desired page width for converting CAD document
-    attr_accessor :width
-
-    # Set desired page height for converting CAD document
-    attr_accessor :height
-
     # Render specific CAD layouts
     attr_accessor :layout_names
 
+    # Gets or sets a background color.
+    attr_accessor :background_color
+
+    # Gets or sets type of drawing.
+    attr_accessor :draw_type
+    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
       {
         :'format' => :'Format',
-        :'width' => :'Width',
-        :'height' => :'Height',
-        :'layout_names' => :'LayoutNames'
+        :'layout_names' => :'LayoutNames',
+        :'background_color' => :'BackgroundColor',
+        :'draw_type' => :'DrawType'
       }
     end
 
@@ -57,9 +78,9 @@ module GroupDocsConversionCloud
     def self.swagger_types
       {
         :'format' => :'String',
-        :'width' => :'Integer',
-        :'height' => :'Integer',
-        :'layout_names' => :'Array<String>'
+        :'layout_names' => :'Array<String>',
+        :'background_color' => :'String',
+        :'draw_type' => :'String'
       }
     end
 
@@ -75,32 +96,28 @@ module GroupDocsConversionCloud
         self.format = attributes[:'Format']
       end
 
-      if attributes.key?(:'Width')
-        self.width = attributes[:'Width']
-      end
-
-      if attributes.key?(:'Height')
-        self.height = attributes[:'Height']
-      end
-
       if attributes.key?(:'LayoutNames')
         if (value = attributes[:'LayoutNames']).is_a?(Array)
           self.layout_names = value
         end
       end
 
+      if attributes.key?(:'BackgroundColor')
+        self.background_color = attributes[:'BackgroundColor']
+      end
+
+      if attributes.key?(:'DrawType')
+        self.draw_type = attributes[:'DrawType']
+      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 @width.nil?
-        invalid_properties.push("invalid value for 'width', width cannot be nil.")
-      end
-
-      if @height.nil?
-        invalid_properties.push("invalid value for 'height', height cannot be nil.")
+      if @draw_type.nil?
+        invalid_properties.push("invalid value for 'draw_type', draw_type cannot be nil.")
       end
 
       return invalid_properties
@@ -109,20 +126,35 @@ module GroupDocsConversionCloud
     # 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 @width.nil?
-      return false if @height.nil?
+      return false if @draw_type.nil?
+      draw_type_validator = EnumAttributeValidator.new('String', ["UseDrawColor", "UseObjectColor"])
+      return false unless draw_type_validator.valid?(@draw_type)
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] draw_type Object to be assigned
+    def draw_type=(draw_type)
+      validator = EnumAttributeValidator.new('String', ["UseDrawColor", "UseObjectColor"])
+      if draw_type.to_i == 0
+        unless validator.valid?(draw_type)
+          raise ArgumentError, "invalid value for 'draw_type', must be one of #{validator.allowable_values}."
+        end
+        @draw_type = draw_type
+      else
+        @draw_type = validator.allowable_values[draw_type.to_i]
+      end
+    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 &&
           format == other.format &&
-          width == other.width &&
-          height == other.height &&
-          layout_names == other.layout_names
+          layout_names == other.layout_names &&
+          background_color == other.background_color &&
+          draw_type == other.draw_type
     end
 
     # @see the `==` method
@@ -134,7 +166,7 @@ module GroupDocsConversionCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [format, width, height, layout_names].hash
+      [format, layout_names, background_color, draw_type].hash
     end
 
     # Downcases first letter.

data/lib/groupdocs_conversion_cloud/models/pst_load_options.rb

@@ -40,9 +40,6 @@ module GroupDocsConversionCloud
     # Option to display or hide \"from\" email address. Default: true
     attr_accessor :display_from_email_address
 
-    # Option to display or hide email address. Default: true
-    attr_accessor :display_email_address
-
     # Option to display or hide \"to\" email address. Default: true
     attr_accessor :display_to_email_address
 
@@ -70,7 +67,6 @@ module GroupDocsConversionCloud
         :'format' => :'Format',
         :'display_header' => :'DisplayHeader',
         :'display_from_email_address' => :'DisplayFromEmailAddress',
-        :'display_email_address' => :'DisplayEmailAddress',
         :'display_to_email_address' => :'DisplayToEmailAddress',
         :'display_cc_email_address' => :'DisplayCcEmailAddress',
         :'display_bcc_email_address' => :'DisplayBccEmailAddress',
@@ -87,7 +83,6 @@ module GroupDocsConversionCloud
         :'format' => :'String',
         :'display_header' => :'BOOLEAN',
         :'display_from_email_address' => :'BOOLEAN',
-        :'display_email_address' => :'BOOLEAN',
         :'display_to_email_address' => :'BOOLEAN',
         :'display_cc_email_address' => :'BOOLEAN',
         :'display_bcc_email_address' => :'BOOLEAN',
@@ -118,10 +113,6 @@ module GroupDocsConversionCloud
         self.display_from_email_address = attributes[:'DisplayFromEmailAddress']
       end
 
-      if attributes.key?(:'DisplayEmailAddress')
-        self.display_email_address = attributes[:'DisplayEmailAddress']
-      end
-
       if attributes.key?(:'DisplayToEmailAddress')
         self.display_to_email_address = attributes[:'DisplayToEmailAddress']
       end
@@ -166,10 +157,6 @@ module GroupDocsConversionCloud
         invalid_properties.push("invalid value for 'display_from_email_address', display_from_email_address cannot be nil.")
       end
 
-      if @display_email_address.nil?
-        invalid_properties.push("invalid value for 'display_email_address', display_email_address cannot be nil.")
-      end
-
       if @display_to_email_address.nil?
         invalid_properties.push("invalid value for 'display_to_email_address', display_to_email_address cannot be nil.")
       end
@@ -198,7 +185,6 @@ module GroupDocsConversionCloud
     def valid?
       return false if @display_header.nil?
       return false if @display_from_email_address.nil?
-      return false if @display_email_address.nil?
       return false if @display_to_email_address.nil?
       return false if @display_cc_email_address.nil?
       return false if @display_bcc_email_address.nil?
@@ -215,7 +201,6 @@ module GroupDocsConversionCloud
           format == other.format &&
           display_header == other.display_header &&
           display_from_email_address == other.display_from_email_address &&
-          display_email_address == other.display_email_address &&
           display_to_email_address == other.display_to_email_address &&
           display_cc_email_address == other.display_cc_email_address &&
           display_bcc_email_address == other.display_bcc_email_address &&
@@ -234,7 +219,7 @@ module GroupDocsConversionCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [format, display_header, display_from_email_address, display_email_address, display_to_email_address, display_cc_email_address, display_bcc_email_address, time_zone_offset, convert_attachments, field_labels, preserve_original_date].hash
+      [format, display_header, display_from_email_address, display_to_email_address, display_cc_email_address, display_bcc_email_address, time_zone_offset, convert_attachments, field_labels, preserve_original_date].hash
     end
 
     # Downcases first letter.