aspose_words_cloud 23.9.0 → 23.11.0

data/lib/aspose_words_cloud/models/compare_data.rb

@@ -94,13 +94,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?
@@ -244,5 +237,14 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property author in CompareData is required.' if self.author.nil?
+      raise ArgumentError, 'Property comparing_with_document in CompareData is required.' if self.comparing_with_document.nil?
+      unless self.compare_options.nil?
+          self.compare_options.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/compare_options.rb

@@ -162,13 +162,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?
@@ -335,5 +328,8 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/compress_options.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,8 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/compress_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/csv_data_load_options.rb

@@ -29,17 +29,22 @@ module AsposeWordsCloud
 
   # Represents options for parsing CSV data.
   # To learn more, visit the LINQ Reporting Engine documentation article.
+  # An instance of this class can be passed into constructors of CsvDataSource.
   class CsvDataLoadOptions
     # Gets or sets the character that is used to comment lines of CSV data.
+    # The default value is '#' (number sign).
     attr_accessor :comment_char
 
     # Gets or sets the character to be used as a column delimiter.
+    # The default value is ',' (comma).
     attr_accessor :delimiter
 
     # Gets or sets a value indicating whether the first record of CSV data contains column names.
+    # The default value is false.
     attr_accessor :has_headers
 
     # Gets or sets the character that is used to quote field values.
+    # The default value is '"' (quotation mark).Double the character to place it into quoted text.
     attr_accessor :quote_char
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -86,13 +91,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 +233,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property comment_char in CsvDataLoadOptions is required.' if self.comment_char.nil?
+      raise ArgumentError, 'Property delimiter in CsvDataLoadOptions is required.' if self.delimiter.nil?
+      raise ArgumentError, 'Property has_headers in CsvDataLoadOptions is required.' if self.has_headers.nil?
+      raise ArgumentError, 'Property quote_char in CsvDataLoadOptions is required.' if self.quote_char.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/custom_xml_part.rb

@@ -33,9 +33,11 @@ module AsposeWordsCloud
     attr_accessor :link
 
     # Gets or sets the custom xml part id.
+    # Cannot be null.
     attr_accessor :id
 
     # Gets or sets the custom xml part data.
+    # Cannot be null.Default is empty string.
     attr_accessor :data
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -76,13 +78,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 +219,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property data in CustomXmlPart is required.' if self.data.nil?
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/custom_xml_part_insert.rb

@@ -33,9 +33,11 @@ module AsposeWordsCloud
     attr_accessor :link
 
     # Gets or sets the custom xml part id.
+    # Cannot be null.
     attr_accessor :id
 
     # Gets or sets the custom xml part data.
+    # Cannot be null.Default is empty string.
     attr_accessor :data
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -76,13 +78,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 +219,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property data in CustomXmlPartInsert is required.' if self.data.nil?
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/custom_xml_part_link.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,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/custom_xml_part_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a custom xml part.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/customXmlParts/0" REST API requests.
   class CustomXmlPartResponse
     # 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.custom_xml_part.nil?
+          self.custom_xml_part.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/custom_xml_part_update.rb

@@ -33,9 +33,11 @@ module AsposeWordsCloud
     attr_accessor :link
 
     # Gets or sets the custom xml part id.
+    # Cannot be null.
     attr_accessor :id
 
     # Gets or sets the custom xml part data.
+    # Cannot be null.Default is empty string.
     attr_accessor :data
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -76,13 +78,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 +219,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property data in CustomXmlPartUpdate is required.' if self.data.nil?
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/custom_xml_parts_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.custom_xml_parts_list.nil?
+          for elementCustomXmlPartsList in self.custom_xml_parts_list
+              unless elementCustomXmlPartsList.nil?
+                  elementCustomXmlPartsList.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/custom_xml_parts_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a collection of custom xml parts.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/customXmlParts" REST API requests.
   class CustomXmlPartsResponse
     # 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.custom_xml_parts.nil?
+          self.custom_xml_parts.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/doc_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for doc/dot save options.
   class DocSaveOptionsData
     # 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 DocSaveOptionsData 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/docm_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for docm save options.
   class DocmSaveOptionsData
     # 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 DocmSaveOptionsData 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/document.rb

@@ -128,13 +128,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?
@@ -297,5 +290,22 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property is_encrypted in Document is required.' if self.is_encrypted.nil?
+      raise ArgumentError, 'Property is_signed in Document is required.' if self.is_signed.nil?
+      raise ArgumentError, 'Property source_format in Document is required.' if self.source_format.nil?
+      unless self.links.nil?
+          for elementLinks in self.links
+              unless elementLinks.nil?
+                  elementLinks.validate
+              end
+          end
+      end
+      unless self.document_properties.nil?
+          self.document_properties.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_entry.rb

@@ -99,13 +99,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?
@@ -271,5 +264,14 @@ module AsposeWordsCloud
 
     end
 
+    def validate()
+      raise ArgumentError, 'Property file_reference in DocumentEntry is required.' if self.file_reference.nil?
+      raise ArgumentError, 'Property import_format_mode in DocumentEntry is required.' if self.import_format_mode.nil?
+      unless self.file_reference.nil?
+          self.file_reference.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_entry_list.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?
@@ -222,5 +215,17 @@ module AsposeWordsCloud
 
     end
 
+    def validate()
+      raise ArgumentError, 'Property document_entries in DocumentEntryList is required.' if self.document_entries.nil?
+      unless self.document_entries.nil?
+          for elementDocumentEntries in self.document_entries
+              unless elementDocumentEntries.nil?
+                  elementDocumentEntries.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/document_position.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.node.nil?
+          self.node.validate
+      end
+
+    end
+
   end
 end