aspose_cells_cloud 24.3 → 24.5

data/lib/aspose_cells_cloud/models/merge_queries.rb

@@ -0,0 +1,306 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="MergeQueriesrb.cs">
+   Copyright (c) 2024 Aspose.Cells 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>
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class MergeQueries
+        #Indicates the source of the mount data.            
+        attr_accessor :data_source_a
+        #            
+        attr_accessor :file_info_a
+        #Represents data item.            
+        attr_accessor :data_item_a
+        #Represents index field  of DataA            
+        attr_accessor :data_a_index_field
+        #Indicates the source of the mount data.            
+        attr_accessor :data_source_b
+        #            
+        attr_accessor :file_info_b
+        #Represents data item.            
+        attr_accessor :data_item_b
+        #Represents index field  of DataB            
+        attr_accessor :data_b_index_field
+        #            
+        attr_accessor :join_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data_source_a' => :'DataSourceA',
+        :'file_info_a' => :'FileInfoA',
+        :'data_item_a' => :'DataItemA',
+        :'data_a_index_field' => :'DataAIndexField',
+        :'data_source_b' => :'DataSourceB',
+        :'file_info_b' => :'FileInfoB',
+        :'data_item_b' => :'DataItemB',
+        :'data_b_index_field' => :'DataBIndexField',
+        :'join_type' => :'JoinType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data_source_a' => :'DataSource',
+        :'file_info_a' => :'FileInfo',
+        :'data_item_a' => :'DataItem',
+        :'data_a_index_field' => :'String',
+        :'data_source_b' => :'DataSource',
+        :'file_info_b' => :'FileInfo',
+        :'data_item_b' => :'DataItem',
+        :'data_b_index_field' => :'String',
+        :'join_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?(:'DataSourceA')
+          self.data_source_a = attributes[:'DataSourceA']
+      end
+      if attributes.has_key?(:'FileInfoA')
+          self.file_info_a = attributes[:'FileInfoA']
+      end
+      if attributes.has_key?(:'DataItemA')
+          self.data_item_a = attributes[:'DataItemA']
+      end
+      if attributes.has_key?(:'DataAIndexField')
+          self.data_a_index_field = attributes[:'DataAIndexField']
+      end
+      if attributes.has_key?(:'DataSourceB')
+          self.data_source_b = attributes[:'DataSourceB']
+      end
+      if attributes.has_key?(:'FileInfoB')
+          self.file_info_b = attributes[:'FileInfoB']
+      end
+      if attributes.has_key?(:'DataItemB')
+          self.data_item_b = attributes[:'DataItemB']
+      end
+      if attributes.has_key?(:'DataBIndexField')
+          self.data_b_index_field = attributes[:'DataBIndexField']
+      end
+      if attributes.has_key?(:'JoinType')
+          self.join_type = attributes[:'JoinType']
+      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 @data_source_a.nil?
+          invalid_properties.push("invalid value for 'data_source_a', data_source_a cannot be nil.")
+      end
+      if @file_info_a.nil?
+          invalid_properties.push("invalid value for 'file_info_a', file_info_a cannot be nil.")
+      end
+      if @data_item_a.nil?
+          invalid_properties.push("invalid value for 'data_item_a', data_item_a cannot be nil.")
+      end
+      if @data_a_index_field.nil?
+          invalid_properties.push("invalid value for 'data_a_index_field', data_a_index_field cannot be nil.")
+      end
+      if @data_source_b.nil?
+          invalid_properties.push("invalid value for 'data_source_b', data_source_b cannot be nil.")
+      end
+      if @file_info_b.nil?
+          invalid_properties.push("invalid value for 'file_info_b', file_info_b cannot be nil.")
+      end
+      if @data_item_b.nil?
+          invalid_properties.push("invalid value for 'data_item_b', data_item_b cannot be nil.")
+      end
+      if @data_b_index_field.nil?
+          invalid_properties.push("invalid value for 'data_b_index_field', data_b_index_field cannot be nil.")
+      end
+      if @join_type.nil?
+          invalid_properties.push("invalid value for 'join_type', join_type 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 @data_source_a.nil?
+      return false if @file_info_a.nil?
+      return false if @data_item_a.nil?
+      return false if @data_a_index_field.nil?
+      return false if @data_source_b.nil?
+      return false if @file_info_b.nil?
+      return false if @data_item_b.nil?
+      return false if @data_b_index_field.nil?
+      return false if @join_type.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 &&
+          data_source_a == o.data_source_a &&
+          file_info_a == o.file_info_a &&
+          data_item_a == o.data_item_a &&
+          data_a_index_field == o.data_a_index_field &&
+          data_source_b == o.data_source_b &&
+          file_info_b == o.file_info_b &&
+          data_item_b == o.data_item_b &&
+          data_b_index_field == o.data_b_index_field &&
+          join_type == o.join_type 
+          std_dev == o.std_dev
+    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
+      [ data_source_a , file_info_a , data_item_a , data_a_index_field , data_source_b , file_info_b , data_item_b , data_b_index_field , join_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/operate_object.rb

@@ -31,9 +31,9 @@ require 'date'
 module AsposeCellsCloud
 
   class OperateObject
-        #            
+        #Represents operate object type.            
         attr_accessor :operate_object_type
-        #            
+        #Represents position of operate object.            
         attr_accessor :position
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/operate_object_position.rb

@@ -31,22 +31,25 @@ require 'date'
 module AsposeCellsCloud
 
   class OperateObjectPosition
-        #            
+        #Represents data source of operate object.            
+        attr_accessor :data_source
+        #Represents data source of operate object.            
         attr_accessor :workbook
-        #            
+        #Represents worksheet name of operate object.            
         attr_accessor :sheet_name
-        #            
+        #Represents chart index of operate object.            
         attr_accessor :chart_index
-        #            
+        #Represents shape index of operate object.            
         attr_accessor :shape_index
-        #            
+        #Represents cell name of operate object.            
         attr_accessor :cell_name
-        #            
+        #Represents list object index of operate object.            
         attr_accessor :list_object_index
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'data_source' => :'DataSource',
         :'workbook' => :'Workbook',
         :'sheet_name' => :'SheetName',
         :'chart_index' => :'ChartIndex',
@@ -59,6 +62,7 @@ module AsposeCellsCloud
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'data_source' => :'DataSource',
         :'workbook' => :'FileSource',
         :'sheet_name' => :'String',
         :'chart_index' => :'Integer',
@@ -76,6 +80,9 @@ module AsposeCellsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
+      if attributes.has_key?(:'DataSource')
+          self.data_source = attributes[:'DataSource']
+      end
       if attributes.has_key?(:'Workbook')
           self.workbook = attributes[:'Workbook']
       end
@@ -101,6 +108,9 @@ module AsposeCellsCloud
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @data_source.nil?
+          invalid_properties.push("invalid value for 'data_source', data_source cannot be nil.")
+      end
       if @workbook.nil?
           invalid_properties.push("invalid value for 'workbook', workbook cannot be nil.")
       end
@@ -126,6 +136,7 @@ module AsposeCellsCloud
     # 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 @data_source.nil?
       return false if @workbook.nil?
       return false if @sheet_name.nil?
       return false if @chart_index.nil?
@@ -140,6 +151,7 @@ module AsposeCellsCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          data_source == o.data_source &&
           workbook == o.workbook &&
           sheet_name == o.sheet_name &&
           chart_index == o.chart_index &&
@@ -158,7 +170,7 @@ module AsposeCellsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ workbook , sheet_name , chart_index , shape_index , cell_name , list_object_index ].hash
+      [ data_source , workbook , sheet_name , chart_index , shape_index , cell_name , list_object_index ].hash
     end
 
     # Builds the object from hash

data/lib/aspose_cells_cloud/models/operate_parameter.rb

@@ -31,7 +31,7 @@ require 'date'
 module AsposeCellsCloud
 
   class OperateParameter
-        #            
+        #Represents task operate type.            
         attr_accessor :operate_type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/page_break_operate_parameter.rb

@@ -31,17 +31,17 @@ require 'date'
 module AsposeCellsCloud
 
   class PageBreakOperateParameter
-        #            
+        #Represents page break type.            
         attr_accessor :page_break_type
-        #            
+        #Represents page break index.            
         attr_accessor :index
-        #            
+        #Represents row index of page break.            
         attr_accessor :row
-        #            
+        #Represents column index of page break.            
         attr_accessor :column
-        #            
+        #Represents start row index of page break.            
         attr_accessor :start_index
-        #            
+        #Represents end row index of page break.            
         attr_accessor :end_index
         #            
         attr_accessor :operate_type

data/lib/aspose_cells_cloud/models/page_setup_operate_parameter.rb

@@ -31,7 +31,7 @@ require 'date'
 module AsposeCellsCloud
 
   class PageSetupOperateParameter
-        #            
+        #Represents worksheet page setup.            
         attr_accessor :page_setup
         #            
         attr_accessor :operate_type

data/lib/aspose_cells_cloud/models/pivot_column.rb

@@ -0,0 +1,222 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="PivotColumnrb.cs">
+   Copyright (c) 2024 Aspose.Cells 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>
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class PivotColumn
+        #            
+        attr_accessor :pivot_column_name
+        #            
+        attr_accessor :value_column_names
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pivot_column_name' => :'PivotColumnName',
+        :'value_column_names' => :'ValueColumnNames'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'pivot_column_name' => :'String',
+        :'value_column_names' => :'Array<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?(:'PivotColumnName')
+          self.pivot_column_name = attributes[:'PivotColumnName']
+      end
+      if attributes.has_key?(:'ValueColumnNames')
+          self.value_column_names = attributes[:'ValueColumnNames']
+      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 @pivot_column_name.nil?
+          invalid_properties.push("invalid value for 'pivot_column_name', pivot_column_name cannot be nil.")
+      end
+      if @value_column_names.nil?
+          invalid_properties.push("invalid value for 'value_column_names', value_column_names 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 @pivot_column_name.nil?
+      return false if @value_column_names.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 &&
+          pivot_column_name == o.pivot_column_name &&
+          value_column_names == o.value_column_names 
+          std_dev == o.std_dev
+    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
+      [ pivot_column_name , value_column_names ].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/pivot_table.rb

@@ -99,7 +99,7 @@ module AsposeCellsCloud
         attr_accessor :merge_labels
         #            
         attr_accessor :missing_items_limit
-        #            
+        #Represents pivot table name.            
         attr_accessor :name
         #            
         attr_accessor :null_string