groupdocs_viewer_cloud 18.7

data/lib/groupdocs_viewer_cloud/models/reorder_options.rb

@@ -0,0 +1,226 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="reorder_options.rb">
+ #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # </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 GroupDocsViewerCloud
+  # Provides options for reordering document pages.
+  class ReorderOptions
+
+    # The page number to transform.
+    attr_accessor :page_number
+
+    # Allows to specify document password in case when document is password-protected.
+    attr_accessor :password
+
+    # The position where page should be placed.
+    attr_accessor :new_position
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'page_number' => :'pageNumber',
+        :'password' => :'password',
+        :'new_position' => :'newPosition'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'page_number' => :'Integer',
+        :'password' => :'String',
+        :'new_position' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'pageNumber')
+        self.page_number = attributes[:'pageNumber']
+      end
+
+      if attributes.key?(:'password')
+        self.password = attributes[:'password']
+      end
+
+      if attributes.key?(:'newPosition')
+        self.new_position = attributes[:'newPosition']
+      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?
+      return true
+    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 &&
+          page_number == other.page_number &&
+          password == other.password &&
+          new_position == other.new_position
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [page_number, password, new_position].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        Time.at(/\d/.match(value)[0].to_f).to_datetime
+      when :Date
+        Time.at(/\d/.match(value)[0].to_f).to_date
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else
+      # model
+        temp_model = GroupDocsViewerCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/groupdocs_viewer_cloud/models/requests/html_create_attachment_pages_cache_request.rb

@@ -0,0 +1,65 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="html_create_attachment_pages_cache_request.rb">
+ #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # </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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+module GroupDocsViewerCloud
+
+  #
+  # Request model for html_create_attachment_pages_cache operation.
+  #
+  class HtmlCreateAttachmentPagesCacheRequest
+
+        # The file name.
+        attr_accessor :file_name
+        # The attachment name.
+        attr_accessor :attachment_name
+        # The HTML rendering options.
+        attr_accessor :html_options
+        # The folder with custom fonts in storage.
+        attr_accessor :fonts_folder
+        # The folder which contains specified file in storage.
+        attr_accessor :folder
+        # The file storage which have to be used.
+        attr_accessor :storage
+	
+        #
+        # Initializes a new instance.
+        # @param file_name The file name.
+        # @param attachment_name The attachment name.
+        # @param html_options The HTML rendering options.
+        # @param fonts_folder The folder with custom fonts in storage.
+        # @param folder The folder which contains specified file in storage.
+        # @param storage The file storage which have to be used.
+        def initialize(file_name, attachment_name, html_options = nil, fonts_folder = nil, folder = nil, storage = nil)
+           self.file_name = file_name
+           self.attachment_name = attachment_name
+           self.html_options = html_options
+           self.fonts_folder = fonts_folder
+           self.folder = folder
+           self.storage = storage
+        end
+  end
+end

data/lib/groupdocs_viewer_cloud/models/requests/html_create_pages_cache_from_content_request.rb

@@ -0,0 +1,65 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="html_create_pages_cache_from_content_request.rb">
+ #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # </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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+module GroupDocsViewerCloud
+
+  #
+  # Request model for html_create_pages_cache_from_content operation.
+  #
+  class HtmlCreatePagesCacheFromContentRequest
+
+        # File contents.
+        attr_accessor :file
+        # HTML rendering options 'HtmlOptions' as JSON or XML.
+        attr_accessor :html_options
+        # The file name.
+        attr_accessor :file_name
+        # The folder with custom fonts in storage.
+        attr_accessor :fonts_folder
+        # The folder which contains specified file in storage.
+        attr_accessor :folder
+        # The file storage which have to be used.
+        attr_accessor :storage
+	
+        #
+        # Initializes a new instance.
+        # @param file File contents.
+        # @param html_options HTML rendering options 'HtmlOptions' as JSON or XML.
+        # @param file_name The file name.
+        # @param fonts_folder The folder with custom fonts in storage.
+        # @param folder The folder which contains specified file in storage.
+        # @param storage The file storage which have to be used.
+        def initialize(file, html_options, file_name = nil, fonts_folder = nil, folder = nil, storage = nil)
+           self.file = file
+           self.html_options = html_options
+           self.file_name = file_name
+           self.fonts_folder = fonts_folder
+           self.folder = folder
+           self.storage = storage
+        end
+  end
+end

data/lib/groupdocs_viewer_cloud/models/requests/html_create_pages_cache_from_url_request.rb

@@ -0,0 +1,65 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="html_create_pages_cache_from_url_request.rb">
+ #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # </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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+module GroupDocsViewerCloud
+
+  #
+  # Request model for html_create_pages_cache_from_url operation.
+  #
+  class HtmlCreatePagesCacheFromUrlRequest
+
+        # The URL to retrieve document.
+        attr_accessor :url
+        # The HTML rendering options.
+        attr_accessor :html_options
+        # The file name.
+        attr_accessor :file_name
+        # The folder with custom fonts in storage.
+        attr_accessor :fonts_folder
+        # The folder which contains specified file in storage.
+        attr_accessor :folder
+        # The file storage which have to be used.
+        attr_accessor :storage
+	
+        #
+        # Initializes a new instance.
+        # @param url The URL to retrieve document.
+        # @param html_options The HTML rendering options.
+        # @param file_name The file name.
+        # @param fonts_folder The folder with custom fonts in storage.
+        # @param folder The folder which contains specified file in storage.
+        # @param storage The file storage which have to be used.
+        def initialize(url, html_options = nil, file_name = nil, fonts_folder = nil, folder = nil, storage = nil)
+           self.url = url
+           self.html_options = html_options
+           self.file_name = file_name
+           self.fonts_folder = fonts_folder
+           self.folder = folder
+           self.storage = storage
+        end
+  end
+end

data/lib/groupdocs_viewer_cloud/models/requests/html_create_pages_cache_request.rb

@@ -0,0 +1,61 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="html_create_pages_cache_request.rb">
+ #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # </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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+module GroupDocsViewerCloud
+
+  #
+  # Request model for html_create_pages_cache operation.
+  #
+  class HtmlCreatePagesCacheRequest
+
+        # The file name.
+        attr_accessor :file_name
+        # The HTML rendering options.
+        attr_accessor :html_options
+        # The folder with custom fonts in storage.
+        attr_accessor :fonts_folder
+        # The folder which contains specified file in storage.
+        attr_accessor :folder
+        # The file storage which have to be used.
+        attr_accessor :storage
+	
+        #
+        # Initializes a new instance.
+        # @param file_name The file name.
+        # @param html_options The HTML rendering options.
+        # @param fonts_folder The folder with custom fonts in storage.
+        # @param folder The folder which contains specified file in storage.
+        # @param storage The file storage which have to be used.
+        def initialize(file_name, html_options = nil, fonts_folder = nil, folder = nil, storage = nil)
+           self.file_name = file_name
+           self.html_options = html_options
+           self.fonts_folder = fonts_folder
+           self.folder = folder
+           self.storage = storage
+        end
+  end
+end