groupdocs_conversion_cloud 25.5 → 25.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 645be37f44377ac287345c3956a3da7945bb7e6b6260f374731604ac4aceb635
-  data.tar.gz: f2a8aba7d205d0d7eb83a42f43b738f28fbfd350bd15be8f4b7860a2e5719d29
+  metadata.gz: a32da8c9bbef0cca2fe3cd8a44a50736faef82ba5e27451252cd41cf2b41c6b5
+  data.tar.gz: 0f499c0dd26883d00c153dc5d61a82eb3c87e7b7ae0ace4aa281a90c081251c0
 SHA512:
-  metadata.gz: 4416d35931324dd36204b593747dddec626758787fb87f16870efb83d510b04d1812f8fb8df49bc37f3890546bc6f35f6c21a04682ccb7794222c8eb59c16b1f
-  data.tar.gz: '0094040627a33ca0b7c0aaf80b278eae56fb0b8471b1566dfc26378403aaedda0b562d3cbdc23345a0c7fa7a52d1f8b2841ffc72802aff79ab2d8a7ec9aa7083'
+  metadata.gz: 2ee15e7c2894e7e9b4c818ebef3079d356e0638f8a36490fce6dd2e7a0a3b532dc9836160212fda50dd8c0456328198b21e466ee26676a73b0f3c881139e1b1c
+  data.tar.gz: cf96ea77a3d3cada4d7d4495419d0b8ff6b440fd31e7c7745b69d6443e057ffdb7f4c76de25987a0165b7eea7548013c081a8e969bb891103bbbbe39b534e670

data/lib/groupdocs_conversion_cloud/models/doc_load_options.rb

@@ -37,9 +37,6 @@ module GroupDocsConversionCloud
     # Default font for Words document. The following font will be used if a font is missing.
     attr_accessor :default_font
 
-    # If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled, GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources. Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.
-    attr_accessor :auto_font_substitution
-
     # Substitute specific fonts when converting Words document.
     attr_accessor :font_substitutes
 
@@ -49,9 +46,6 @@ module GroupDocsConversionCloud
     # Hide markup and track changes for Word documents
     attr_accessor :hide_word_tracked_changes
 
-    # Hide comments
-    attr_accessor :hide_comments
-
     # Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.
     attr_accessor :bookmarks_outline_level
 
@@ -61,19 +55,122 @@ module GroupDocsConversionCloud
     # Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.
     attr_accessor :expanded_outline_levels
 
+    # Clear custom document properties. Default is false.
+    attr_accessor :clear_custom_document_properties
+
+    # Clear built-in document properties. Default is false.
+    attr_accessor :clear_built_in_document_properties
+
+    # Option to control how many levels in depth to perform conversion. Default: 1.
+    attr_accessor :depth
+
+    # Option to control whether the owned documents in the documents container must be converted
+    attr_accessor :convert_owned
+
+    # Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document. Default is true.
+    attr_accessor :convert_owner
+
+    # Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is false.
+    attr_accessor :auto_hyphenation
+
+    # Gets or sets value determining whether words written in all capital letters are hyphenated. Default value for this property is true.
+    attr_accessor :hyphenate_caps
+
+    # Enable or disable generation of page numbering in converted document. Default: false
+    attr_accessor :page_numbering
+
+    # Determines whether the document structure should be preserved when converting to PDF (default is false).
+    attr_accessor :preserve_document_structure
+
+    # If true all external resource will not be loading. Default is true.
+    attr_accessor :skip_external_resources
+
+    # Specifies whether to use a text shaper for better kerning display. Default is false.
+    attr_accessor :use_text_shaper
+
+    # Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.
+    attr_accessor :preserve_form_fields
+
+    # Specifies how comments should be displayed in the output document. Default is Balloon.
+    attr_accessor :comment_display_mode
+
+    # Keep original value of date field. Default: false
+    attr_accessor :keep_date_field_original_value
+
+    # Update fields after loading. Default: false
+    attr_accessor :update_fields
+
+    # Update page layout after loading. Default: false
+    attr_accessor :update_page_layout
+
+    # If EmbedTrueTypeFonts is true, GroupDocs.Conversion Cloud embed true type fonts in the output document. Default: true
+    attr_accessor :embed_true_type_fonts
+
+    # Automatically substitutes missing fonts based on FontInfo in the document. Default: false.
+    attr_accessor :font_info_substitution_enabled
+
+    # Automatically substitutes missing fonts based on FontConfig in the system. Default: false.
+    attr_accessor :font_config_substitution_enabled
+
+    # Automatically substitutes missing fonts based on the font name. Default: false.
+    attr_accessor :font_name_substitution_enabled
+
+    # Show full commenter name in comments. Default is false.
+    attr_accessor :show_full_commenter_name
+    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',
         :'default_font' => :'DefaultFont',
-        :'auto_font_substitution' => :'AutoFontSubstitution',
         :'font_substitutes' => :'FontSubstitutes',
         :'password' => :'Password',
         :'hide_word_tracked_changes' => :'HideWordTrackedChanges',
-        :'hide_comments' => :'HideComments',
         :'bookmarks_outline_level' => :'BookmarksOutlineLevel',
         :'headings_outline_levels' => :'HeadingsOutlineLevels',
-        :'expanded_outline_levels' => :'ExpandedOutlineLevels'
+        :'expanded_outline_levels' => :'ExpandedOutlineLevels',
+        :'clear_custom_document_properties' => :'ClearCustomDocumentProperties',
+        :'clear_built_in_document_properties' => :'ClearBuiltInDocumentProperties',
+        :'depth' => :'Depth',
+        :'convert_owned' => :'ConvertOwned',
+        :'convert_owner' => :'ConvertOwner',
+        :'auto_hyphenation' => :'AutoHyphenation',
+        :'hyphenate_caps' => :'HyphenateCaps',
+        :'page_numbering' => :'PageNumbering',
+        :'preserve_document_structure' => :'PreserveDocumentStructure',
+        :'skip_external_resources' => :'SkipExternalResources',
+        :'use_text_shaper' => :'UseTextShaper',
+        :'preserve_form_fields' => :'PreserveFormFields',
+        :'comment_display_mode' => :'CommentDisplayMode',
+        :'keep_date_field_original_value' => :'KeepDateFieldOriginalValue',
+        :'update_fields' => :'UpdateFields',
+        :'update_page_layout' => :'UpdatePageLayout',
+        :'embed_true_type_fonts' => :'EmbedTrueTypeFonts',
+        :'font_info_substitution_enabled' => :'FontInfoSubstitutionEnabled',
+        :'font_config_substitution_enabled' => :'FontConfigSubstitutionEnabled',
+        :'font_name_substitution_enabled' => :'FontNameSubstitutionEnabled',
+        :'show_full_commenter_name' => :'ShowFullCommenterName'
       }
     end
 
@@ -82,14 +179,33 @@ module GroupDocsConversionCloud
       {
         :'format' => :'String',
         :'default_font' => :'String',
-        :'auto_font_substitution' => :'BOOLEAN',
         :'font_substitutes' => :'Hash<String, String>',
         :'password' => :'String',
         :'hide_word_tracked_changes' => :'BOOLEAN',
-        :'hide_comments' => :'BOOLEAN',
         :'bookmarks_outline_level' => :'Integer',
         :'headings_outline_levels' => :'Integer',
-        :'expanded_outline_levels' => :'Integer'
+        :'expanded_outline_levels' => :'Integer',
+        :'clear_custom_document_properties' => :'BOOLEAN',
+        :'clear_built_in_document_properties' => :'BOOLEAN',
+        :'depth' => :'Integer',
+        :'convert_owned' => :'BOOLEAN',
+        :'convert_owner' => :'BOOLEAN',
+        :'auto_hyphenation' => :'BOOLEAN',
+        :'hyphenate_caps' => :'BOOLEAN',
+        :'page_numbering' => :'BOOLEAN',
+        :'preserve_document_structure' => :'BOOLEAN',
+        :'skip_external_resources' => :'BOOLEAN',
+        :'use_text_shaper' => :'BOOLEAN',
+        :'preserve_form_fields' => :'BOOLEAN',
+        :'comment_display_mode' => :'String',
+        :'keep_date_field_original_value' => :'BOOLEAN',
+        :'update_fields' => :'BOOLEAN',
+        :'update_page_layout' => :'BOOLEAN',
+        :'embed_true_type_fonts' => :'BOOLEAN',
+        :'font_info_substitution_enabled' => :'BOOLEAN',
+        :'font_config_substitution_enabled' => :'BOOLEAN',
+        :'font_name_substitution_enabled' => :'BOOLEAN',
+        :'show_full_commenter_name' => :'BOOLEAN'
       }
     end
 
@@ -109,10 +225,6 @@ module GroupDocsConversionCloud
         self.default_font = attributes[:'DefaultFont']
       end
 
-      if attributes.key?(:'AutoFontSubstitution')
-        self.auto_font_substitution = attributes[:'AutoFontSubstitution']
-      end
-
       if attributes.key?(:'FontSubstitutes')
         if (value = attributes[:'FontSubstitutes']).is_a?(Hash)
           self.font_substitutes = value
@@ -127,10 +239,6 @@ module GroupDocsConversionCloud
         self.hide_word_tracked_changes = attributes[:'HideWordTrackedChanges']
       end
 
-      if attributes.key?(:'HideComments')
-        self.hide_comments = attributes[:'HideComments']
-      end
-
       if attributes.key?(:'BookmarksOutlineLevel')
         self.bookmarks_outline_level = attributes[:'BookmarksOutlineLevel']
       end
@@ -143,24 +251,100 @@ module GroupDocsConversionCloud
         self.expanded_outline_levels = attributes[:'ExpandedOutlineLevels']
       end
 
+      if attributes.key?(:'ClearCustomDocumentProperties')
+        self.clear_custom_document_properties = attributes[:'ClearCustomDocumentProperties']
+      end
+
+      if attributes.key?(:'ClearBuiltInDocumentProperties')
+        self.clear_built_in_document_properties = attributes[:'ClearBuiltInDocumentProperties']
+      end
+
+      if attributes.key?(:'Depth')
+        self.depth = attributes[:'Depth']
+      end
+
+      if attributes.key?(:'ConvertOwned')
+        self.convert_owned = attributes[:'ConvertOwned']
+      end
+
+      if attributes.key?(:'ConvertOwner')
+        self.convert_owner = attributes[:'ConvertOwner']
+      end
+
+      if attributes.key?(:'AutoHyphenation')
+        self.auto_hyphenation = attributes[:'AutoHyphenation']
+      end
+
+      if attributes.key?(:'HyphenateCaps')
+        self.hyphenate_caps = attributes[:'HyphenateCaps']
+      end
+
+      if attributes.key?(:'PageNumbering')
+        self.page_numbering = attributes[:'PageNumbering']
+      end
+
+      if attributes.key?(:'PreserveDocumentStructure')
+        self.preserve_document_structure = attributes[:'PreserveDocumentStructure']
+      end
+
+      if attributes.key?(:'SkipExternalResources')
+        self.skip_external_resources = attributes[:'SkipExternalResources']
+      end
+
+      if attributes.key?(:'UseTextShaper')
+        self.use_text_shaper = attributes[:'UseTextShaper']
+      end
+
+      if attributes.key?(:'PreserveFormFields')
+        self.preserve_form_fields = attributes[:'PreserveFormFields']
+      end
+
+      if attributes.key?(:'CommentDisplayMode')
+        self.comment_display_mode = attributes[:'CommentDisplayMode']
+      end
+
+      if attributes.key?(:'KeepDateFieldOriginalValue')
+        self.keep_date_field_original_value = attributes[:'KeepDateFieldOriginalValue']
+      end
+
+      if attributes.key?(:'UpdateFields')
+        self.update_fields = attributes[:'UpdateFields']
+      end
+
+      if attributes.key?(:'UpdatePageLayout')
+        self.update_page_layout = attributes[:'UpdatePageLayout']
+      end
+
+      if attributes.key?(:'EmbedTrueTypeFonts')
+        self.embed_true_type_fonts = attributes[:'EmbedTrueTypeFonts']
+      end
+
+      if attributes.key?(:'FontInfoSubstitutionEnabled')
+        self.font_info_substitution_enabled = attributes[:'FontInfoSubstitutionEnabled']
+      end
+
+      if attributes.key?(:'FontConfigSubstitutionEnabled')
+        self.font_config_substitution_enabled = attributes[:'FontConfigSubstitutionEnabled']
+      end
+
+      if attributes.key?(:'FontNameSubstitutionEnabled')
+        self.font_name_substitution_enabled = attributes[:'FontNameSubstitutionEnabled']
+      end
+
+      if attributes.key?(:'ShowFullCommenterName')
+        self.show_full_commenter_name = attributes[:'ShowFullCommenterName']
+      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 @auto_font_substitution.nil?
-        invalid_properties.push("invalid value for 'auto_font_substitution', auto_font_substitution cannot be nil.")
-      end
-
       if @hide_word_tracked_changes.nil?
         invalid_properties.push("invalid value for 'hide_word_tracked_changes', hide_word_tracked_changes cannot be nil.")
       end
 
-      if @hide_comments.nil?
-        invalid_properties.push("invalid value for 'hide_comments', hide_comments cannot be nil.")
-      end
-
       if @bookmarks_outline_level.nil?
         invalid_properties.push("invalid value for 'bookmarks_outline_level', bookmarks_outline_level cannot be nil.")
       end
@@ -173,21 +357,140 @@ module GroupDocsConversionCloud
         invalid_properties.push("invalid value for 'expanded_outline_levels', expanded_outline_levels cannot be nil.")
       end
 
+      if @clear_custom_document_properties.nil?
+        invalid_properties.push("invalid value for 'clear_custom_document_properties', clear_custom_document_properties cannot be nil.")
+      end
+
+      if @clear_built_in_document_properties.nil?
+        invalid_properties.push("invalid value for 'clear_built_in_document_properties', clear_built_in_document_properties cannot be nil.")
+      end
+
+      if @depth.nil?
+        invalid_properties.push("invalid value for 'depth', depth cannot be nil.")
+      end
+
+      if @convert_owned.nil?
+        invalid_properties.push("invalid value for 'convert_owned', convert_owned cannot be nil.")
+      end
+
+      if @convert_owner.nil?
+        invalid_properties.push("invalid value for 'convert_owner', convert_owner cannot be nil.")
+      end
+
+      if @auto_hyphenation.nil?
+        invalid_properties.push("invalid value for 'auto_hyphenation', auto_hyphenation cannot be nil.")
+      end
+
+      if @hyphenate_caps.nil?
+        invalid_properties.push("invalid value for 'hyphenate_caps', hyphenate_caps cannot be nil.")
+      end
+
+      if @page_numbering.nil?
+        invalid_properties.push("invalid value for 'page_numbering', page_numbering cannot be nil.")
+      end
+
+      if @preserve_document_structure.nil?
+        invalid_properties.push("invalid value for 'preserve_document_structure', preserve_document_structure cannot be nil.")
+      end
+
+      if @skip_external_resources.nil?
+        invalid_properties.push("invalid value for 'skip_external_resources', skip_external_resources cannot be nil.")
+      end
+
+      if @use_text_shaper.nil?
+        invalid_properties.push("invalid value for 'use_text_shaper', use_text_shaper cannot be nil.")
+      end
+
+      if @preserve_form_fields.nil?
+        invalid_properties.push("invalid value for 'preserve_form_fields', preserve_form_fields cannot be nil.")
+      end
+
+      if @comment_display_mode.nil?
+        invalid_properties.push("invalid value for 'comment_display_mode', comment_display_mode cannot be nil.")
+      end
+
+      if @keep_date_field_original_value.nil?
+        invalid_properties.push("invalid value for 'keep_date_field_original_value', keep_date_field_original_value cannot be nil.")
+      end
+
+      if @update_fields.nil?
+        invalid_properties.push("invalid value for 'update_fields', update_fields cannot be nil.")
+      end
+
+      if @update_page_layout.nil?
+        invalid_properties.push("invalid value for 'update_page_layout', update_page_layout cannot be nil.")
+      end
+
+      if @embed_true_type_fonts.nil?
+        invalid_properties.push("invalid value for 'embed_true_type_fonts', embed_true_type_fonts cannot be nil.")
+      end
+
+      if @font_info_substitution_enabled.nil?
+        invalid_properties.push("invalid value for 'font_info_substitution_enabled', font_info_substitution_enabled cannot be nil.")
+      end
+
+      if @font_config_substitution_enabled.nil?
+        invalid_properties.push("invalid value for 'font_config_substitution_enabled', font_config_substitution_enabled cannot be nil.")
+      end
+
+      if @font_name_substitution_enabled.nil?
+        invalid_properties.push("invalid value for 'font_name_substitution_enabled', font_name_substitution_enabled cannot be nil.")
+      end
+
+      if @show_full_commenter_name.nil?
+        invalid_properties.push("invalid value for 'show_full_commenter_name', show_full_commenter_name 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 @auto_font_substitution.nil?
       return false if @hide_word_tracked_changes.nil?
-      return false if @hide_comments.nil?
       return false if @bookmarks_outline_level.nil?
       return false if @headings_outline_levels.nil?
       return false if @expanded_outline_levels.nil?
+      return false if @clear_custom_document_properties.nil?
+      return false if @clear_built_in_document_properties.nil?
+      return false if @depth.nil?
+      return false if @convert_owned.nil?
+      return false if @convert_owner.nil?
+      return false if @auto_hyphenation.nil?
+      return false if @hyphenate_caps.nil?
+      return false if @page_numbering.nil?
+      return false if @preserve_document_structure.nil?
+      return false if @skip_external_resources.nil?
+      return false if @use_text_shaper.nil?
+      return false if @preserve_form_fields.nil?
+      return false if @comment_display_mode.nil?
+      comment_display_mode_validator = EnumAttributeValidator.new('String', ["Hidden", "Balloon", "Annotation"])
+      return false unless comment_display_mode_validator.valid?(@comment_display_mode)
+      return false if @keep_date_field_original_value.nil?
+      return false if @update_fields.nil?
+      return false if @update_page_layout.nil?
+      return false if @embed_true_type_fonts.nil?
+      return false if @font_info_substitution_enabled.nil?
+      return false if @font_config_substitution_enabled.nil?
+      return false if @font_name_substitution_enabled.nil?
+      return false if @show_full_commenter_name.nil?
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] comment_display_mode Object to be assigned
+    def comment_display_mode=(comment_display_mode)
+      validator = EnumAttributeValidator.new('String', ["Hidden", "Balloon", "Annotation"])
+      if comment_display_mode.to_i == 0
+        unless validator.valid?(comment_display_mode)
+          raise ArgumentError, "invalid value for 'comment_display_mode', must be one of #{validator.allowable_values}."
+        end
+        @comment_display_mode = comment_display_mode
+      else
+        @comment_display_mode = validator.allowable_values[comment_display_mode.to_i]
+      end
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(other)
@@ -195,14 +498,33 @@ module GroupDocsConversionCloud
       self.class == other.class &&
           format == other.format &&
           default_font == other.default_font &&
-          auto_font_substitution == other.auto_font_substitution &&
           font_substitutes == other.font_substitutes &&
           password == other.password &&
           hide_word_tracked_changes == other.hide_word_tracked_changes &&
-          hide_comments == other.hide_comments &&
           bookmarks_outline_level == other.bookmarks_outline_level &&
           headings_outline_levels == other.headings_outline_levels &&
-          expanded_outline_levels == other.expanded_outline_levels
+          expanded_outline_levels == other.expanded_outline_levels &&
+          clear_custom_document_properties == other.clear_custom_document_properties &&
+          clear_built_in_document_properties == other.clear_built_in_document_properties &&
+          depth == other.depth &&
+          convert_owned == other.convert_owned &&
+          convert_owner == other.convert_owner &&
+          auto_hyphenation == other.auto_hyphenation &&
+          hyphenate_caps == other.hyphenate_caps &&
+          page_numbering == other.page_numbering &&
+          preserve_document_structure == other.preserve_document_structure &&
+          skip_external_resources == other.skip_external_resources &&
+          use_text_shaper == other.use_text_shaper &&
+          preserve_form_fields == other.preserve_form_fields &&
+          comment_display_mode == other.comment_display_mode &&
+          keep_date_field_original_value == other.keep_date_field_original_value &&
+          update_fields == other.update_fields &&
+          update_page_layout == other.update_page_layout &&
+          embed_true_type_fonts == other.embed_true_type_fonts &&
+          font_info_substitution_enabled == other.font_info_substitution_enabled &&
+          font_config_substitution_enabled == other.font_config_substitution_enabled &&
+          font_name_substitution_enabled == other.font_name_substitution_enabled &&
+          show_full_commenter_name == other.show_full_commenter_name
     end
 
     # @see the `==` method
@@ -214,7 +536,7 @@ module GroupDocsConversionCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [format, default_font, auto_font_substitution, font_substitutes, password, hide_word_tracked_changes, hide_comments, bookmarks_outline_level, headings_outline_levels, expanded_outline_levels].hash
+      [format, default_font, font_substitutes, password, hide_word_tracked_changes, bookmarks_outline_level, headings_outline_levels, expanded_outline_levels, clear_custom_document_properties, clear_built_in_document_properties, depth, convert_owned, convert_owner, auto_hyphenation, hyphenate_caps, page_numbering, preserve_document_structure, skip_external_resources, use_text_shaper, preserve_form_fields, comment_display_mode, keep_date_field_original_value, update_fields, update_page_layout, embed_true_type_fonts, font_info_substitution_enabled, font_config_substitution_enabled, font_name_substitution_enabled, show_full_commenter_name].hash
     end
 
     # Downcases first letter.