aspose_cells_cloud 20.11 → 21.6

data/lib/aspose_cells_cloud/models/protect_sheet_parameter.rb

@@ -0,0 +1,335 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2021 Aspose.Cells Cloud
+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.
+--------------------------------------------------------------------------------------------------------------------
+
+=end
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class ProtectSheetParameter
+    attr_accessor :allow_selecting_unlocked_cell
+
+    attr_accessor :allow_filtering
+
+    attr_accessor :allow_deleting_column
+
+    attr_accessor :allow_selecting_locked_cell
+
+    attr_accessor :allow_using_pivot_table
+
+    attr_accessor :allow_edit_area
+
+    attr_accessor :allow_inserting_hyperlink
+
+    attr_accessor :allow_formatting_cell
+
+    attr_accessor :allow_formatting_row
+
+    attr_accessor :allow_inserting_row
+
+    attr_accessor :allow_formatting_column
+
+    attr_accessor :allow_sorting
+
+    attr_accessor :allow_inserting_column
+
+    attr_accessor :password
+
+    attr_accessor :allow_deleting_row
+
+    attr_accessor :protection_type
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'allow_selecting_unlocked_cell' => :'AllowSelectingUnlockedCell',
+        :'allow_filtering' => :'AllowFiltering',
+        :'allow_deleting_column' => :'AllowDeletingColumn',
+        :'allow_selecting_locked_cell' => :'AllowSelectingLockedCell',
+        :'allow_using_pivot_table' => :'AllowUsingPivotTable',
+        :'allow_edit_area' => :'AllowEditArea',
+        :'allow_inserting_hyperlink' => :'AllowInsertingHyperlink',
+        :'allow_formatting_cell' => :'AllowFormattingCell',
+        :'allow_formatting_row' => :'AllowFormattingRow',
+        :'allow_inserting_row' => :'AllowInsertingRow',
+        :'allow_formatting_column' => :'AllowFormattingColumn',
+        :'allow_sorting' => :'AllowSorting',
+        :'allow_inserting_column' => :'AllowInsertingColumn',
+        :'password' => :'Password',
+        :'allow_deleting_row' => :'AllowDeletingRow',
+        :'protection_type' => :'ProtectionType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'allow_selecting_unlocked_cell' => :'String',
+        :'allow_filtering' => :'String',
+        :'allow_deleting_column' => :'String',
+        :'allow_selecting_locked_cell' => :'String',
+        :'allow_using_pivot_table' => :'String',
+        :'allow_edit_area' => :'Array<String>',
+        :'allow_inserting_hyperlink' => :'String',
+        :'allow_formatting_cell' => :'String',
+        :'allow_formatting_row' => :'String',
+        :'allow_inserting_row' => :'String',
+        :'allow_formatting_column' => :'String',
+        :'allow_sorting' => :'String',
+        :'allow_inserting_column' => :'String',
+        :'password' => :'String',
+        :'allow_deleting_row' => :'String',
+        :'protection_type' => :'String'
+      }
+    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.has_key?(:'AllowSelectingUnlockedCell')
+        self.allow_selecting_unlocked_cell = attributes[:'AllowSelectingUnlockedCell']
+      end
+
+      if attributes.has_key?(:'AllowFiltering')
+        self.allow_filtering = attributes[:'AllowFiltering']
+      end
+
+      if attributes.has_key?(:'AllowDeletingColumn')
+        self.allow_deleting_column = attributes[:'AllowDeletingColumn']
+      end
+
+      if attributes.has_key?(:'AllowSelectingLockedCell')
+        self.allow_selecting_locked_cell = attributes[:'AllowSelectingLockedCell']
+      end
+
+      if attributes.has_key?(:'AllowUsingPivotTable')
+        self.allow_using_pivot_table = attributes[:'AllowUsingPivotTable']
+      end
+
+      if attributes.has_key?(:'AllowEditArea')
+        if (value = attributes[:'AllowEditArea']).is_a?(Array)
+          self.allow_edit_area = value
+        end
+      end
+
+      if attributes.has_key?(:'AllowInsertingHyperlink')
+        self.allow_inserting_hyperlink = attributes[:'AllowInsertingHyperlink']
+      end
+
+      if attributes.has_key?(:'AllowFormattingCell')
+        self.allow_formatting_cell = attributes[:'AllowFormattingCell']
+      end
+
+      if attributes.has_key?(:'AllowFormattingRow')
+        self.allow_formatting_row = attributes[:'AllowFormattingRow']
+      end
+
+      if attributes.has_key?(:'AllowInsertingRow')
+        self.allow_inserting_row = attributes[:'AllowInsertingRow']
+      end
+
+      if attributes.has_key?(:'AllowFormattingColumn')
+        self.allow_formatting_column = attributes[:'AllowFormattingColumn']
+      end
+
+      if attributes.has_key?(:'AllowSorting')
+        self.allow_sorting = attributes[:'AllowSorting']
+      end
+
+      if attributes.has_key?(:'AllowInsertingColumn')
+        self.allow_inserting_column = attributes[:'AllowInsertingColumn']
+      end
+
+      if attributes.has_key?(:'Password')
+        self.password = attributes[:'Password']
+      end
+
+      if attributes.has_key?(:'AllowDeletingRow')
+        self.allow_deleting_row = attributes[:'AllowDeletingRow']
+      end
+
+      if attributes.has_key?(:'ProtectionType')
+        self.protection_type = attributes[:'ProtectionType']
+      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 = Array.new
+      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 ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          allow_selecting_unlocked_cell == o.allow_selecting_unlocked_cell &&
+          allow_filtering == o.allow_filtering &&
+          allow_deleting_column == o.allow_deleting_column &&
+          allow_selecting_locked_cell == o.allow_selecting_locked_cell &&
+          allow_using_pivot_table == o.allow_using_pivot_table &&
+          allow_edit_area == o.allow_edit_area &&
+          allow_inserting_hyperlink == o.allow_inserting_hyperlink &&
+          allow_formatting_cell == o.allow_formatting_cell &&
+          allow_formatting_row == o.allow_formatting_row &&
+          allow_inserting_row == o.allow_inserting_row &&
+          allow_formatting_column == o.allow_formatting_column &&
+          allow_sorting == o.allow_sorting &&
+          allow_inserting_column == o.allow_inserting_column &&
+          password == o.password &&
+          allow_deleting_row == o.allow_deleting_row &&
+          protection_type == o.protection_type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [allow_selecting_unlocked_cell, allow_filtering, allow_deleting_column, allow_selecting_locked_cell, allow_using_pivot_table, allow_edit_area, allow_inserting_hyperlink, allow_formatting_cell, allow_formatting_row, allow_inserting_row, allow_formatting_column, allow_sorting, allow_inserting_column, password, allow_deleting_row, protection_type].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
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      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 = AsposeCellsCloud.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/aspose_cells_cloud/models/range.rb

@@ -0,0 +1,309 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2021 Aspose.Cells Cloud
+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.
+--------------------------------------------------------------------------------------------------------------------
+
+=end
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class Range
+    # Gets the count of columns in the range.
+    attr_accessor :column_count
+
+    # Sets or gets the height of rows in this range
+    attr_accessor :row_height
+
+    # Gets or sets the name of the range.
+    attr_accessor :name
+
+    # Gets the index of the first column of the range.
+    attr_accessor :first_column
+
+    # Sets or gets the column width of this range
+    attr_accessor :column_width
+
+    # Gets the range's refers to.
+    attr_accessor :refers_to
+
+    # Gets the count of rows in the range.
+    attr_accessor :row_count
+
+    # Gets the index of the first row of the range.
+    attr_accessor :first_row
+
+    # Gets the Aspose.Cells.Range.Worksheetobject which contains this range.
+    attr_accessor :worksheet
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'column_count' => :'ColumnCount',
+        :'row_height' => :'RowHeight',
+        :'name' => :'Name',
+        :'first_column' => :'FirstColumn',
+        :'column_width' => :'ColumnWidth',
+        :'refers_to' => :'RefersTo',
+        :'row_count' => :'RowCount',
+        :'first_row' => :'FirstRow',
+        :'worksheet' => :'Worksheet'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'column_count' => :'Integer',
+        :'row_height' => :'Float',
+        :'name' => :'String',
+        :'first_column' => :'Integer',
+        :'column_width' => :'Float',
+        :'refers_to' => :'String',
+        :'row_count' => :'Integer',
+        :'first_row' => :'Integer',
+        :'worksheet' => :'String'
+      }
+    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.has_key?(:'ColumnCount')
+        self.column_count = attributes[:'ColumnCount']
+      end
+
+      if attributes.has_key?(:'RowHeight')
+        self.row_height = attributes[:'RowHeight']
+      end
+
+      if attributes.has_key?(:'Name')
+        self.name = attributes[:'Name']
+      end
+
+      if attributes.has_key?(:'FirstColumn')
+        self.first_column = attributes[:'FirstColumn']
+      end
+
+      if attributes.has_key?(:'ColumnWidth')
+        self.column_width = attributes[:'ColumnWidth']
+      end
+
+      if attributes.has_key?(:'RefersTo')
+        self.refers_to = attributes[:'RefersTo']
+      end
+
+      if attributes.has_key?(:'RowCount')
+        self.row_count = attributes[:'RowCount']
+      end
+
+      if attributes.has_key?(:'FirstRow')
+        self.first_row = attributes[:'FirstRow']
+      end
+
+      if attributes.has_key?(:'Worksheet')
+        self.worksheet = attributes[:'Worksheet']
+      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 = Array.new
+      if @column_count.nil?
+        invalid_properties.push("invalid value for 'column_count', column_count cannot be nil.")
+      end
+
+      if @row_height.nil?
+        invalid_properties.push("invalid value for 'row_height', row_height cannot be nil.")
+      end
+
+      if @first_column.nil?
+        invalid_properties.push("invalid value for 'first_column', first_column cannot be nil.")
+      end
+
+      if @column_width.nil?
+        invalid_properties.push("invalid value for 'column_width', column_width cannot be nil.")
+      end
+
+      if @row_count.nil?
+        invalid_properties.push("invalid value for 'row_count', row_count cannot be nil.")
+      end
+
+      if @first_row.nil?
+        invalid_properties.push("invalid value for 'first_row', first_row cannot be nil.")
+      end
+
+      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 @column_count.nil?
+      return false if @row_height.nil?
+      return false if @first_column.nil?
+      return false if @column_width.nil?
+      return false if @row_count.nil?
+      return false if @first_row.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          column_count == o.column_count &&
+          row_height == o.row_height &&
+          name == o.name &&
+          first_column == o.first_column &&
+          column_width == o.column_width &&
+          refers_to == o.refers_to &&
+          row_count == o.row_count &&
+          first_row == o.first_row &&
+          worksheet == o.worksheet
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [column_count, row_height, name, first_column, column_width, refers_to, row_count, first_row, worksheet].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
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      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 = AsposeCellsCloud.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