aspose_words_cloud 23.9.0 → 23.11.0

data/lib/aspose_words_cloud/models/epub_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for epub save options.
   class EpubSaveOptionsData
     # 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 whether negative left and right indents of paragraphs are allowed (not normalized).
@@ -96,6 +107,8 @@ module AsposeWordsCloud
 
     # Gets or sets the flag, that controls how drop-down form fields are saved to HTML.
     # The default value is false.
+    # When set to true, exports drop-down form fields as normal text.
+    # When false, exports drop-down form fields as SELECT element in HTML.
     attr_accessor :export_drop_down_form_field_as_text
 
     # Gets or sets a value indicating whether font resources should be exported.
@@ -118,10 +131,12 @@ module AsposeWordsCloud
 
     # Gets or sets a value indicating whether the original URL should be used as the URL of the linked images.
     # The default value is false.
+    # If value is set to true - ResourceFolder value is used as the URL of linked images and linked images are not loaded into document's folder or ImagesFolder.If value is set to false - linked images are loaded into document's folder or ImagesFolder and URL of each linked image is constructed depending on document's folder, ImagesFolder and ImagesFolderAlias properties.
     attr_accessor :export_original_url_for_linked_images
 
     # Gets or sets a value indicating whether page margins are exported to HTML, MHTML or EPUB.
     # The default value is false.
+    # Aspose.Words does not show area of page margins by default. If any elements are completely or partially clipped by the document edge the displayed area can be extended with this option.
     attr_accessor :export_page_margins
 
     # Gets or sets a value indicating whether page setup is exported.
@@ -131,6 +146,7 @@ module AsposeWordsCloud
     attr_accessor :export_relative_font_size
 
     # Gets or sets a value indicating whether to write the roundtrip information when saving to HTML. The default value is true.
+    # Saving of the roundtrip information allows to restore document properties such as tab stops, comments, headers and footers during the HTML documents loading back into a Document object.When true, the roundtrip information is exported as -aw-* CSS properties of the corresponding HTML elements.When false, causes no roundtrip information to be output into produced files.
     attr_accessor :export_roundtrip_information
 
     # Gets or sets the flag, that controls how text input form fields are saved.
@@ -551,13 +567,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?
@@ -942,5 +951,13 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property file_name in EpubSaveOptionsData 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/error.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
 
   # Error.
   class Error
-    # Code.
+    # Gets or sets Code.
     attr_accessor :code
 
-    # Description.
+    # Gets or sets Description.
     attr_accessor :description
 
-    # Inner Error.
+    # Gets or sets InnerError.
     attr_accessor :inner_error
 
-    # Message.
+    # Gets or sets Message.
     attr_accessor :message
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -85,13 +85,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?
@@ -234,5 +227,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.inner_error.nil?
+          self.inner_error.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/error_details.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
 
   # The error details.
   class ErrorDetails
-    # Error datetime.
+    # Gets or sets ErrorDateTime.
     attr_accessor :error_date_time
 
-    # The request id.
+    # Gets or sets RequestId.
     attr_accessor :request_id
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -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,9 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property error_date_time in ErrorDetails is required.' if self.error_date_time.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/field.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,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/field_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

data/lib/aspose_words_cloud/models/field_insert.rb

@@ -29,24 +29,24 @@ module AsposeWordsCloud
 
   # Field for insert.
   class FieldInsert
-    # Gets or sets the field code.
-    attr_accessor :field_code
-
     # Gets or sets the LCID of the field.
     attr_accessor :locale_id
+
+    # Gets or sets the field code.
+    attr_accessor :field_code
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'field_code' => :'FieldCode',
-        :'locale_id' => :'LocaleId'
+        :'locale_id' => :'LocaleId',
+        :'field_code' => :'FieldCode'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'field_code' => :'String',
-        :'locale_id' => :'String'
+        :'locale_id' => :'String',
+        :'field_code' => :'String'
       }
     end
 
@@ -58,20 +58,13 @@ module AsposeWordsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'FieldCode')
-        self.field_code = attributes[:'FieldCode']
-      end
-
       if attributes.key?(:'LocaleId')
         self.locale_id = attributes[:'LocaleId']
       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
+      if attributes.key?(:'FieldCode')
+        self.field_code = attributes[:'FieldCode']
+      end
     end
 
     # Check to see if the all the properties in the model are valid
@@ -85,8 +78,8 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          field_code == other.field_code &&
-          locale_id == other.locale_id
+          locale_id == other.locale_id &&
+          field_code == other.field_code
     end
 
     # @see the `==` method
@@ -98,7 +91,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [field_code, locale_id].hash
+      [locale_id, field_code].hash
     end
 
     # Builds the object from hash
@@ -214,5 +207,9 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property field_code in FieldInsert is required.' if self.field_code.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/field_link.rb

@@ -76,13 +76,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 +217,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/field_names.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,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/field_names_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a collection of mail merge fields.
+  # This response should be returned by the service when handling: GET /{name}/mailMergeFieldNames.
   class FieldNamesResponse
     # 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.field_names.nil?
+          self.field_names.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/field_options.rb

@@ -29,9 +29,6 @@ module AsposeWordsCloud
 
   # DTO for field options.
   class FieldOptions
-    # Gets or sets BuiltIn Templates Paths.
-    attr_accessor :built_in_templates_paths
-
     # Gets or sets Curren tUser.
     attr_accessor :current_user
 
@@ -70,6 +67,9 @@ module AsposeWordsCloud
     # Gets or sets if Use Invariant Culture Number Format.
     attr_accessor :use_invariant_culture_number_format
 
+    # Gets or sets BuiltIn Templates Paths.
+    attr_accessor :built_in_templates_paths
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -95,7 +95,6 @@ module AsposeWordsCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'built_in_templates_paths' => :'BuiltInTemplatesPaths',
         :'current_user' => :'CurrentUser',
         :'custom_toc_style_separator' => :'CustomTocStyleSeparator',
         :'default_document_author' => :'DefaultDocumentAuthor',
@@ -107,14 +106,14 @@ module AsposeWordsCloud
         :'legacy_number_format' => :'LegacyNumberFormat',
         :'pre_process_culture_name' => :'PreProcessCultureName',
         :'template_name' => :'TemplateName',
-        :'use_invariant_culture_number_format' => :'UseInvariantCultureNumberFormat'
+        :'use_invariant_culture_number_format' => :'UseInvariantCultureNumberFormat',
+        :'built_in_templates_paths' => :'BuiltInTemplatesPaths'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'built_in_templates_paths' => :'Array<String>',
         :'current_user' => :'UserInformation',
         :'custom_toc_style_separator' => :'String',
         :'default_document_author' => :'String',
@@ -126,7 +125,8 @@ module AsposeWordsCloud
         :'legacy_number_format' => :'BOOLEAN',
         :'pre_process_culture_name' => :'String',
         :'template_name' => :'String',
-        :'use_invariant_culture_number_format' => :'BOOLEAN'
+        :'use_invariant_culture_number_format' => :'BOOLEAN',
+        :'built_in_templates_paths' => :'Array<String>'
       }
     end
 
@@ -138,12 +138,6 @@ module AsposeWordsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'BuiltInTemplatesPaths')
-        if (value = attributes[:'BuiltInTemplatesPaths']).is_a?(Array)
-          self.built_in_templates_paths = value
-        end
-      end
-
       if attributes.key?(:'CurrentUser')
         self.current_user = attributes[:'CurrentUser']
       end
@@ -191,13 +185,12 @@ module AsposeWordsCloud
       if attributes.key?(:'UseInvariantCultureNumberFormat')
         self.use_invariant_culture_number_format = attributes[:'UseInvariantCultureNumberFormat']
       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
+      if attributes.key?(:'BuiltInTemplatesPaths')
+        if (value = attributes[:'BuiltInTemplatesPaths']).is_a?(Array)
+          self.built_in_templates_paths = value
+        end
+      end
     end
 
     # Check to see if the all the properties in the model are valid
@@ -245,7 +238,6 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          built_in_templates_paths == other.built_in_templates_paths &&
           current_user == other.current_user &&
           custom_toc_style_separator == other.custom_toc_style_separator &&
           default_document_author == other.default_document_author &&
@@ -257,7 +249,8 @@ module AsposeWordsCloud
           legacy_number_format == other.legacy_number_format &&
           pre_process_culture_name == other.pre_process_culture_name &&
           template_name == other.template_name &&
-          use_invariant_culture_number_format == other.use_invariant_culture_number_format
+          use_invariant_culture_number_format == other.use_invariant_culture_number_format &&
+          built_in_templates_paths == other.built_in_templates_paths
     end
 
     # @see the `==` method
@@ -269,7 +262,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [built_in_templates_paths, current_user, custom_toc_style_separator, default_document_author, field_index_format, field_update_culture_name, field_update_culture_source, file_name, is_bidi_text_supported_on_update, legacy_number_format, pre_process_culture_name, template_name, use_invariant_culture_number_format].hash
+      [current_user, custom_toc_style_separator, default_document_author, field_index_format, field_update_culture_name, field_update_culture_source, file_name, is_bidi_text_supported_on_update, legacy_number_format, pre_process_culture_name, template_name, use_invariant_culture_number_format, built_in_templates_paths].hash
     end
 
     # Builds the object from hash
@@ -385,5 +378,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.current_user.nil?
+          self.current_user.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/field_response.rb

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

data/lib/aspose_words_cloud/models/field_update.rb

@@ -29,24 +29,24 @@ module AsposeWordsCloud
 
   # Field for update.
   class FieldUpdate
-    # Gets or sets the field code.
-    attr_accessor :field_code
-
     # Gets or sets the LCID of the field.
     attr_accessor :locale_id
+
+    # Gets or sets the field code.
+    attr_accessor :field_code
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'field_code' => :'FieldCode',
-        :'locale_id' => :'LocaleId'
+        :'locale_id' => :'LocaleId',
+        :'field_code' => :'FieldCode'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'field_code' => :'String',
-        :'locale_id' => :'String'
+        :'locale_id' => :'String',
+        :'field_code' => :'String'
       }
     end
 
@@ -58,20 +58,13 @@ module AsposeWordsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'FieldCode')
-        self.field_code = attributes[:'FieldCode']
-      end
-
       if attributes.key?(:'LocaleId')
         self.locale_id = attributes[:'LocaleId']
       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
+      if attributes.key?(:'FieldCode')
+        self.field_code = attributes[:'FieldCode']
+      end
     end
 
     # Check to see if the all the properties in the model are valid
@@ -85,8 +78,8 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          field_code == other.field_code &&
-          locale_id == other.locale_id
+          locale_id == other.locale_id &&
+          field_code == other.field_code
     end
 
     # @see the `==` method
@@ -98,7 +91,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [field_code, locale_id].hash
+      [locale_id, field_code].hash
     end
 
     # Builds the object from hash
@@ -214,5 +207,9 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property field_code in FieldUpdate is required.' if self.field_code.nil?
+    end
+
   end
 end