docspace-api-sdk 4.0.0

data/lib/docspace-api-sdk/models/update-api-key-request.rb

@@ -0,0 +1,212 @@
+# (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 request parameters for updating an existing API key.
+  class UpdateApiKeyRequest < ApiModelBase
+    # The new label of the key, up to 30 characters, neither empty nor made of whitespace only. Omit it to keep the  current name.
+    attr_accessor :name
+
+    # The scopes that replace the current ones. Every value has to come from `GET api/2.0/keys/permissions`, an  unknown value or an empty array is rejected, and omitting the field keeps the current scopes.
+    attr_accessor :permissions
+
+    # Whether the key may authenticate requests. Set it to false to stop the key without deleting it and to true to  let it work again; omit it to keep the current state.
+    attr_accessor :is_active
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'permissions' => :'permissions',
+        :'is_active' => :'isActive'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'permissions' => :'Array<String>',
+        :'is_active' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'permissions',
+        :'is_active'
+      ])
+    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::UpdateApiKeyRequest` 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::UpdateApiKeyRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'permissions')
+        if (value = attributes[:'permissions']).is_a?(Array)
+          self.permissions = value
+        end
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      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 !@name.nil? && @name.to_s.length > 30
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 30.')
+      end
+
+      if !@name.nil? && @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/[\s\S]*\S[\s\S]*/)
+      if !@name.nil? && @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      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 !@name.nil? && @name.to_s.length > 30
+      return false if !@name.nil? && @name.to_s.length < 1
+      return false if !@name.nil? && @name !~ Regexp.new(/[\s\S]*\S[\s\S]*/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 30
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 30.'
+      end
+
+      if !name.nil? && name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/[\s\S]*\S[\s\S]*/)
+      if !name.nil? && name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    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 &&
+          name == o.name &&
+          permissions == o.permissions &&
+          is_active == o.is_active
+    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
+      [name, permissions, is_active].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/update-client-request.rb

@@ -0,0 +1,424 @@
+# (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
+  # Client update request containing modified client details
+  class UpdateClientRequest < ApiModelBase
+    # The display name shown to the user on the consent screen. It has to be between 3 and 256 characters long.
+    attr_accessor :name
+
+    # The free-text description shown next to the name on the consent screen, at most 255 characters.
+    attr_accessor :description
+
+    # The client logo as a data URI carrying base64 image data, shown on the consent screen. Only png, jpeg, jpg and svg+xml are accepted.
+    attr_accessor :logo
+
+    # The permissions the client may ask for, named as they appear in the tenant scope catalogue - for example files:read, rooms:write or openid. A client cannot request a scope that is not listed here.
+    attr_accessor :scopes
+
+    # Whether the client may use PKCE. Turning it on lets the client authenticate with the none method and prove itself with a code verifier instead of sending a secret, which is what a client that cannot keep a secret needs.
+    attr_accessor :allow_pkce
+
+    # The web origins allowed to call the portal on behalf of this client, used for the CORS check. The set holds between 1 and 12 addresses.
+    attr_accessor :allowed_origins
+
+    # The URIs an authorization code may be delivered to. An authorization request naming any other URI is refused, and the set holds between 1 and 12 addresses.
+    attr_accessor :redirect_uris
+
+    # Whether the client is offered to third-party tenants rather than only to the tenant that registers it.
+    attr_accessor :is_public
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'description' => :'description',
+        :'logo' => :'logo',
+        :'scopes' => :'scopes',
+        :'allow_pkce' => :'allow_pkce',
+        :'allowed_origins' => :'allowed_origins',
+        :'redirect_uris' => :'redirect_uris',
+        :'is_public' => :'is_public'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'logo' => :'String',
+        :'scopes' => :'Array<String>',
+        :'allow_pkce' => :'Boolean',
+        :'allowed_origins' => :'Array<String>',
+        :'redirect_uris' => :'Array<String>',
+        :'is_public' => :'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::UpdateClientRequest` 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::UpdateClientRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'logo')
+        self.logo = attributes[:'logo']
+      else
+        self.logo = nil
+      end
+
+      if attributes.key?(:'scopes')
+        if (value = attributes[:'scopes']).is_a?(Array)
+          self.scopes = value
+        end
+      else
+        self.scopes = nil
+      end
+
+      if attributes.key?(:'allow_pkce')
+        self.allow_pkce = attributes[:'allow_pkce']
+      end
+
+      if attributes.key?(:'allowed_origins')
+        if (value = attributes[:'allowed_origins']).is_a?(Array)
+          self.allowed_origins = value
+        end
+      else
+        self.allowed_origins = nil
+      end
+
+      if attributes.key?(:'redirect_uris')
+        if (value = attributes[:'redirect_uris']).is_a?(Array)
+          self.redirect_uris = value
+        end
+      else
+        self.redirect_uris = nil
+      end
+
+      if attributes.key?(:'is_public')
+        self.is_public = attributes[:'is_public']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 256
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 256.')
+      end
+
+      if @name.to_s.length < 3
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 3.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 255
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@description.nil? && @description.to_s.length < 0
+        invalid_properties.push('invalid value for "description", the character length must be greater than or equal to 0.')
+      end
+
+      if @logo.nil?
+        invalid_properties.push('invalid value for "logo", logo cannot be nil.')
+      end
+
+      if @logo.to_s.length < 1
+        invalid_properties.push('invalid value for "logo", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^data:image\/(?:png|jpeg|jpg|svg\+xml);base64,.*.{1,}/)
+      if @logo !~ pattern
+        invalid_properties.push("invalid value for \"logo\", must conform to the pattern #{pattern}.")
+      end
+
+      if @scopes.nil?
+        invalid_properties.push('invalid value for "scopes", scopes cannot be nil.')
+      end
+
+      if @scopes.length < 1
+        invalid_properties.push('invalid value for "scopes", number of items must be greater than or equal to 1.')
+      end
+
+      if @allowed_origins.nil?
+        invalid_properties.push('invalid value for "allowed_origins", allowed_origins cannot be nil.')
+      end
+
+      if @allowed_origins.length > 12
+        invalid_properties.push('invalid value for "allowed_origins", number of items must be less than or equal to 12.')
+      end
+
+      if @allowed_origins.length < 1
+        invalid_properties.push('invalid value for "allowed_origins", number of items must be greater than or equal to 1.')
+      end
+
+      if @redirect_uris.nil?
+        invalid_properties.push('invalid value for "redirect_uris", redirect_uris cannot be nil.')
+      end
+
+      if @redirect_uris.length > 12
+        invalid_properties.push('invalid value for "redirect_uris", number of items must be less than or equal to 12.')
+      end
+
+      if @redirect_uris.length < 1
+        invalid_properties.push('invalid value for "redirect_uris", number of items must be greater than or equal to 1.')
+      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 @name.nil?
+      return false if @name.to_s.length > 256
+      return false if @name.to_s.length < 3
+      return false if !@description.nil? && @description.to_s.length > 255
+      return false if !@description.nil? && @description.to_s.length < 0
+      return false if @logo.nil?
+      return false if @logo.to_s.length < 1
+      return false if @logo !~ Regexp.new(/^data:image\/(?:png|jpeg|jpg|svg\+xml);base64,.*.{1,}/)
+      return false if @scopes.nil?
+      return false if @scopes.length < 1
+      return false if @allowed_origins.nil?
+      return false if @allowed_origins.length > 12
+      return false if @allowed_origins.length < 1
+      return false if @redirect_uris.nil?
+      return false if @redirect_uris.length > 12
+      return false if @redirect_uris.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 256
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 256.'
+      end
+
+      if name.to_s.length < 3
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 3.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 255
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
+      end
+
+      if description.to_s.length < 0
+        fail ArgumentError, 'invalid value for "description", the character length must be greater than or equal to 0.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] logo Value to be assigned
+    def logo=(logo)
+      if logo.nil?
+        fail ArgumentError, 'logo cannot be nil'
+      end
+
+      if logo.to_s.length < 1
+        fail ArgumentError, 'invalid value for "logo", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^data:image\/(?:png|jpeg|jpg|svg\+xml);base64,.*.{1,}/)
+      if logo !~ pattern
+        fail ArgumentError, "invalid value for \"logo\", must conform to the pattern #{pattern}."
+      end
+
+      @logo = logo
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scopes Value to be assigned
+    def scopes=(scopes)
+      if scopes.nil?
+        fail ArgumentError, 'scopes cannot be nil'
+      end
+
+      if scopes.length < 1
+        fail ArgumentError, 'invalid value for "scopes", number of items must be greater than or equal to 1.'
+      end
+
+      @scopes = scopes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] allowed_origins Value to be assigned
+    def allowed_origins=(allowed_origins)
+      if allowed_origins.nil?
+        fail ArgumentError, 'allowed_origins cannot be nil'
+      end
+
+      if allowed_origins.length > 12
+        fail ArgumentError, 'invalid value for "allowed_origins", number of items must be less than or equal to 12.'
+      end
+
+      if allowed_origins.length < 1
+        fail ArgumentError, 'invalid value for "allowed_origins", number of items must be greater than or equal to 1.'
+      end
+
+      @allowed_origins = allowed_origins
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] redirect_uris Value to be assigned
+    def redirect_uris=(redirect_uris)
+      if redirect_uris.nil?
+        fail ArgumentError, 'redirect_uris cannot be nil'
+      end
+
+      if redirect_uris.length > 12
+        fail ArgumentError, 'invalid value for "redirect_uris", number of items must be less than or equal to 12.'
+      end
+
+      if redirect_uris.length < 1
+        fail ArgumentError, 'invalid value for "redirect_uris", number of items must be greater than or equal to 1.'
+      end
+
+      @redirect_uris = redirect_uris
+    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 &&
+          name == o.name &&
+          description == o.description &&
+          logo == o.logo &&
+          scopes == o.scopes &&
+          allow_pkce == o.allow_pkce &&
+          allowed_origins == o.allowed_origins &&
+          redirect_uris == o.redirect_uris &&
+          is_public == o.is_public
+    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
+      [name, description, logo, scopes, allow_pkce, allowed_origins, redirect_uris, is_public].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