aspose_words_cloud 23.9.0 → 23.11.0

data/lib/aspose_words_cloud/models/document_properties.rb

@@ -69,13 +69,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -216,5 +209,19 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+      unless self.list.nil?
+          for elementList in self.list
+              unless elementList.nil?
+                  elementList.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_properties_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a collection of document properties.
+  # This response should be returned by the service when handling: GET /documentProperties.
   class DocumentPropertiesResponse
     # Gets or sets the request Id.
     attr_accessor :request_id
@@ -67,13 +68,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -214,5 +208,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.document_properties.nil?
+          self.document_properties.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_property.rb

@@ -86,13 +86,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -235,5 +228,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property built_in in DocumentProperty is required.' if self.built_in.nil?
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_property_create_or_update.rb

@@ -58,13 +58,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -204,5 +197,9 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property value in DocumentPropertyCreateOrUpdate is required.' if self.value.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_property_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a document property.
+  # This response should be returned by the service when handling: GET documentProperties/{propertyName}.
   class DocumentPropertyResponse
     # Gets or sets the request Id.
     attr_accessor :request_id
@@ -67,13 +68,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -214,5 +208,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.document_property.nil?
+          self.document_property.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_response.rb

@@ -67,13 +67,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -214,5 +207,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.document.nil?
+          self.document.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_stat_data.rb

@@ -96,13 +96,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -246,5 +239,22 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property page_count in DocumentStatData is required.' if self.page_count.nil?
+      raise ArgumentError, 'Property paragraph_count in DocumentStatData is required.' if self.paragraph_count.nil?
+      raise ArgumentError, 'Property word_count in DocumentStatData is required.' if self.word_count.nil?
+      unless self.footnotes_stat_data.nil?
+          self.footnotes_stat_data.validate
+      end
+      unless self.page_stat_data.nil?
+          for elementPageStatData in self.page_stat_data
+              unless elementPageStatData.nil?
+                  elementPageStatData.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/docx_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for docx save options.
   class DocxSaveOptionsData
     # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    # Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
+    # This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true.
+    # The default value is false.
     attr_accessor :allow_embedding_post_script_fonts
 
     # Gets or sets CustomTimeZoneInfo.
     attr_accessor :custom_time_zone_info_data
 
     # Gets or sets the value determining how 3D effects are rendered.
+    # The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
     attr_accessor :dml3_d_effects_rendering_mode
 
     # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
+    # The default value is Simplified.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_effects_rendering_mode
 
     # Gets or sets the option that controls how DrawingML shapes are rendered.
+    # { Fallback | DrawingML }. The default value is Fallback.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_rendering_mode
 
     # Gets or sets the name of destination file.
     attr_accessor :file_name
 
     # Gets or sets the value determining how ink (InkML) objects are rendered.
+    # The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
     attr_accessor :iml_rendering_mode
 
     # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
@@ -62,10 +71,12 @@ module AsposeWordsCloud
     attr_accessor :update_last_printed_property
 
     # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # The default value is false.
     attr_accessor :update_last_saved_time_property
 
     # Gets or sets a value indicating whether to zip output or not.
     # The default value is false.
+    # When set to true, output files will be zipped.
     attr_accessor :zip_output
 
     # Gets or sets the oOXML version for the output document.
@@ -226,13 +237,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -486,5 +490,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property file_name in DocxSaveOptionsData is required.' if self.file_name.nil?
+      unless self.custom_time_zone_info_data.nil?
+          self.custom_time_zone_info_data.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/dot_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for dot save options.
   class DotSaveOptionsData
     # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    # Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
+    # This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true.
+    # The default value is false.
     attr_accessor :allow_embedding_post_script_fonts
 
     # Gets or sets CustomTimeZoneInfo.
     attr_accessor :custom_time_zone_info_data
 
     # Gets or sets the value determining how 3D effects are rendered.
+    # The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
     attr_accessor :dml3_d_effects_rendering_mode
 
     # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
+    # The default value is Simplified.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_effects_rendering_mode
 
     # Gets or sets the option that controls how DrawingML shapes are rendered.
+    # { Fallback | DrawingML }. The default value is Fallback.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_rendering_mode
 
     # Gets or sets the name of destination file.
     attr_accessor :file_name
 
     # Gets or sets the value determining how ink (InkML) objects are rendered.
+    # The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
     attr_accessor :iml_rendering_mode
 
     # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
@@ -62,10 +71,12 @@ module AsposeWordsCloud
     attr_accessor :update_last_printed_property
 
     # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # The default value is false.
     attr_accessor :update_last_saved_time_property
 
     # Gets or sets a value indicating whether to zip output or not.
     # The default value is false.
+    # When set to true, output files will be zipped.
     attr_accessor :zip_output
 
     # Gets or sets a value indicating when False, that small metafiles are not compressed for performance reason.
@@ -228,13 +239,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -456,5 +460,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property file_name in DotSaveOptionsData is required.' if self.file_name.nil?
+      unless self.custom_time_zone_info_data.nil?
+          self.custom_time_zone_info_data.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/dotm_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for dotm save options.
   class DotmSaveOptionsData
     # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    # Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
+    # This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true.
+    # The default value is false.
     attr_accessor :allow_embedding_post_script_fonts
 
     # Gets or sets CustomTimeZoneInfo.
     attr_accessor :custom_time_zone_info_data
 
     # Gets or sets the value determining how 3D effects are rendered.
+    # The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
     attr_accessor :dml3_d_effects_rendering_mode
 
     # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
+    # The default value is Simplified.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_effects_rendering_mode
 
     # Gets or sets the option that controls how DrawingML shapes are rendered.
+    # { Fallback | DrawingML }. The default value is Fallback.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_rendering_mode
 
     # Gets or sets the name of destination file.
     attr_accessor :file_name
 
     # Gets or sets the value determining how ink (InkML) objects are rendered.
+    # The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
     attr_accessor :iml_rendering_mode
 
     # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
@@ -62,10 +71,12 @@ module AsposeWordsCloud
     attr_accessor :update_last_printed_property
 
     # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # The default value is false.
     attr_accessor :update_last_saved_time_property
 
     # Gets or sets a value indicating whether to zip output or not.
     # The default value is false.
+    # When set to true, output files will be zipped.
     attr_accessor :zip_output
 
     # Gets or sets the oOXML version for the output document.
@@ -226,13 +237,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -486,5 +490,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property file_name in DotmSaveOptionsData is required.' if self.file_name.nil?
+      unless self.custom_time_zone_info_data.nil?
+          self.custom_time_zone_info_data.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/dotx_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for dotx save options.
   class DotxSaveOptionsData
     # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    # Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
+    # This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true.
+    # The default value is false.
     attr_accessor :allow_embedding_post_script_fonts
 
     # Gets or sets CustomTimeZoneInfo.
     attr_accessor :custom_time_zone_info_data
 
     # Gets or sets the value determining how 3D effects are rendered.
+    # The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
     attr_accessor :dml3_d_effects_rendering_mode
 
     # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
+    # The default value is Simplified.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_effects_rendering_mode
 
     # Gets or sets the option that controls how DrawingML shapes are rendered.
+    # { Fallback | DrawingML }. The default value is Fallback.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_rendering_mode
 
     # Gets or sets the name of destination file.
     attr_accessor :file_name
 
     # Gets or sets the value determining how ink (InkML) objects are rendered.
+    # The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
     attr_accessor :iml_rendering_mode
 
     # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
@@ -62,10 +71,12 @@ module AsposeWordsCloud
     attr_accessor :update_last_printed_property
 
     # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # The default value is false.
     attr_accessor :update_last_saved_time_property
 
     # Gets or sets a value indicating whether to zip output or not.
     # The default value is false.
+    # When set to true, output files will be zipped.
     attr_accessor :zip_output
 
     # Gets or sets the oOXML version for the output document.
@@ -226,13 +237,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -486,5 +490,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property file_name in DotxSaveOptionsData is required.' if self.file_name.nil?
+      unless self.custom_time_zone_info_data.nil?
+          self.custom_time_zone_info_data.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/downsample_options_data.rb

@@ -30,12 +30,15 @@ module AsposeWordsCloud
   # Container class for Downsample options.
   class DownsampleOptionsData
     # Gets or sets a value indicating whether images should be downsampled.
+    # The default value is true.
     attr_accessor :downsample_images
 
     # Gets or sets the resolution in pixels per inch which the images should be downsampled to.
+    # The default value is 220 ppi.
     attr_accessor :resolution
 
     # Gets or sets the threshold resolution in pixels per inch. If resolution of an image in the document is less than threshold value, the downsampling algorithm will not be applied. A value of 0 means the threshold check is not used and all images that can be reduced in size are downsampled.
+    # The default value is 0.
     attr_accessor :resolution_threshold
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -76,13 +79,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -224,5 +220,8 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/drawing_object.rb

@@ -182,13 +182,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -389,5 +382,25 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+      unless self.render_links.nil?
+          for elementRenderLinks in self.render_links
+              unless elementRenderLinks.nil?
+                  elementRenderLinks.validate
+              end
+          end
+      end
+      unless self.ole_data_link.nil?
+          self.ole_data_link.validate
+      end
+      unless self.image_data_link.nil?
+          self.image_data_link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/drawing_object_collection.rb

@@ -69,13 +69,6 @@ module AsposeWordsCloud
       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 = []
-      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?
@@ -216,5 +209,19 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+      unless self.list.nil?
+          for elementList in self.list
+              unless elementList.nil?
+                  elementList.validate
+              end
+          end
+      end
+
+    end
+
   end
 end