docspace-api-sdk 4.0.0

data/lib/docspace-api-sdk/models/password-hash-settings-dto.rb

@@ -0,0 +1,173 @@
+# (c) Copyright Ascensio System SIA 2026
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'date'
+require 'time'
+
+module DocspaceApiSdk
+  # The parameters a client hashes a password with before sending it.
+  class PasswordHashSettingsDto < ApiModelBase
+    # The length of the hash, in bytes.
+    attr_accessor :size
+
+    # The number of PBKDF2 iterations.
+    attr_accessor :iterations
+
+    # The salt the installation hashes passwords with.
+    attr_accessor :salt
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'size' => :'size',
+        :'iterations' => :'iterations',
+        :'salt' => :'salt'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'size' => :'Integer',
+        :'iterations' => :'Integer',
+        :'salt' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'salt'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocspaceApiSdk::PasswordHashSettingsDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocspaceApiSdk::PasswordHashSettingsDto`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      end
+
+      if attributes.key?(:'iterations')
+        self.iterations = attributes[:'iterations']
+      end
+
+      if attributes.key?(:'salt')
+        self.salt = attributes[:'salt']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          size == o.size &&
+          iterations == o.iterations &&
+          salt == o.salt
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [size, iterations, salt].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/docspace-api-sdk/models/password-settings-dto.rb

@@ -0,0 +1,302 @@
+# (c) Copyright Ascensio System SIA 2026
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'date'
+require 'time'
+
+module DocspaceApiSdk
+  # The password policy of the portal, with the expressions a client can check a password against.
+  class PasswordSettingsDto < ApiModelBase
+    # The shortest password the portal accepts, 8 characters on a portal nobody has configured. Whatever the  policy says, a password longer than 30 characters is refused as well, and that ceiling is not reported  here.
+    attr_accessor :min_length
+
+    # Whether at least one uppercase letter is demanded. While it is `false` an uppercase letter is still  allowed - the flag adds a requirement rather than permission.
+    attr_accessor :upper_case
+
+    # Whether at least one digit is demanded, read the same way as `upperCase`.
+    attr_accessor :digits
+
+    # Whether at least one special symbol is demanded, read the same way as `upperCase`. Which symbols count is  spelled out by `specSymbolsRegexStr`.
+    attr_accessor :spec_symbols
+
+    # The expression the whole password has to match, which is what defines the alphabet the portal accepts at  all. It comes from the installation's configuration rather than from the portal policy, so it is the same  for every portal of an installation and unaffected by the flags above.
+    attr_accessor :allowed_characters_regex_str
+
+    # The look-ahead expression that tests the digit requirement, meant to be applied only while `digits` is  `true`. It is always filled in, so its presence is not itself a requirement.
+    attr_accessor :digits_regex_str
+
+    # The look-ahead expression that tests the uppercase requirement, to be applied while `upperCase` is `true`.
+    attr_accessor :upper_case_regex_str
+
+    # The look-ahead expression that tests the special-symbol requirement, to be applied while `specSymbols` is  `true`. It also enumerates the symbols the portal treats as special.
+    attr_accessor :spec_symbols_regex_str
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'min_length' => :'minLength',
+        :'upper_case' => :'upperCase',
+        :'digits' => :'digits',
+        :'spec_symbols' => :'specSymbols',
+        :'allowed_characters_regex_str' => :'allowedCharactersRegexStr',
+        :'digits_regex_str' => :'digitsRegexStr',
+        :'upper_case_regex_str' => :'upperCaseRegexStr',
+        :'spec_symbols_regex_str' => :'specSymbolsRegexStr'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'min_length' => :'Integer',
+        :'upper_case' => :'Boolean',
+        :'digits' => :'Boolean',
+        :'spec_symbols' => :'Boolean',
+        :'allowed_characters_regex_str' => :'String',
+        :'digits_regex_str' => :'String',
+        :'upper_case_regex_str' => :'String',
+        :'spec_symbols_regex_str' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'allowed_characters_regex_str',
+        :'digits_regex_str',
+        :'upper_case_regex_str',
+        :'spec_symbols_regex_str'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocspaceApiSdk::PasswordSettingsDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocspaceApiSdk::PasswordSettingsDto`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'min_length')
+        self.min_length = attributes[:'min_length']
+      else
+        self.min_length = nil
+      end
+
+      if attributes.key?(:'upper_case')
+        self.upper_case = attributes[:'upper_case']
+      else
+        self.upper_case = nil
+      end
+
+      if attributes.key?(:'digits')
+        self.digits = attributes[:'digits']
+      else
+        self.digits = nil
+      end
+
+      if attributes.key?(:'spec_symbols')
+        self.spec_symbols = attributes[:'spec_symbols']
+      else
+        self.spec_symbols = nil
+      end
+
+      if attributes.key?(:'allowed_characters_regex_str')
+        self.allowed_characters_regex_str = attributes[:'allowed_characters_regex_str']
+      else
+        self.allowed_characters_regex_str = nil
+      end
+
+      if attributes.key?(:'digits_regex_str')
+        self.digits_regex_str = attributes[:'digits_regex_str']
+      else
+        self.digits_regex_str = nil
+      end
+
+      if attributes.key?(:'upper_case_regex_str')
+        self.upper_case_regex_str = attributes[:'upper_case_regex_str']
+      else
+        self.upper_case_regex_str = nil
+      end
+
+      if attributes.key?(:'spec_symbols_regex_str')
+        self.spec_symbols_regex_str = attributes[:'spec_symbols_regex_str']
+      else
+        self.spec_symbols_regex_str = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @min_length.nil?
+        invalid_properties.push('invalid value for "min_length", min_length cannot be nil.')
+      end
+
+      if @upper_case.nil?
+        invalid_properties.push('invalid value for "upper_case", upper_case cannot be nil.')
+      end
+
+      if @digits.nil?
+        invalid_properties.push('invalid value for "digits", digits cannot be nil.')
+      end
+
+      if @spec_symbols.nil?
+        invalid_properties.push('invalid value for "spec_symbols", spec_symbols cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @min_length.nil?
+      return false if @upper_case.nil?
+      return false if @digits.nil?
+      return false if @spec_symbols.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_length Value to be assigned
+    def min_length=(min_length)
+      if min_length.nil?
+        fail ArgumentError, 'min_length cannot be nil'
+      end
+
+      @min_length = min_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] upper_case Value to be assigned
+    def upper_case=(upper_case)
+      if upper_case.nil?
+        fail ArgumentError, 'upper_case cannot be nil'
+      end
+
+      @upper_case = upper_case
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] digits Value to be assigned
+    def digits=(digits)
+      if digits.nil?
+        fail ArgumentError, 'digits cannot be nil'
+      end
+
+      @digits = digits
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] spec_symbols Value to be assigned
+    def spec_symbols=(spec_symbols)
+      if spec_symbols.nil?
+        fail ArgumentError, 'spec_symbols cannot be nil'
+      end
+
+      @spec_symbols = spec_symbols
+    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 &&
+          min_length == o.min_length &&
+          upper_case == o.upper_case &&
+          digits == o.digits &&
+          spec_symbols == o.spec_symbols &&
+          allowed_characters_regex_str == o.allowed_characters_regex_str &&
+          digits_regex_str == o.digits_regex_str &&
+          upper_case_regex_str == o.upper_case_regex_str &&
+          spec_symbols_regex_str == o.spec_symbols_regex_str
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [min_length, upper_case, digits, spec_symbols, allowed_characters_regex_str, digits_regex_str, upper_case_regex_str, spec_symbols_regex_str].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/docspace-api-sdk/models/password-settings-request-dto.rb

@@ -0,0 +1,199 @@
+# (c) Copyright Ascensio System SIA 2026
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'date'
+require 'time'
+
+module DocspaceApiSdk
+  # The four values that make up the portal password policy, replaced together.
+  class PasswordSettingsRequestDto < ApiModelBase
+    # The shortest password the portal will accept. It has to sit between the floor the installation is configured  with, 8 characters unless it was changed, and the ceiling of 30; a value outside that is refused with 400.
+    attr_accessor :min_length
+
+    # Whether a password must contain at least one uppercase letter. There is no partial update on this body, so  leaving the flag out stores it as `false` and drops the requirement.
+    attr_accessor :upper_case
+
+    # Whether a password must contain at least one digit. Leaving the flag out stores it as `false` and drops the  requirement.
+    attr_accessor :digits
+
+    # Whether a password must contain at least one special symbol. Leaving the flag out stores it as `false` and  drops the requirement.
+    attr_accessor :spec_symbols
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'min_length' => :'minLength',
+        :'upper_case' => :'upperCase',
+        :'digits' => :'digits',
+        :'spec_symbols' => :'specSymbols'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'min_length' => :'Integer',
+        :'upper_case' => :'Boolean',
+        :'digits' => :'Boolean',
+        :'spec_symbols' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocspaceApiSdk::PasswordSettingsRequestDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocspaceApiSdk::PasswordSettingsRequestDto`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'min_length')
+        self.min_length = attributes[:'min_length']
+      else
+        self.min_length = nil
+      end
+
+      if attributes.key?(:'upper_case')
+        self.upper_case = attributes[:'upper_case']
+      end
+
+      if attributes.key?(:'digits')
+        self.digits = attributes[:'digits']
+      end
+
+      if attributes.key?(:'spec_symbols')
+        self.spec_symbols = attributes[:'spec_symbols']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @min_length.nil?
+        invalid_properties.push('invalid value for "min_length", min_length cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @min_length.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_length Value to be assigned
+    def min_length=(min_length)
+      if min_length.nil?
+        fail ArgumentError, 'min_length cannot be nil'
+      end
+
+      @min_length = min_length
+    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 &&
+          min_length == o.min_length &&
+          upper_case == o.upper_case &&
+          digits == o.digits &&
+          spec_symbols == o.spec_symbols
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [min_length, upper_case, digits, spec_symbols].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end