aspose_cells_cloud 23.8 → 23.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ca0c313c39a3b7d43e262ff2be26af211dfbe07158b2a291c65df27e2cc9f36
-  data.tar.gz: fb7489269efdd4d5473ff97f02658586805b99bb32b6c90b4945d6e32a3b2860
+  metadata.gz: 91998862467426a5be69c44c53c18dd1ea7c1c0bd4bc1f59836e9232b727b672
+  data.tar.gz: afa939e4733b856177b4a989e4db861bb38c747f12833972759610c721ccaa84
 SHA512:
-  metadata.gz: 1ca1006a6daa1a623e52d3449007910e518a3b71eb92abc1d2a625409fec709f658aa2d95fc9f4044e7fda35ce4fbfb2fc413371f9f201c41ccb605de83ea641
-  data.tar.gz: 1ccd961c385a3b1e1ea8f0096e1d5d432173fa0b3a1bfda724104d385bfbaae1f48887bc99e781c64e505fd38a2cfe31a5435c6341524146356903b6725a82b6
+  metadata.gz: 3f9126adf2b2896a75d443da81768fc12dcbef0ec0b7df2236514c6ade92a70d57fb813ef8795dc48e8bd594b6ff1f80f4ee7493c0d73a42036d10cd37ccdc6d
+  data.tar.gz: 7e5c4700ebe2c34abb413acf8c9d8e9027ec266c3007a26285bc5bd45d1696c5fc02895cb12af1fe018c099a63be5655b164813c2ca2bc7b7cca8448263d8e1b

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Aspose Pty Ltd
+Copyright (c) 2023 Aspose Pty Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,6 @@ 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

data/README.md

@@ -1,4 +1,4 @@
-![](https://img.shields.io/badge/REST%20API-v3.0-lightgrey) ![Gem](https://img.shields.io/gem/v/aspose_cells_cloud) ![Gem](https://img.shields.io/gem/dt/aspose_cells_cloud) [![GitHub license](https://img.shields.io/github/license/aspose-cells-cloud/aspose-cells-cloud-ruby)](https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby/blob/master/LICENSE) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/aspose-cells-cloud/aspose-cells-cloud-ruby/23.8)
+![](https://img.shields.io/badge/REST%20API-v3.0-lightgrey) ![Gem](https://img.shields.io/gem/v/aspose_cells_cloud) ![Gem](https://img.shields.io/gem/dt/aspose_cells_cloud) [![GitHub license](https://img.shields.io/github/license/aspose-cells-cloud/aspose-cells-cloud-ruby)](https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby/blob/master/LICENSE) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/aspose-cells-cloud/aspose-cells-cloud-ruby/23.10)
 
 
 # Ruby SDK for Spreadsheet Processing in the Cloud
@@ -22,12 +22,14 @@ Ruby Cloud SDK wraps Aspose.Cells REST API so you could seamlessly integrate Mic
 - [Convert Excel files to popular formats](https://docs.aspose.cloud/cells/convert-excel-workbook-to-different-file-formats/).
 
 
-## Feature & Enhancements in Version 23.8
+## Feature & Enhancements in Version 23.10
 
 Full list of issues covering all changes in this release:
 
-- Support to lock API.
-- Optimize protect API.
+- Fix protect workbook request.
+- Fix range copy API.
+- Optimize workbook protect API.
+
 
 ## Read & Write Spreadsheet Formats
 

data/lib/aspose_cells_cloud/api/cells_api.rb

@@ -1149,6 +1149,22 @@ module AsposeCellsCloud
        return data
     end
 
+    # Remove duplicates on list object.
+
+    def post_worksheet_list_object_remove_duplicates( post_worksheet_list_object_remove_duplicates_request, opts = {})
+
+       data, _status_code, _headers = post_worksheet_list_object_remove_duplicates_request.create_http_request(@api_client,opts )
+       return data
+    end
+
+    # Insert slicer for list object.
+
+    def post_worksheet_list_object_insert_slicer( post_worksheet_list_object_insert_slicer_request, opts = {})
+
+       data, _status_code, _headers = post_worksheet_list_object_insert_slicer_request.create_http_request(@api_client,opts )
+       return data
+    end
+        
     # Update list column properties.
 
     def post_worksheet_list_column( post_worksheet_list_column_request, opts = {})
@@ -1605,9 +1621,9 @@ module AsposeCellsCloud
 
     # Copys content to destination range from source range in worksheet.
 
-    def post_worksheet_cells_ranges( post_worksheet_cells_ranges_request, opts = {})
+    def post_worksheet_cells_ranges_copy( post_worksheet_cells_ranges_copy_request, opts = {})
 
-       data, _status_code, _headers = post_worksheet_cells_ranges_request.create_http_request(@api_client,opts )
+       data, _status_code, _headers = post_worksheet_cells_ranges_copy_request.create_http_request(@api_client,opts )
        return data
     end
 
@@ -1661,6 +1677,13 @@ module AsposeCellsCloud
        return data
     end
 
+    # Sets outline border around a range of cells.
+    def post_worksheet_cells_range_sort( post_worksheet_cells_range_sort_request, opts = {})
+
+       data, _status_code, _headers = post_worksheet_cells_range_sort_request.create_http_request(@api_client,opts )
+       return data
+    end
+
     # Sets outline border around a range of cells.
 
     def post_worksheet_cells_range_outline_border( post_worksheet_cells_range_outline_border_request, opts = {})

data/lib/aspose_cells_cloud/models/above_average.rb

@@ -31,11 +31,11 @@ require 'date'
 module AsposeCellsCloud
 
   class AboveAverage
-        #Get or set the flag indicating whether the rule is an "above average" rule.   'true' indicates 'above average'.  Default value is true.                        
+        #Get or set the flag indicating whether the rule is an "above average" rule.             'true' indicates 'above average'.            Default value is true.             
         attr_accessor :is_above_average
-        #Get or set the flag indicating whether the 'aboveAverage' and 'belowAverage'   criteria is inclusive of the average itself, or exclusive of that value.   'true' indicates to include the average value in the criteria.  Default value   is false.                        
+        #Get or set the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria             is inclusive of the average itself, or exclusive of that value.             'true' indicates to include the average value in the criteria.            Default value is false.             
         attr_accessor :is_equal_average
-        #Get or set the number of standard deviations to include above or below the  average in the conditional formatting rule. The input value must between  0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set.   The default value is 0.                        
+        #Get or set the number of standard deviations to include above or below the average in the            conditional formatting rule.             The input value must between 0 and 3 (include 0 and 3).             Setting this value to 0 means stdDev is not set.            The default value is 0.             
         attr_accessor :std_dev
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/abstract_calculation_engine.rb

@@ -0,0 +1,234 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="AbstractCalculationEnginerb.cs">
+   Copyright (c) 2023 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 AbstractCalculationEngine
+        #Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false.             
+        attr_accessor :is_param_literal_required
+        #Indicates whether this engine needs the parameter to be calculated in array mode. Default value is false.            If  is required when calculating custom            functions, this property needs to be set as true.             
+        attr_accessor :is_param_array_mode_required
+        #Whether built-in functions that have been supported by the built-in engine            should be checked and processed by this implementation.            Default is false.            If user needs to change the calculation logic of some built-in functions, this property should be set as true.            Otherwise please leave this property as false for performance consideration.             
+        attr_accessor :process_built_in_functions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'is_param_literal_required' => :'IsParamLiteralRequired',
+        :'is_param_array_mode_required' => :'IsParamArrayModeRequired',
+        :'process_built_in_functions' => :'ProcessBuiltInFunctions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'is_param_literal_required' => :'BOOLEAN',
+        :'is_param_array_mode_required' => :'BOOLEAN',
+        :'process_built_in_functions' => :'BOOLEAN'
+      }
+    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?(:'IsParamLiteralRequired')
+          self.is_param_literal_required = attributes[:'IsParamLiteralRequired']
+      end
+      if attributes.has_key?(:'IsParamArrayModeRequired')
+          self.is_param_array_mode_required = attributes[:'IsParamArrayModeRequired']
+      end
+      if attributes.has_key?(:'ProcessBuiltInFunctions')
+          self.process_built_in_functions = attributes[:'ProcessBuiltInFunctions']
+      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 @is_param_literal_required.nil?
+          invalid_properties.push("invalid value for 'is_param_literal_required', is_param_literal_required cannot be nil.")
+      end
+      if @is_param_array_mode_required.nil?
+          invalid_properties.push("invalid value for 'is_param_array_mode_required', is_param_array_mode_required cannot be nil.")
+      end
+      if @process_built_in_functions.nil?
+          invalid_properties.push("invalid value for 'process_built_in_functions', process_built_in_functions 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 @is_param_literal_required.nil?
+      return false if @is_param_array_mode_required.nil?
+      return false if @process_built_in_functions.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 &&
+          is_param_literal_required == o.is_param_literal_required &&
+          is_param_array_mode_required == o.is_param_array_mode_required &&
+          process_built_in_functions == o.process_built_in_functions 
+          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
+      [ is_param_literal_required , is_param_array_mode_required , process_built_in_functions ].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/{barcode_response.rb → abstract_calculation_monitor.rb}

@@ -1,6 +1,6 @@
 =begin
 --------------------------------------------------------------------------------------------------------------------
- <copyright company="Aspose" file="BarcodeResponserb.cs">
+ <copyright company="Aspose" file="AbstractCalculationMonitorrb.cs">
    Copyright (c) 2023 Aspose.Cells Cloud
  </copyright>
  <summary>
@@ -30,33 +30,29 @@ require 'date'
 
 module AsposeCellsCloud
 
-  class BarcodeResponse
-        #Gets or sets barcode data.                        
-        attr_accessor :barcode_value
-        #Gets or sets type of the barcode.                        
-        attr_accessor :barcode_type
-        #Gets or sets region with barcode.                        
-        attr_accessor :region
-        #Gets or sets checksum of barcode.                        
-        attr_accessor :checksum
+  class AbstractCalculationMonitor
+        #Gets the old value of the calculated cell.            Should be used only in  and .             
+        attr_accessor :original_value
+        #Whether the cell's value has been changed after the calculation.            Should be used only in .             
+        attr_accessor :value_changed
+        #Gets the newly calculated value of the cell.            Should be used only in .             
+        attr_accessor :calculated_value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'barcode_value' => :'BarcodeValue',
-        :'barcode_type' => :'BarcodeType',
-        :'region' => :'Region',
-        :'checksum' => :'Checksum'
+        :'original_value' => :'OriginalValue',
+        :'value_changed' => :'ValueChanged',
+        :'calculated_value' => :'CalculatedValue'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'barcode_value' => :'String',
-        :'barcode_type' => :'String',
-        :'region' => :'Array<Point>',
-        :'checksum' => :'String'
+        :'original_value' => :'Object',
+        :'value_changed' => :'BOOLEAN',
+        :'calculated_value' => :'Object'
       }
     end
 
@@ -68,17 +64,14 @@ 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?(:'BarcodeValue')
-          self.barcode_value = attributes[:'BarcodeValue']
+      if attributes.has_key?(:'OriginalValue')
+          self.original_value = attributes[:'OriginalValue']
       end
-      if attributes.has_key?(:'BarcodeType')
-          self.barcode_type = attributes[:'BarcodeType']
+      if attributes.has_key?(:'ValueChanged')
+          self.value_changed = attributes[:'ValueChanged']
       end
-      if attributes.has_key?(:'Region')
-          self.region = attributes[:'Region']
-      end
-      if attributes.has_key?(:'Checksum')
-          self.checksum = attributes[:'Checksum']
+      if attributes.has_key?(:'CalculatedValue')
+          self.calculated_value = attributes[:'CalculatedValue']
       end
 
     end
@@ -87,17 +80,14 @@ module AsposeCellsCloud
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @barcode_value.nil?
-          invalid_properties.push("invalid value for 'barcode_value', barcode_value cannot be nil.")
-      end
-      if @barcode_type.nil?
-          invalid_properties.push("invalid value for 'barcode_type', barcode_type cannot be nil.")
+      if @original_value.nil?
+          invalid_properties.push("invalid value for 'original_value', original_value cannot be nil.")
       end
-      if @region.nil?
-          invalid_properties.push("invalid value for 'region', region cannot be nil.")
+      if @value_changed.nil?
+          invalid_properties.push("invalid value for 'value_changed', value_changed cannot be nil.")
       end
-      if @checksum.nil?
-          invalid_properties.push("invalid value for 'checksum', checksum cannot be nil.")
+      if @calculated_value.nil?
+          invalid_properties.push("invalid value for 'calculated_value', calculated_value cannot be nil.")
       end
 
       return invalid_properties
@@ -106,10 +96,9 @@ 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 @barcode_value.nil?
-      return false if @barcode_type.nil?
-      return false if @region.nil?
-      return false if @checksum.nil?
+      return false if @original_value.nil?
+      return false if @value_changed.nil?
+      return false if @calculated_value.nil?
       return true
     end
 
@@ -118,10 +107,9 @@ module AsposeCellsCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          barcode_value == o.barcode_value &&
-          barcode_type == o.barcode_type &&
-          region == o.region &&
-          checksum == o.checksum 
+          original_value == o.original_value &&
+          value_changed == o.value_changed &&
+          calculated_value == o.calculated_value 
           std_dev == o.std_dev
     end
 
@@ -134,7 +122,7 @@ module AsposeCellsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ barcode_value , barcode_type , region , checksum ].hash
+      [ original_value , value_changed , calculated_value ].hash
     end
 
     # Builds the object from hash

data/lib/aspose_cells_cloud/models/arc_shape.rb

@@ -31,17 +31,17 @@ require 'date'
 module AsposeCellsCloud
 
   class ArcShape
-        #            
+        #Gets and sets the begin arrow head length of the line.            
         attr_accessor :begin_arrowhead_length
-        #            
+        #Gets and sets the begin arrow head style of the line.            
         attr_accessor :begin_arrowhead_style
-        #            
+        #Gets and sets the begin arrow head width of the line.            
         attr_accessor :begin_arrowhead_width
-        #            
+        #Gets and sets the end arrow head length of the line.            
         attr_accessor :end_arrowhead_length
-        #            
+        #Gets and sets the end arrow head style of the line.            
         attr_accessor :end_arrowhead_style
-        #            
+        #Gets and sets the end arrow head width of the line.            
         attr_accessor :end_arrowhead_width
         #            
         attr_accessor :name

data/lib/aspose_cells_cloud/models/area.rb

@@ -31,17 +31,17 @@ require 'date'
 module AsposeCellsCloud
 
   class Area
-        #            
+        #Gets or sets the background  of the .             
         attr_accessor :background_color
-        #            
+        #Represents a  object that contains fill formatting properties for the specified chart or shape.             
         attr_accessor :fill_format
-        #            
+        #Gets or sets the foreground .             
         attr_accessor :foreground_color
         #            
         attr_accessor :format
-        #            
+        #If the property is true and the value of chart point is a negative number,            the foreground color and background color will be exchanged.             
         attr_accessor :invert_if_negative
-        #            
+        #Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).             
         attr_accessor :transparency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/auto_filter.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class AutoFilter
-        #            
+        #Gets the collection of the filter columns.            
         attr_accessor :filter_columns
-        #            
+        #Represents the range to which the specified AutoFilter applies.            
         attr_accessor :range
-        #            
+        #Gets the data sorter.            
         attr_accessor :sorter
-        #            
+        #Indicates whether the AutoFilter button for this column is visible.            
         attr_accessor :show_filter_button
         #            
         attr_accessor :link