aspose_words_cloud 20.1.0 → 20.7.0

data/lib/aspose_words_cloud/models/header_footers_response.rb

@@ -1,43 +1,40 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="header_footers_response.rb">
+#   Copyright (c) 2020 Aspose.Words for Cloud
+# </copyright>
+# <summary>
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+# </summary>
+# ------------------------------------------------------------------------------------
 
 require 'date'
 
 module AsposeWordsCloud
- #
- # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose" file="HeaderFootersResponse.rb">
- #   Copyright (c) 2019 Aspose.Words for Cloud
- # </copyright>
- # <summary>
- #   Permission is hereby granted, free of charge, to any person obtaining a copy
- #  of this software and associated documentation files (the "Software"), to deal
- #  in the Software without restriction, including without limitation the rights
- #  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- #  copies of the Software, and to permit persons to whom the Software is
- #  furnished to do so, subject to the following conditions:
- #
- #  The above copyright notice and this permission notice shall be included in all
- #  copies or substantial portions of the Software.
- #
- #  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- #  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- #  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- #  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- #  SOFTWARE.
- # </summary>
- # --------------------------------------------------------------------------------------------------------------------
- #
-
-  # This response should be returned by the service when handling: GET http://api.aspose.com/v4.0/words/Test.doc/headersfooters.
+
+  # This response should be returned by the service when handling:
+  # GET https://api.aspose.cloud/v4.0/words/Test.doc/headersfooters.
   class HeaderFootersResponse
     # Gets or sets request Id.
     attr_accessor :request_id
 
     # Gets or sets collection of headers/footers.
     attr_accessor :header_footers
-
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -69,7 +66,6 @@ module AsposeWordsCloud
       if attributes.key?(:'HeaderFooters')
         self.header_footers = attributes[:'HeaderFooters']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -213,5 +209,4 @@ module AsposeWordsCloud
     end
 
   end
-
 end

data/lib/aspose_words_cloud/models/html_fixed_save_options_data.rb

@@ -1,61 +1,71 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="html_fixed_save_options_data.rb">
+#   Copyright (c) 2020 Aspose.Words for Cloud
+# </copyright>
+# <summary>
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+# </summary>
+# ------------------------------------------------------------------------------------
 
 require 'date'
 
 module AsposeWordsCloud
- #
- # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose" file="HtmlFixedSaveOptionsData.rb">
- #   Copyright (c) 2019 Aspose.Words for Cloud
- # </copyright>
- # <summary>
- #   Permission is hereby granted, free of charge, to any person obtaining a copy
- #  of this software and associated documentation files (the "Software"), to deal
- #  in the Software without restriction, including without limitation the rights
- #  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- #  copies of the Software, and to permit persons to whom the Software is
- #  furnished to do so, subject to the following conditions:
- #
- #  The above copyright notice and this permission notice shall be included in all
- #  copies or substantial portions of the Software.
- #
- #  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- #  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- #  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- #  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- #  SOFTWARE.
- # </summary>
- # --------------------------------------------------------------------------------------------------------------------
- #
 
   # container class for fixed html save options.
   class HtmlFixedSaveOptionsData
-    # Gets or sets format of save.
-    attr_accessor :save_format
+    # Gets or sets a value determining how 3D effects are rendered.
+    attr_accessor :dml3_d_effects_rendering_mode
+
+    # Gets or sets a value determining how DrawingML effects are rendered.
+    # { Simplified | None | Fine }.
+    attr_accessor :dml_effects_rendering_mode
+
+    # Gets or sets a value determining how DrawingML shapes are rendered.
+    # { Fallback | DrawingML }.
+    attr_accessor :dml_rendering_mode
 
     # Gets or sets name of destination file.
     attr_accessor :file_name
 
-    # Gets or sets a value determining how DrawingML shapes are rendered. { Fallback | DrawingML }.
-    attr_accessor :dml_rendering_mode
+    # Gets or sets format of save.
+    attr_accessor :save_format
 
-    # Gets or sets a value determining how DrawingML effects are rendered. { Simplified | None | Fine }.
-    attr_accessor :dml_effects_rendering_mode
+    # Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
+    # Default value for this property is. true.
+    attr_accessor :update_fields
 
-    # Gets or sets controls zip output or not. Default value is false.
-    attr_accessor :zip_output
+    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted
+    # property is updated before saving.
+    attr_accessor :update_last_printed_property
 
     # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
     attr_accessor :update_last_saved_time_property
 
-    # Gets or sets value determining whether content of  is updated before saving.
+    # Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
     attr_accessor :update_sdt_content
 
-    # Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is. true
-    attr_accessor :update_fields
+    # Gets or sets controls zip output or not.
+    # Default value is false.
+    attr_accessor :zip_output
 
-    # Gets or sets a value determining how colors are rendered. { Normal | Grayscale}.
+    # Gets or sets a value determining how colors are rendered.
+    # { Normal | Grayscale}.
     attr_accessor :color_mode
 
     # Gets or sets determines the quality of the JPEG images inside PDF document.
@@ -67,7 +77,9 @@ module AsposeWordsCloud
     # Gets or sets indicates the symbol set that is used to represent numbers while rendering to fixed page formats.
     attr_accessor :numeral_format
 
-    # Gets or sets flag indicates whether it is required to optimize output of XPS. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true.  Default is false.
+    # Gets or sets flag indicates whether it is required to optimize output of XPS.
+    # If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated.
+    # Note: The accuracy of the content display may be affected if this property is set to true.  Default is false.
     attr_accessor :optimize_output
 
     # Gets or sets determines number of pages to render.
@@ -76,7 +88,8 @@ module AsposeWordsCloud
     # Gets or sets determines 0-based index of the first page to render.
     attr_accessor :page_index
 
-    # Gets or sets specifies prefix which is added to all class names in style.css file. Default value is \"aw\".
+    # Gets or sets specifies prefix which is added to all class names in style.css file.
+    # Default value is "aw".
     attr_accessor :css_class_names_prefix
 
     # Gets or sets encoding.
@@ -97,10 +110,13 @@ module AsposeWordsCloud
     # Gets or sets specifies export format of fonts.
     attr_accessor :font_format
 
-    # Gets or sets specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center.
+    # Gets or sets specifies the horizontal alignment of pages in an HTML document.
+    # Default value is HtmlFixedHorizontalPageAlignment.Center.
     attr_accessor :page_horizontal_alignment
 
-    # Gets or sets specifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points.
+    # Gets or sets specifies the margins around pages in an HTML document.
+    # The margins value is measured in points and should be equal to or greater than 0.
+    # Default value is 10 points.
     attr_accessor :page_margins
 
     # Gets or sets specifies the physical folder where resources are saved when exporting a document.
@@ -109,24 +125,57 @@ module AsposeWordsCloud
     # Gets or sets specifies the name of the folder used to construct resource URIs.
     attr_accessor :resources_folder_alias
 
-    # Gets or sets flag indicates whether \"@font-face\" CSS rules should be placed into a separate file \"fontFaces.css\" when a document is being saved with external stylesheet (that is, when Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedCss is false). Default value is false, all CSS rules are written into single file \"styles.css\".
+    # Gets or sets flag indicates whether "@font-face" CSS rules should be placed into a separate
+    # file "fontFaces.css" when a document is being saved with external stylesheet
+    # (that is, when Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedCss is
+    # false). Default value is false, all CSS rules are written into single file "styles.css".
     attr_accessor :save_font_face_css_separately
 
     # Gets or sets specifies whether border around pages should be shown.
     attr_accessor :show_page_border
 
+    # Gets or sets flag indicates whether fonts from target machine must be used to display the
+    # document. If this flag is set to true, Aspose.Words.Saving.HtmlFixedSaveOptions.FontFormat
+    # and Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedFonts properties do
+    # not have effect, also Aspose.Words.Saving.HtmlFixedSaveOptions.ResourceSavingCallback
+    # is not fired for fonts. Default is false.
+    attr_accessor :use_target_machine_fonts
+
+    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
       {
-        :'save_format' => :'SaveFormat',
-        :'file_name' => :'FileName',
-        :'dml_rendering_mode' => :'DmlRenderingMode',
+        :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode',
         :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
-        :'zip_output' => :'ZipOutput',
+        :'dml_rendering_mode' => :'DmlRenderingMode',
+        :'file_name' => :'FileName',
+        :'save_format' => :'SaveFormat',
+        :'update_fields' => :'UpdateFields',
+        :'update_last_printed_property' => :'UpdateLastPrintedProperty',
         :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
         :'update_sdt_content' => :'UpdateSdtContent',
-        :'update_fields' => :'UpdateFields',
+        :'zip_output' => :'ZipOutput',
         :'color_mode' => :'ColorMode',
         :'jpeg_quality' => :'JpegQuality',
         :'metafile_rendering_options' => :'MetafileRenderingOptions',
@@ -146,21 +195,24 @@ module AsposeWordsCloud
         :'resources_folder' => :'ResourcesFolder',
         :'resources_folder_alias' => :'ResourcesFolderAlias',
         :'save_font_face_css_separately' => :'SaveFontFaceCssSeparately',
-        :'show_page_border' => :'ShowPageBorder'
+        :'show_page_border' => :'ShowPageBorder',
+        :'use_target_machine_fonts' => :'UseTargetMachineFonts'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'save_format' => :'String',
-        :'file_name' => :'String',
-        :'dml_rendering_mode' => :'String',
+        :'dml3_d_effects_rendering_mode' => :'String',
         :'dml_effects_rendering_mode' => :'String',
-        :'zip_output' => :'BOOLEAN',
+        :'dml_rendering_mode' => :'String',
+        :'file_name' => :'String',
+        :'save_format' => :'String',
+        :'update_fields' => :'BOOLEAN',
+        :'update_last_printed_property' => :'BOOLEAN',
         :'update_last_saved_time_property' => :'BOOLEAN',
         :'update_sdt_content' => :'BOOLEAN',
-        :'update_fields' => :'BOOLEAN',
+        :'zip_output' => :'BOOLEAN',
         :'color_mode' => :'String',
         :'jpeg_quality' => :'Integer',
         :'metafile_rendering_options' => :'MetafileRenderingOptionsData',
@@ -180,7 +232,8 @@ module AsposeWordsCloud
         :'resources_folder' => :'String',
         :'resources_folder_alias' => :'String',
         :'save_font_face_css_separately' => :'BOOLEAN',
-        :'show_page_border' => :'BOOLEAN'
+        :'show_page_border' => :'BOOLEAN',
+        :'use_target_machine_fonts' => :'BOOLEAN'
       }
     end
 
@@ -192,24 +245,32 @@ 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?(:'SaveFormat')
-        self.save_format = attributes[:'SaveFormat']
+      if attributes.key?(:'Dml3DEffectsRenderingMode')
+        self.dml3_d_effects_rendering_mode = attributes[:'Dml3DEffectsRenderingMode']
       end
 
-      if attributes.key?(:'FileName')
-        self.file_name = attributes[:'FileName']
+      if attributes.key?(:'DmlEffectsRenderingMode')
+        self.dml_effects_rendering_mode = attributes[:'DmlEffectsRenderingMode']
       end
 
       if attributes.key?(:'DmlRenderingMode')
         self.dml_rendering_mode = attributes[:'DmlRenderingMode']
       end
 
-      if attributes.key?(:'DmlEffectsRenderingMode')
-        self.dml_effects_rendering_mode = attributes[:'DmlEffectsRenderingMode']
+      if attributes.key?(:'FileName')
+        self.file_name = attributes[:'FileName']
       end
 
-      if attributes.key?(:'ZipOutput')
-        self.zip_output = attributes[:'ZipOutput']
+      if attributes.key?(:'SaveFormat')
+        self.save_format = attributes[:'SaveFormat']
+      end
+
+      if attributes.key?(:'UpdateFields')
+        self.update_fields = attributes[:'UpdateFields']
+      end
+
+      if attributes.key?(:'UpdateLastPrintedProperty')
+        self.update_last_printed_property = attributes[:'UpdateLastPrintedProperty']
       end
 
       if attributes.key?(:'UpdateLastSavedTimeProperty')
@@ -220,8 +281,8 @@ module AsposeWordsCloud
         self.update_sdt_content = attributes[:'UpdateSdtContent']
       end
 
-      if attributes.key?(:'UpdateFields')
-        self.update_fields = attributes[:'UpdateFields']
+      if attributes.key?(:'ZipOutput')
+        self.zip_output = attributes[:'ZipOutput']
       end
 
       if attributes.key?(:'ColorMode')
@@ -304,6 +365,9 @@ module AsposeWordsCloud
         self.show_page_border = attributes[:'ShowPageBorder']
       end
 
+      if attributes.key?(:'UseTargetMachineFonts')
+        self.use_target_machine_fonts = attributes[:'UseTargetMachineFonts']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -316,22 +380,42 @@ module AsposeWordsCloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      dml3_d_effects_rendering_mode_validator = EnumAttributeValidator.new('String', ["Basic", "Advanced"])
+      return false unless dml3_d_effects_rendering_mode_validator.valid?(@dml3_d_effects_rendering_mode)
+
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dml3_d_effects_rendering_mode Object to be assigned
+    def dml3_d_effects_rendering_mode=(dml3_d_effects_rendering_mode)
+      validator = EnumAttributeValidator.new('String', ["Basic", "Advanced"])
+      if dml3_d_effects_rendering_mode.to_i == 0
+        unless validator.valid?(dml3_d_effects_rendering_mode)
+          raise ArgumentError, "invalid value for 'dml3_d_effects_rendering_mode', must be one of #{validator.allowable_values}."
+        end
+        @dml3_d_effects_rendering_mode = dml3_d_effects_rendering_mode
+      else
+        @dml3_d_effects_rendering_mode = validator.allowable_values[dml3_d_effects_rendering_mode.to_i]
+      end
+    end
+
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          save_format == other.save_format &&
-          file_name == other.file_name &&
-          dml_rendering_mode == other.dml_rendering_mode &&
+          dml3_d_effects_rendering_mode == other.dml3_d_effects_rendering_mode &&
           dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
-          zip_output == other.zip_output &&
+          dml_rendering_mode == other.dml_rendering_mode &&
+          file_name == other.file_name &&
+          save_format == other.save_format &&
+          update_fields == other.update_fields &&
+          update_last_printed_property == other.update_last_printed_property &&
           update_last_saved_time_property == other.update_last_saved_time_property &&
           update_sdt_content == other.update_sdt_content &&
-          update_fields == other.update_fields &&
+          zip_output == other.zip_output &&
           color_mode == other.color_mode &&
           jpeg_quality == other.jpeg_quality &&
           metafile_rendering_options == other.metafile_rendering_options &&
@@ -351,7 +435,8 @@ module AsposeWordsCloud
           resources_folder == other.resources_folder &&
           resources_folder_alias == other.resources_folder_alias &&
           save_font_face_css_separately == other.save_font_face_css_separately &&
-          show_page_border == other.show_page_border
+          show_page_border == other.show_page_border &&
+          use_target_machine_fonts == other.use_target_machine_fonts
     end
 
     # @see the `==` method
@@ -363,7 +448,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [save_format, file_name, dml_rendering_mode, dml_effects_rendering_mode, zip_output, update_last_saved_time_property, update_sdt_content, update_fields, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, css_class_names_prefix, encoding, export_embedded_css, export_embedded_fonts, export_embedded_images, export_form_fields, font_format, page_horizontal_alignment, page_margins, resources_folder, resources_folder_alias, save_font_face_css_separately, show_page_border].hash
+      [dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, save_format, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, css_class_names_prefix, encoding, export_embedded_css, export_embedded_fonts, export_embedded_images, export_form_fields, font_format, page_horizontal_alignment, page_margins, resources_folder, resources_folder_alias, save_font_face_css_separately, show_page_border, use_target_machine_fonts].hash
     end
 
     # Builds the object from hash
@@ -473,5 +558,4 @@ module AsposeWordsCloud
     end
 
   end
-
 end