groupdocs_viewer_cloud 18.11 → 19.3

data/lib/groupdocs_viewer_cloud/models/image_options.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="image_options.rb">
- #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ #   Copyright (c) 2003-2019 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -28,68 +28,38 @@
 require 'date'
 
 module GroupDocsViewerCloud
-  # Provides options for rendering document as image.
+  # Options for rendering document into image
   class ImageOptions
 
-    # Allows to specify document password in case when document is password-protected.
-    attr_accessor :password
+    # Page number from which rendering should be started
+    attr_accessor :start_page_number
 
-    # Allows to specify attachment password in case when attachment is password-protected.
-    attr_accessor :attachment_password
+    # Count pages which should be rendered
+    attr_accessor :count_pages_to_render
 
-    # Enables document text extraction. For rendering document as image only.
-    attr_accessor :extract_text
+    # Default font name may be specified in following cases: - You want to generally specify the default font to fall back on, if particular font   in the document cannot be found during rendering. - Your document uses fonts, that contain non-English characters and you want to make sure   any missing font is replaced with one that has the same character set available.
+    attr_accessor :default_font_name
+
+    # Default encoding for the plain text files such as .csv, .txt and .eml files when encoding is not specified in header
+    attr_accessor :default_encoding
 
-    # Enables document comments rendering.
+    # When enabled comments will be rendered to the output.
     attr_accessor :render_comments
 
-    # Enables rendering of document hidden pages, sheets or slides.
+    # When enabled hidden pages, sheets or slides will be rendered to the output
     attr_accessor :render_hidden_pages
 
-    # Transforms to apply. Available transforms [\"Rotate\",\"Reorder\",\"AddPrintAction\"]. 1. Rotate - pages will be rotated on angle if angle was set before. 2. Reorder - for rendering document as PDF only. Pages will be ordered according to rearrangements made before. 3. AddPrintAction - for rendering document as PDF only. An JavaScript action will be added which opens print dialog when PDF document is opened.   
-    attr_accessor :transforms
-
-    # The name of the default font. Default font name may be specified in following cases: - You want to generally specify the default font to fall back on, if particular font   in the document cannot be found during rendering. - Your document uses fonts, that contain non-English characters and you want to make sure   any missing font is replaced with one that has the same character set available.
-    attr_accessor :default_font_name
-
-    # Allows to specify watermark.
-    attr_accessor :watermark
+    # Rendering options for Spreadsheet file formats. Spreadsheet file formats include files with extensions: .xls, .xlsx, .xlsm, .xlsb, .csv, .ods, .ots, .xltx, .xltm, .tsv 
+    attr_accessor :spreadsheet_options
 
-    # The Spreadsheet documents rendering options.
-    attr_accessor :cells_options
-
-    # The CAD documents rendering options.
+    # Rendering options for CAD file formats. CAD file formats include files with extensions: .dwg, .dxf, .dgn, .ifc, .stl
     attr_accessor :cad_options
 
-    # The Email documents rendering options.
+    # Rendering options for Email file formats. Email file formats include files with extensions: .msg, .eml, .emlx, .ifc, .stl
     attr_accessor :email_options
 
-    # The Text documents rendering options.
-    attr_accessor :words_options
-
-    # The PDF documents rendering options.
-    attr_accessor :pdf_options
-
-    # The Presentation documents rendering options.
-    attr_accessor :slides_options
-
-    # The Microsoft Project documents rendering options.
-    attr_accessor :project_options
-
-    # The Outlook Data File document (PST/OST) rendering options.
-    attr_accessor :outlook_options
-
-    # Allows to specify document page number as starting page to render. 
-    attr_accessor :start_page_number
-
-    # Allows to specify count of document pages to render.
-    attr_accessor :count_pages
-
-    # Allows to set image format (png, jpg, bmp). Default value is png.
-    attr_accessor :format
-
-    # Allows to specify quality when rendering as JPG. Valid values are between 1 and 100.  Default value is 90.
-    attr_accessor :quality
+    # Rendering options for Project file formats. Project file formats include files with extensions: .mpt, .mpp
+    attr_accessor :project_management_options
 
     # Allows to specify output image width.  Specify image width in case when you want to change output image dimensions. When Width has value and Height value is 0 then Height value will be calculated  to save image proportions. 
     attr_accessor :width
@@ -97,59 +67,49 @@ module GroupDocsViewerCloud
     # Allows to specify output image height.  Specify image height in case when you want to change output image dimensions. When Height has value and Width value is 0 then Width value will be calculated  to save image proportions.
     attr_accessor :height
 
+    # When enabled Viewer will extract text when it's possible (e.g. raster formats don't have text layer) and return it in the viewing result. This option might be useful when you want to add selectable text layer over the image. 
+    attr_accessor :extract_text
+
+    # Allows to specify quality when rendering as JPG. Valid values are between 1 and 100.  Default value is 90.
+    attr_accessor :jpeg_quality
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'password' => :'password',
-        :'attachment_password' => :'attachmentPassword',
-        :'extract_text' => :'extractText',
-        :'render_comments' => :'renderComments',
-        :'render_hidden_pages' => :'renderHiddenPages',
-        :'transforms' => :'transforms',
-        :'default_font_name' => :'defaultFontName',
-        :'watermark' => :'watermark',
-        :'cells_options' => :'cellsOptions',
-        :'cad_options' => :'cadOptions',
-        :'email_options' => :'emailOptions',
-        :'words_options' => :'wordsOptions',
-        :'pdf_options' => :'pdfOptions',
-        :'slides_options' => :'slidesOptions',
-        :'project_options' => :'projectOptions',
-        :'outlook_options' => :'outlookOptions',
-        :'start_page_number' => :'startPageNumber',
-        :'count_pages' => :'countPages',
-        :'format' => :'format',
-        :'quality' => :'quality',
-        :'width' => :'width',
-        :'height' => :'height'
+        :'start_page_number' => :'StartPageNumber',
+        :'count_pages_to_render' => :'CountPagesToRender',
+        :'default_font_name' => :'DefaultFontName',
+        :'default_encoding' => :'DefaultEncoding',
+        :'render_comments' => :'RenderComments',
+        :'render_hidden_pages' => :'RenderHiddenPages',
+        :'spreadsheet_options' => :'SpreadsheetOptions',
+        :'cad_options' => :'CadOptions',
+        :'email_options' => :'EmailOptions',
+        :'project_management_options' => :'ProjectManagementOptions',
+        :'width' => :'Width',
+        :'height' => :'Height',
+        :'extract_text' => :'ExtractText',
+        :'jpeg_quality' => :'JpegQuality'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'password' => :'String',
-        :'attachment_password' => :'String',
-        :'extract_text' => :'BOOLEAN',
+        :'start_page_number' => :'Integer',
+        :'count_pages_to_render' => :'Integer',
+        :'default_font_name' => :'String',
+        :'default_encoding' => :'String',
         :'render_comments' => :'BOOLEAN',
         :'render_hidden_pages' => :'BOOLEAN',
-        :'transforms' => :'Array<String>',
-        :'default_font_name' => :'String',
-        :'watermark' => :'Watermark',
-        :'cells_options' => :'CellsOptions',
+        :'spreadsheet_options' => :'SpreadsheetOptions',
         :'cad_options' => :'CadOptions',
         :'email_options' => :'EmailOptions',
-        :'words_options' => :'WordsOptions',
-        :'pdf_options' => :'PdfOptions',
-        :'slides_options' => :'SlidesOptions',
-        :'project_options' => :'ProjectOptions',
-        :'outlook_options' => :'OutlookOptions',
-        :'start_page_number' => :'Integer',
-        :'count_pages' => :'Integer',
-        :'format' => :'String',
-        :'quality' => :'Integer',
+        :'project_management_options' => :'ProjectManagementOptions',
         :'width' => :'Integer',
-        :'height' => :'Integer'
+        :'height' => :'Integer',
+        :'extract_text' => :'BOOLEAN',
+        :'jpeg_quality' => :'Integer'
       }
     end
 
@@ -161,108 +121,114 @@ module GroupDocsViewerCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'password')
-        self.password = attributes[:'password']
+      if attributes.key?(:'StartPageNumber')
+        self.start_page_number = attributes[:'StartPageNumber']
       end
 
-      if attributes.key?(:'attachmentPassword')
-        self.attachment_password = attributes[:'attachmentPassword']
+      if attributes.key?(:'CountPagesToRender')
+        self.count_pages_to_render = attributes[:'CountPagesToRender']
       end
 
-      if attributes.key?(:'extractText')
-        self.extract_text = attributes[:'extractText']
+      if attributes.key?(:'DefaultFontName')
+        self.default_font_name = attributes[:'DefaultFontName']
       end
 
-      if attributes.key?(:'renderComments')
-        self.render_comments = attributes[:'renderComments']
+      if attributes.key?(:'DefaultEncoding')
+        self.default_encoding = attributes[:'DefaultEncoding']
       end
 
-      if attributes.key?(:'renderHiddenPages')
-        self.render_hidden_pages = attributes[:'renderHiddenPages']
+      if attributes.key?(:'RenderComments')
+        self.render_comments = attributes[:'RenderComments']
       end
 
-      if attributes.key?(:'transforms')
-        if (value = attributes[:'transforms']).is_a?(Array)
-          self.transforms = value
-        end
+      if attributes.key?(:'RenderHiddenPages')
+        self.render_hidden_pages = attributes[:'RenderHiddenPages']
       end
 
-      if attributes.key?(:'defaultFontName')
-        self.default_font_name = attributes[:'defaultFontName']
+      if attributes.key?(:'SpreadsheetOptions')
+        self.spreadsheet_options = attributes[:'SpreadsheetOptions']
       end
 
-      if attributes.key?(:'watermark')
-        self.watermark = attributes[:'watermark']
+      if attributes.key?(:'CadOptions')
+        self.cad_options = attributes[:'CadOptions']
       end
 
-      if attributes.key?(:'cellsOptions')
-        self.cells_options = attributes[:'cellsOptions']
+      if attributes.key?(:'EmailOptions')
+        self.email_options = attributes[:'EmailOptions']
       end
 
-      if attributes.key?(:'cadOptions')
-        self.cad_options = attributes[:'cadOptions']
+      if attributes.key?(:'ProjectManagementOptions')
+        self.project_management_options = attributes[:'ProjectManagementOptions']
       end
 
-      if attributes.key?(:'emailOptions')
-        self.email_options = attributes[:'emailOptions']
+      if attributes.key?(:'Width')
+        self.width = attributes[:'Width']
       end
 
-      if attributes.key?(:'wordsOptions')
-        self.words_options = attributes[:'wordsOptions']
+      if attributes.key?(:'Height')
+        self.height = attributes[:'Height']
       end
 
-      if attributes.key?(:'pdfOptions')
-        self.pdf_options = attributes[:'pdfOptions']
+      if attributes.key?(:'ExtractText')
+        self.extract_text = attributes[:'ExtractText']
       end
 
-      if attributes.key?(:'slidesOptions')
-        self.slides_options = attributes[:'slidesOptions']
+      if attributes.key?(:'JpegQuality')
+        self.jpeg_quality = attributes[:'JpegQuality']
       end
 
-      if attributes.key?(:'projectOptions')
-        self.project_options = attributes[:'projectOptions']
-      end
+    end
 
-      if attributes.key?(:'outlookOptions')
-        self.outlook_options = attributes[:'outlookOptions']
+    # 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 = []
+      if @start_page_number.nil?
+        invalid_properties.push("invalid value for 'start_page_number', start_page_number cannot be nil.")
       end
 
-      if attributes.key?(:'startPageNumber')
-        self.start_page_number = attributes[:'startPageNumber']
+      if @count_pages_to_render.nil?
+        invalid_properties.push("invalid value for 'count_pages_to_render', count_pages_to_render cannot be nil.")
       end
 
-      if attributes.key?(:'countPages')
-        self.count_pages = attributes[:'countPages']
+      if @render_comments.nil?
+        invalid_properties.push("invalid value for 'render_comments', render_comments cannot be nil.")
       end
 
-      if attributes.key?(:'format')
-        self.format = attributes[:'format']
+      if @render_hidden_pages.nil?
+        invalid_properties.push("invalid value for 'render_hidden_pages', render_hidden_pages cannot be nil.")
       end
 
-      if attributes.key?(:'quality')
-        self.quality = attributes[:'quality']
+      if @width.nil?
+        invalid_properties.push("invalid value for 'width', width cannot be nil.")
       end
 
-      if attributes.key?(:'width')
-        self.width = attributes[:'width']
+      if @height.nil?
+        invalid_properties.push("invalid value for 'height', height cannot be nil.")
       end
 
-      if attributes.key?(:'height')
-        self.height = attributes[:'height']
+      if @extract_text.nil?
+        invalid_properties.push("invalid value for 'extract_text', extract_text cannot be nil.")
       end
 
-    end
+      if @jpeg_quality.nil?
+        invalid_properties.push("invalid value for 'jpeg_quality', jpeg_quality cannot be nil.")
+      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?
+      return false if @start_page_number.nil?
+      return false if @count_pages_to_render.nil?
+      return false if @render_comments.nil?
+      return false if @render_hidden_pages.nil?
+      return false if @width.nil?
+      return false if @height.nil?
+      return false if @extract_text.nil?
+      return false if @jpeg_quality.nil?
       return true
     end
 
@@ -271,28 +237,20 @@ module GroupDocsViewerCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          password == other.password &&
-          attachment_password == other.attachment_password &&
-          extract_text == other.extract_text &&
+          start_page_number == other.start_page_number &&
+          count_pages_to_render == other.count_pages_to_render &&
+          default_font_name == other.default_font_name &&
+          default_encoding == other.default_encoding &&
           render_comments == other.render_comments &&
           render_hidden_pages == other.render_hidden_pages &&
-          transforms == other.transforms &&
-          default_font_name == other.default_font_name &&
-          watermark == other.watermark &&
-          cells_options == other.cells_options &&
+          spreadsheet_options == other.spreadsheet_options &&
           cad_options == other.cad_options &&
           email_options == other.email_options &&
-          words_options == other.words_options &&
-          pdf_options == other.pdf_options &&
-          slides_options == other.slides_options &&
-          project_options == other.project_options &&
-          outlook_options == other.outlook_options &&
-          start_page_number == other.start_page_number &&
-          count_pages == other.count_pages &&
-          format == other.format &&
-          quality == other.quality &&
+          project_management_options == other.project_management_options &&
           width == other.width &&
-          height == other.height
+          height == other.height &&
+          extract_text == other.extract_text &&
+          jpeg_quality == other.jpeg_quality
     end
 
     # @see the `==` method
@@ -304,7 +262,13 @@ module GroupDocsViewerCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [password, attachment_password, extract_text, render_comments, render_hidden_pages, transforms, default_font_name, watermark, cells_options, cad_options, email_options, words_options, pdf_options, slides_options, project_options, outlook_options, start_page_number, count_pages, format, quality, width, height].hash
+      [start_page_number, count_pages_to_render, default_font_name, default_encoding, render_comments, render_hidden_pages, spreadsheet_options, cad_options, email_options, project_management_options, width, height, extract_text, jpeg_quality].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
     end
 
     # Builds the object from hash
@@ -313,14 +277,16 @@ module GroupDocsViewerCloud
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
         if type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          # is documented as an array but the input is not                    
+          if value.is_a?(Array)
+            self.send("#{key}=", value.map { |v| _deserialize($1, v) })
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !value.nil?
+          self.send("#{key}=", _deserialize(type, value))
         end
         # or else data not found in attributes(hash), not an issue as the data can be optional
       end

data/lib/groupdocs_viewer_cloud/models/{attachment_collection.rb → info_result.rb}

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose Pty Ltd" file="attachment_collection.rb">
- #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # <copyright company="Aspose Pty Ltd" file="info_result.rb">
+ #   Copyright (c) 2003-2019 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -28,33 +28,28 @@
 require 'date'
 
 module GroupDocsViewerCloud
-  # Describes attachments.
-  class AttachmentCollection
+  # View result information
+  class InfoResult
 
-    # File name.
-    attr_accessor :file_name
+    # View result pages
+    attr_accessor :pages
 
-    # File folder.
-    attr_accessor :folder
-
-    # Attachments list.
+    # Attachments
     attr_accessor :attachments
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'file_name' => :'fileName',
-        :'folder' => :'folder',
-        :'attachments' => :'attachments'
+        :'pages' => :'Pages',
+        :'attachments' => :'Attachments'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'file_name' => :'String',
-        :'folder' => :'String',
-        :'attachments' => :'Array<Attachment>'
+        :'pages' => :'Array<PageInfo>',
+        :'attachments' => :'Array<AttachmentInfo>'
       }
     end
 
@@ -66,16 +61,14 @@ module GroupDocsViewerCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'fileName')
-        self.file_name = attributes[:'fileName']
-      end
-
-      if attributes.key?(:'folder')
-        self.folder = attributes[:'folder']
+      if attributes.key?(:'Pages')
+        if (value = attributes[:'Pages']).is_a?(Array)
+          self.pages = value
+        end
       end
 
-      if attributes.key?(:'attachments')
-        if (value = attributes[:'attachments']).is_a?(Array)
+      if attributes.key?(:'Attachments')
+        if (value = attributes[:'Attachments']).is_a?(Array)
           self.attachments = value
         end
       end
@@ -100,8 +93,7 @@ module GroupDocsViewerCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          file_name == other.file_name &&
-          folder == other.folder &&
+          pages == other.pages &&
           attachments == other.attachments
     end
 
@@ -114,7 +106,13 @@ module GroupDocsViewerCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [file_name, folder, attachments].hash
+      [pages, attachments].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
     end
 
     # Builds the object from hash
@@ -123,14 +121,16 @@ module GroupDocsViewerCloud
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
         if type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          # is documented as an array but the input is not                    
+          if value.is_a?(Array)
+            self.send("#{key}=", value.map { |v| _deserialize($1, v) })
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !value.nil?
+          self.send("#{key}=", _deserialize(type, value))
         end
         # or else data not found in attributes(hash), not an issue as the data can be optional
       end