groupdocs_viewer_cloud 21.3 → 21.8

data/lib/groupdocs_viewer_cloud/models/mail_storage_options.rb

@@ -0,0 +1,239 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="mail_storage_options.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 GroupDocsViewerCloud
+  # Provides options for rendering Mail storage (Lotus Notes, MBox) data files.
+  class MailStorageOptions
+
+    # The keywords used to filter messages.
+    attr_accessor :text_filter
+
+    # The email-address used to filter messages by sender or recipient.
+    attr_accessor :address_filter
+
+    # The maximum number of messages or items for render. Default value is 0 - all messages will be rendered
+    attr_accessor :max_items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'text_filter' => :'TextFilter',
+        :'address_filter' => :'AddressFilter',
+        :'max_items' => :'MaxItems'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'text_filter' => :'String',
+        :'address_filter' => :'String',
+        :'max_items' => :'Integer'
+      }
+    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?(:'TextFilter')
+        self.text_filter = attributes[:'TextFilter']
+      end
+
+      if attributes.key?(:'AddressFilter')
+        self.address_filter = attributes[:'AddressFilter']
+      end
+
+      if attributes.key?(:'MaxItems')
+        self.max_items = attributes[:'MaxItems']
+      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 @max_items.nil?
+        invalid_properties.push("invalid value for 'max_items', max_items 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 @max_items.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 &&
+          text_filter == other.text_filter &&
+          address_filter == other.address_filter &&
+          max_items == other.max_items
+    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
+      [text_filter, address_filter, max_items].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 = GroupDocsViewerCloud.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_viewer_cloud/models/pdf_document_options.rb

@@ -45,6 +45,9 @@ module GroupDocsViewerCloud
 
     # Specifies output image quality for image resources when rendering into HTML. The default value is Low
     attr_accessor :image_quality
+
+    # When this option is set to true, the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. This option is supported when rendering into HTML.
+    attr_accessor :render_text_as_image
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -74,7 +77,8 @@ module GroupDocsViewerCloud
         :'enable_layered_rendering' => :'EnableLayeredRendering',
         :'enable_font_hinting' => :'EnableFontHinting',
         :'render_original_page_size' => :'RenderOriginalPageSize',
-        :'image_quality' => :'ImageQuality'
+        :'image_quality' => :'ImageQuality',
+        :'render_text_as_image' => :'RenderTextAsImage'
       }
     end
 
@@ -85,7 +89,8 @@ module GroupDocsViewerCloud
         :'enable_layered_rendering' => :'BOOLEAN',
         :'enable_font_hinting' => :'BOOLEAN',
         :'render_original_page_size' => :'BOOLEAN',
-        :'image_quality' => :'String'
+        :'image_quality' => :'String',
+        :'render_text_as_image' => :'BOOLEAN'
       }
     end
 
@@ -117,6 +122,10 @@ module GroupDocsViewerCloud
         self.image_quality = attributes[:'ImageQuality']
       end
 
+      if attributes.key?(:'RenderTextAsImage')
+        self.render_text_as_image = attributes[:'RenderTextAsImage']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -143,6 +152,10 @@ module GroupDocsViewerCloud
         invalid_properties.push("invalid value for 'image_quality', image_quality cannot be nil.")
       end
 
+      if @render_text_as_image.nil?
+        invalid_properties.push("invalid value for 'render_text_as_image', render_text_as_image cannot be nil.")
+      end
+
       return invalid_properties
     end
 
@@ -156,6 +169,7 @@ module GroupDocsViewerCloud
       return false if @image_quality.nil?
       image_quality_validator = EnumAttributeValidator.new('String', ["Low", "Medium", "High"])
       return false unless image_quality_validator.valid?(@image_quality)
+      return false if @render_text_as_image.nil?
       return true
     end
 
@@ -182,7 +196,8 @@ module GroupDocsViewerCloud
           enable_layered_rendering == other.enable_layered_rendering &&
           enable_font_hinting == other.enable_font_hinting &&
           render_original_page_size == other.render_original_page_size &&
-          image_quality == other.image_quality
+          image_quality == other.image_quality &&
+          render_text_as_image == other.render_text_as_image
     end
 
     # @see the `==` method
@@ -194,7 +209,7 @@ module GroupDocsViewerCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [disable_chars_grouping, enable_layered_rendering, enable_font_hinting, render_original_page_size, image_quality].hash
+      [disable_chars_grouping, enable_layered_rendering, enable_font_hinting, render_original_page_size, image_quality, render_text_as_image].hash
     end
 
     # Downcases first letter.

data/lib/groupdocs_viewer_cloud/models/pdf_options.rb

@@ -82,6 +82,15 @@ module GroupDocsViewerCloud
     # Rendering options for Archive source file formats
     attr_accessor :archive_options
 
+    # Rendering options for Text source file formats
+    attr_accessor :text_options
+
+    # Rendering options for Mail storage (Lotus Notes, MBox) data files.
+    attr_accessor :mail_storage_options
+
+    # Rendering options for Visio source file formats
+    attr_accessor :visio_rendering_options
+
     # The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90
     attr_accessor :jpg_quality
 
@@ -94,6 +103,18 @@ module GroupDocsViewerCloud
     # The array of PDF document permissions. Allowed values are: AllowAll, DenyPrinting, DenyModification, DenyDataExtraction, DenyAll Default value is AllowAll, if now permissions are set.
     attr_accessor :permissions
 
+    # Max width of an output image in pixels. (When converting single image to HTML only)
+    attr_accessor :image_max_width
+
+    # Max height of an output image in pixels. (When converting single image to HTML only)
+    attr_accessor :image_max_height
+
+    # The width of the output image in pixels. (When converting single image to HTML only)
+    attr_accessor :image_width
+
+    # The height of an output image in pixels. (When converting single image to HTML only)
+    attr_accessor :image_height
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -114,10 +135,17 @@ module GroupDocsViewerCloud
         :'word_processing_options' => :'WordProcessingOptions',
         :'outlook_options' => :'OutlookOptions',
         :'archive_options' => :'ArchiveOptions',
+        :'text_options' => :'TextOptions',
+        :'mail_storage_options' => :'MailStorageOptions',
+        :'visio_rendering_options' => :'VisioRenderingOptions',
         :'jpg_quality' => :'JpgQuality',
         :'document_open_password' => :'DocumentOpenPassword',
         :'permissions_password' => :'PermissionsPassword',
-        :'permissions' => :'Permissions'
+        :'permissions' => :'Permissions',
+        :'image_max_width' => :'ImageMaxWidth',
+        :'image_max_height' => :'ImageMaxHeight',
+        :'image_width' => :'ImageWidth',
+        :'image_height' => :'ImageHeight'
       }
     end
 
@@ -141,10 +169,17 @@ module GroupDocsViewerCloud
         :'word_processing_options' => :'WordProcessingOptions',
         :'outlook_options' => :'OutlookOptions',
         :'archive_options' => :'ArchiveOptions',
+        :'text_options' => :'TextOptions',
+        :'mail_storage_options' => :'MailStorageOptions',
+        :'visio_rendering_options' => :'VisioRenderingOptions',
         :'jpg_quality' => :'Integer',
         :'document_open_password' => :'String',
         :'permissions_password' => :'String',
-        :'permissions' => :'Array<String>'
+        :'permissions' => :'Array<String>',
+        :'image_max_width' => :'Integer',
+        :'image_max_height' => :'Integer',
+        :'image_width' => :'Integer',
+        :'image_height' => :'Integer'
       }
     end
 
@@ -228,6 +263,18 @@ module GroupDocsViewerCloud
         self.archive_options = attributes[:'ArchiveOptions']
       end
 
+      if attributes.key?(:'TextOptions')
+        self.text_options = attributes[:'TextOptions']
+      end
+
+      if attributes.key?(:'MailStorageOptions')
+        self.mail_storage_options = attributes[:'MailStorageOptions']
+      end
+
+      if attributes.key?(:'VisioRenderingOptions')
+        self.visio_rendering_options = attributes[:'VisioRenderingOptions']
+      end
+
       if attributes.key?(:'JpgQuality')
         self.jpg_quality = attributes[:'JpgQuality']
       end
@@ -246,6 +293,22 @@ module GroupDocsViewerCloud
         end
       end
 
+      if attributes.key?(:'ImageMaxWidth')
+        self.image_max_width = attributes[:'ImageMaxWidth']
+      end
+
+      if attributes.key?(:'ImageMaxHeight')
+        self.image_max_height = attributes[:'ImageMaxHeight']
+      end
+
+      if attributes.key?(:'ImageWidth')
+        self.image_width = attributes[:'ImageWidth']
+      end
+
+      if attributes.key?(:'ImageHeight')
+        self.image_height = attributes[:'ImageHeight']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -276,6 +339,22 @@ module GroupDocsViewerCloud
         invalid_properties.push("invalid value for 'jpg_quality', jpg_quality cannot be nil.")
       end
 
+      if @image_max_width.nil?
+        invalid_properties.push("invalid value for 'image_max_width', image_max_width cannot be nil.")
+      end
+
+      if @image_max_height.nil?
+        invalid_properties.push("invalid value for 'image_max_height', image_max_height cannot be nil.")
+      end
+
+      if @image_width.nil?
+        invalid_properties.push("invalid value for 'image_width', image_width cannot be nil.")
+      end
+
+      if @image_height.nil?
+        invalid_properties.push("invalid value for 'image_height', image_height cannot be nil.")
+      end
+
       return invalid_properties
     end
 
@@ -288,6 +367,10 @@ module GroupDocsViewerCloud
       return false if @render_notes.nil?
       return false if @render_hidden_pages.nil?
       return false if @jpg_quality.nil?
+      return false if @image_max_width.nil?
+      return false if @image_max_height.nil?
+      return false if @image_width.nil?
+      return false if @image_height.nil?
       return true
     end
 
@@ -313,10 +396,17 @@ module GroupDocsViewerCloud
           word_processing_options == other.word_processing_options &&
           outlook_options == other.outlook_options &&
           archive_options == other.archive_options &&
+          text_options == other.text_options &&
+          mail_storage_options == other.mail_storage_options &&
+          visio_rendering_options == other.visio_rendering_options &&
           jpg_quality == other.jpg_quality &&
           document_open_password == other.document_open_password &&
           permissions_password == other.permissions_password &&
-          permissions == other.permissions
+          permissions == other.permissions &&
+          image_max_width == other.image_max_width &&
+          image_max_height == other.image_max_height &&
+          image_width == other.image_width &&
+          image_height == other.image_height
     end
 
     # @see the `==` method
@@ -328,7 +418,7 @@ module GroupDocsViewerCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [start_page_number, count_pages_to_render, pages_to_render, page_rotations, default_font_name, default_encoding, render_comments, render_notes, render_hidden_pages, spreadsheet_options, cad_options, email_options, project_management_options, pdf_document_options, word_processing_options, outlook_options, archive_options, jpg_quality, document_open_password, permissions_password, permissions].hash
+      [start_page_number, count_pages_to_render, pages_to_render, page_rotations, default_font_name, default_encoding, render_comments, render_notes, render_hidden_pages, spreadsheet_options, cad_options, email_options, project_management_options, pdf_document_options, word_processing_options, outlook_options, archive_options, text_options, mail_storage_options, visio_rendering_options, jpg_quality, document_open_password, permissions_password, permissions, image_max_width, image_max_height, image_width, image_height].hash
     end
 
     # Downcases first letter.