aspose_cells_cloud 20.11 → 21.6

data/lib/aspose_cells_cloud/models/pdf_save_options.rb

@@ -0,0 +1,355 @@
+=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 PdfSaveOptions
+    attr_accessor :enable_http_compression
+
+    attr_accessor :save_format
+
+    # Make the workbook empty after saving the file.
+    attr_accessor :clear_data
+
+    # The cached file folder is used to store some large data.
+    attr_accessor :cached_file_folder
+
+    # Indicates whether validate merged areas before saving the file. The default value is false.             
+    attr_accessor :validate_merged_areas
+
+    attr_accessor :refresh_chart_cache
+
+    # If true and the directory does not exist, the directory will be automatically created before saving the file.             
+    attr_accessor :create_directory
+
+    attr_accessor :sort_names
+
+    attr_accessor :calculate_formula
+
+    attr_accessor :check_font_compatibility
+
+    attr_accessor :one_page_per_sheet
+
+    attr_accessor :compliance
+
+    attr_accessor :default_font
+
+    attr_accessor :printing_page_type
+
+    attr_accessor :image_type
+
+    attr_accessor :desired_ppi
+
+    attr_accessor :jpeg_quality
+
+    attr_accessor :security_options
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enable_http_compression' => :'EnableHTTPCompression',
+        :'save_format' => :'SaveFormat',
+        :'clear_data' => :'ClearData',
+        :'cached_file_folder' => :'CachedFileFolder',
+        :'validate_merged_areas' => :'ValidateMergedAreas',
+        :'refresh_chart_cache' => :'RefreshChartCache',
+        :'create_directory' => :'CreateDirectory',
+        :'sort_names' => :'SortNames',
+        :'calculate_formula' => :'CalculateFormula',
+        :'check_font_compatibility' => :'CheckFontCompatibility',
+        :'one_page_per_sheet' => :'OnePagePerSheet',
+        :'compliance' => :'Compliance',
+        :'default_font' => :'DefaultFont',
+        :'printing_page_type' => :'PrintingPageType',
+        :'image_type' => :'ImageType',
+        :'desired_ppi' => :'desiredPPI',
+        :'jpeg_quality' => :'jpegQuality',
+        :'security_options' => :'SecurityOptions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'enable_http_compression' => :'BOOLEAN',
+        :'save_format' => :'String',
+        :'clear_data' => :'BOOLEAN',
+        :'cached_file_folder' => :'String',
+        :'validate_merged_areas' => :'BOOLEAN',
+        :'refresh_chart_cache' => :'BOOLEAN',
+        :'create_directory' => :'BOOLEAN',
+        :'sort_names' => :'BOOLEAN',
+        :'calculate_formula' => :'BOOLEAN',
+        :'check_font_compatibility' => :'BOOLEAN',
+        :'one_page_per_sheet' => :'BOOLEAN',
+        :'compliance' => :'String',
+        :'default_font' => :'String',
+        :'printing_page_type' => :'String',
+        :'image_type' => :'String',
+        :'desired_ppi' => :'Integer',
+        :'jpeg_quality' => :'Integer',
+        :'security_options' => :'PdfSecurityOptions'
+      }
+    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?(:'EnableHTTPCompression')
+        self.enable_http_compression = attributes[:'EnableHTTPCompression']
+      end
+
+      if attributes.has_key?(:'SaveFormat')
+        self.save_format = attributes[:'SaveFormat']
+      end
+
+      if attributes.has_key?(:'ClearData')
+        self.clear_data = attributes[:'ClearData']
+      end
+
+      if attributes.has_key?(:'CachedFileFolder')
+        self.cached_file_folder = attributes[:'CachedFileFolder']
+      end
+
+      if attributes.has_key?(:'ValidateMergedAreas')
+        self.validate_merged_areas = attributes[:'ValidateMergedAreas']
+      end
+
+      if attributes.has_key?(:'RefreshChartCache')
+        self.refresh_chart_cache = attributes[:'RefreshChartCache']
+      end
+
+      if attributes.has_key?(:'CreateDirectory')
+        self.create_directory = attributes[:'CreateDirectory']
+      end
+
+      if attributes.has_key?(:'SortNames')
+        self.sort_names = attributes[:'SortNames']
+      end
+
+      if attributes.has_key?(:'CalculateFormula')
+        self.calculate_formula = attributes[:'CalculateFormula']
+      end
+
+      if attributes.has_key?(:'CheckFontCompatibility')
+        self.check_font_compatibility = attributes[:'CheckFontCompatibility']
+      end
+
+      if attributes.has_key?(:'OnePagePerSheet')
+        self.one_page_per_sheet = attributes[:'OnePagePerSheet']
+      end
+
+      if attributes.has_key?(:'Compliance')
+        self.compliance = attributes[:'Compliance']
+      end
+
+      if attributes.has_key?(:'DefaultFont')
+        self.default_font = attributes[:'DefaultFont']
+      end
+
+      if attributes.has_key?(:'PrintingPageType')
+        self.printing_page_type = attributes[:'PrintingPageType']
+      end
+
+      if attributes.has_key?(:'ImageType')
+        self.image_type = attributes[:'ImageType']
+      end
+
+      if attributes.has_key?(:'desiredPPI')
+        self.desired_ppi = attributes[:'desiredPPI']
+      end
+
+      if attributes.has_key?(:'jpegQuality')
+        self.jpeg_quality = attributes[:'jpegQuality']
+      end
+
+      if attributes.has_key?(:'SecurityOptions')
+        self.security_options = attributes[:'SecurityOptions']
+      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 &&
+          enable_http_compression == o.enable_http_compression &&
+          save_format == o.save_format &&
+          clear_data == o.clear_data &&
+          cached_file_folder == o.cached_file_folder &&
+          validate_merged_areas == o.validate_merged_areas &&
+          refresh_chart_cache == o.refresh_chart_cache &&
+          create_directory == o.create_directory &&
+          sort_names == o.sort_names &&
+          calculate_formula == o.calculate_formula &&
+          check_font_compatibility == o.check_font_compatibility &&
+          one_page_per_sheet == o.one_page_per_sheet &&
+          compliance == o.compliance &&
+          default_font == o.default_font &&
+          printing_page_type == o.printing_page_type &&
+          image_type == o.image_type &&
+          desired_ppi == o.desired_ppi &&
+          jpeg_quality == o.jpeg_quality &&
+          security_options == o.security_options
+    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
+      [enable_http_compression, save_format, clear_data, cached_file_folder, validate_merged_areas, refresh_chart_cache, create_directory, sort_names, calculate_formula, check_font_compatibility, one_page_per_sheet, compliance, default_font, printing_page_type, image_type, desired_ppi, jpeg_quality, security_options].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/pdf_security_options.rb

@@ -0,0 +1,283 @@
+=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 PdfSecurityOptions
+    attr_accessor :annotations_permission
+
+    attr_accessor :assemble_document_permission
+
+    # Make the workbook empty after saving the file.
+    attr_accessor :extract_content_permission
+
+    # The cached file folder is used to store some large data.
+    attr_accessor :extract_content_permission_obsolete
+
+    # Indicates whether validate merged areas before saving the file. The default value is false.             
+    attr_accessor :fill_forms_permission
+
+    attr_accessor :full_quality_print_permission
+
+    # If true and the directory does not exist, the directory will be automatically created before saving the file.             
+    attr_accessor :modify_document_permission
+
+    attr_accessor :owner_password
+
+    attr_accessor :print_permission
+
+    attr_accessor :user_password
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'annotations_permission' => :'AnnotationsPermission',
+        :'assemble_document_permission' => :'AssembleDocumentPermission',
+        :'extract_content_permission' => :'ExtractContentPermission',
+        :'extract_content_permission_obsolete' => :'ExtractContentPermissionObsolete',
+        :'fill_forms_permission' => :'FillFormsPermission',
+        :'full_quality_print_permission' => :'FullQualityPrintPermission',
+        :'modify_document_permission' => :'ModifyDocumentPermission',
+        :'owner_password' => :'OwnerPassword',
+        :'print_permission' => :'PrintPermission',
+        :'user_password' => :'UserPassword'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'annotations_permission' => :'BOOLEAN',
+        :'assemble_document_permission' => :'BOOLEAN',
+        :'extract_content_permission' => :'BOOLEAN',
+        :'extract_content_permission_obsolete' => :'BOOLEAN',
+        :'fill_forms_permission' => :'BOOLEAN',
+        :'full_quality_print_permission' => :'BOOLEAN',
+        :'modify_document_permission' => :'BOOLEAN',
+        :'owner_password' => :'String',
+        :'print_permission' => :'BOOLEAN',
+        :'user_password' => :'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?(:'AnnotationsPermission')
+        self.annotations_permission = attributes[:'AnnotationsPermission']
+      end
+
+      if attributes.has_key?(:'AssembleDocumentPermission')
+        self.assemble_document_permission = attributes[:'AssembleDocumentPermission']
+      end
+
+      if attributes.has_key?(:'ExtractContentPermission')
+        self.extract_content_permission = attributes[:'ExtractContentPermission']
+      end
+
+      if attributes.has_key?(:'ExtractContentPermissionObsolete')
+        self.extract_content_permission_obsolete = attributes[:'ExtractContentPermissionObsolete']
+      end
+
+      if attributes.has_key?(:'FillFormsPermission')
+        self.fill_forms_permission = attributes[:'FillFormsPermission']
+      end
+
+      if attributes.has_key?(:'FullQualityPrintPermission')
+        self.full_quality_print_permission = attributes[:'FullQualityPrintPermission']
+      end
+
+      if attributes.has_key?(:'ModifyDocumentPermission')
+        self.modify_document_permission = attributes[:'ModifyDocumentPermission']
+      end
+
+      if attributes.has_key?(:'OwnerPassword')
+        self.owner_password = attributes[:'OwnerPassword']
+      end
+
+      if attributes.has_key?(:'PrintPermission')
+        self.print_permission = attributes[:'PrintPermission']
+      end
+
+      if attributes.has_key?(:'UserPassword')
+        self.user_password = attributes[:'UserPassword']
+      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 &&
+          annotations_permission == o.annotations_permission &&
+          assemble_document_permission == o.assemble_document_permission &&
+          extract_content_permission == o.extract_content_permission &&
+          extract_content_permission_obsolete == o.extract_content_permission_obsolete &&
+          fill_forms_permission == o.fill_forms_permission &&
+          full_quality_print_permission == o.full_quality_print_permission &&
+          modify_document_permission == o.modify_document_permission &&
+          owner_password == o.owner_password &&
+          print_permission == o.print_permission &&
+          user_password == o.user_password
+    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
+      [annotations_permission, assemble_document_permission, extract_content_permission, extract_content_permission_obsolete, fill_forms_permission, full_quality_print_permission, modify_document_permission, owner_password, print_permission, user_password].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