aspose_words_cloud 20.3.0 → 20.8.0

data/lib/aspose_words_cloud/models/pdf_encryption_details_data.rb

@@ -1,33 +1,31 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="pdf_encryption_details_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="PdfEncryptionDetailsData.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 details of encryption.
   class PdfEncryptionDetailsData
@@ -42,8 +40,6 @@ module AsposeWordsCloud
 
     # Gets or sets specifies the user password required for opening the encrypted PDF document.
     attr_accessor :user_password
-
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -87,7 +83,6 @@ module AsposeWordsCloud
       if attributes.key?(:'UserPassword')
         self.user_password = attributes[:'UserPassword']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -233,5 +228,4 @@ module AsposeWordsCloud
     end
 
   end
-
 end

data/lib/aspose_words_cloud/models/pdf_save_options_data.rb

@@ -1,61 +1,71 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="pdf_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="PdfSaveOptionsData.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 pdf save options.
   class PdfSaveOptionsData
-    # 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.
@@ -79,16 +91,19 @@ module AsposeWordsCloud
     # Gets or sets specifies the PDF standards compliance level for output documents.
     attr_accessor :compliance
 
-    # Gets or sets specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false.
+    # Gets or sets specifies whether to convert footnote/endnote references in main text story into active hyperlinks.
+    # When clicked the hyperlink will lead to the corresponding footnote/endnote.
+    # Default is false.
     attr_accessor :create_note_hyperlinks
 
-    # Gets or sets a value determining the way  are exported to PDF file. Default value is .
+    # Gets or sets a value determining the way CustomDocumentProperties are exported to PDF file.
+    # Default value is None.
     attr_accessor :custom_properties_export
 
     # Gets or sets specifies the details for signing the output PDF document.
     attr_accessor :digital_signature_details
 
-    # Gets or sets a flag specifying whether the window???s title bar should display the document title taken from the Title entry of the document information dictionary.
+    # Gets or sets a flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary.
     attr_accessor :display_doc_title
 
     # Gets or sets allows to specify downsample options.
@@ -100,7 +115,7 @@ module AsposeWordsCloud
     # Gets or sets specifies the details for encrypting the output PDF document.
     attr_accessor :encryption_details
 
-    # Gets or sets a flag specifying whether URI should be escaped before writing.             
+    # Gets or sets a flag specifying whether URI should be escaped before writing.
     attr_accessor :escape_uri
 
     # Gets or sets determines whether or not to export document structure.
@@ -109,7 +124,8 @@ module AsposeWordsCloud
     # Gets or sets specifies the font embedding mode.
     attr_accessor :font_embedding_mode
 
-    # Gets or sets determines how bookmarks in headers/footers are exported. The default value is Aspose.Words.Saving.HeaderFooterBookmarksExportMode.All.
+    # Gets or sets determines how bookmarks in headers/footers are exported.
+    # The default value is Aspose.Words.Saving.HeaderFooterBookmarksExportMode.All.
     attr_accessor :header_footer_bookmarks_export_mode
 
     # Gets or sets specifies how the color space will be selected for the images in PDF document.
@@ -118,6 +134,11 @@ module AsposeWordsCloud
     # Gets or sets specifies compression type to be used for all images in the document.
     attr_accessor :image_compression
 
+    # Gets or sets a flag indicating whether image interpolation shall be performed by a conforming
+    # reader. When false is specified, the flag is not written to the output document
+    # and the default behaviour of reader is used instead.
+    attr_accessor :interpolate_images
+
     # Gets or sets determines whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.
     attr_accessor :open_hyperlinks_in_new_window
 
@@ -173,14 +194,16 @@ module AsposeWordsCloud
     # 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',
@@ -202,6 +225,7 @@ module AsposeWordsCloud
         :'header_footer_bookmarks_export_mode' => :'HeaderFooterBookmarksExportMode',
         :'image_color_space_export_mode' => :'ImageColorSpaceExportMode',
         :'image_compression' => :'ImageCompression',
+        :'interpolate_images' => :'InterpolateImages',
         :'open_hyperlinks_in_new_window' => :'OpenHyperlinksInNewWindow',
         :'outline_options' => :'OutlineOptions',
         :'page_mode' => :'PageMode',
@@ -218,14 +242,16 @@ module AsposeWordsCloud
     # 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',
@@ -247,6 +273,7 @@ module AsposeWordsCloud
         :'header_footer_bookmarks_export_mode' => :'String',
         :'image_color_space_export_mode' => :'String',
         :'image_compression' => :'String',
+        :'interpolate_images' => :'BOOLEAN',
         :'open_hyperlinks_in_new_window' => :'BOOLEAN',
         :'outline_options' => :'OutlineOptionsData',
         :'page_mode' => :'String',
@@ -268,24 +295,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')
@@ -296,8 +331,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')
@@ -384,6 +419,10 @@ module AsposeWordsCloud
         self.image_compression = attributes[:'ImageCompression']
       end
 
+      if attributes.key?(:'InterpolateImages')
+        self.interpolate_images = attributes[:'InterpolateImages']
+      end
+
       if attributes.key?(:'OpenHyperlinksInNewWindow')
         self.open_hyperlinks_in_new_window = attributes[:'OpenHyperlinksInNewWindow']
       end
@@ -423,7 +462,6 @@ module AsposeWordsCloud
       if attributes.key?(:'ZoomFactor')
         self.zoom_factor = attributes[:'ZoomFactor']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -436,11 +474,28 @@ 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)
       header_footer_bookmarks_export_mode_validator = EnumAttributeValidator.new('String', ["None", "First", "All"])
       return false unless header_footer_bookmarks_export_mode_validator.valid?(@header_footer_bookmarks_export_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
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] header_footer_bookmarks_export_mode Object to be assigned
     def header_footer_bookmarks_export_mode=(header_footer_bookmarks_export_mode)
@@ -455,19 +510,22 @@ module AsposeWordsCloud
       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 &&
@@ -489,6 +547,7 @@ module AsposeWordsCloud
           header_footer_bookmarks_export_mode == other.header_footer_bookmarks_export_mode &&
           image_color_space_export_mode == other.image_color_space_export_mode &&
           image_compression == other.image_compression &&
+          interpolate_images == other.interpolate_images &&
           open_hyperlinks_in_new_window == other.open_hyperlinks_in_new_window &&
           outline_options == other.outline_options &&
           page_mode == other.page_mode &&
@@ -510,7 +569,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, compliance, create_note_hyperlinks, custom_properties_export, digital_signature_details, display_doc_title, downsample_options, embed_full_fonts, encryption_details, escape_uri, export_document_structure, font_embedding_mode, header_footer_bookmarks_export_mode, image_color_space_export_mode, image_compression, open_hyperlinks_in_new_window, outline_options, page_mode, preblend_images, preserve_form_fields, text_compression, use_book_fold_printing_settings, use_core_fonts, zoom_behavior, zoom_factor].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, compliance, create_note_hyperlinks, custom_properties_export, digital_signature_details, display_doc_title, downsample_options, embed_full_fonts, encryption_details, escape_uri, export_document_structure, font_embedding_mode, header_footer_bookmarks_export_mode, image_color_space_export_mode, image_compression, interpolate_images, open_hyperlinks_in_new_window, outline_options, page_mode, preblend_images, preserve_form_fields, text_compression, use_book_fold_printing_settings, use_core_fonts, zoom_behavior, zoom_factor].hash
     end
 
     # Builds the object from hash
@@ -620,5 +679,4 @@ module AsposeWordsCloud
     end
 
   end
-
 end