spartera_api_sdk 1.0.74 → 1.0.77

data/lib/spartera_api_sdk/models/{user.rb → users.rb}

@@ -3,7 +3,7 @@
 
 #Auto-generated API documentation for REST services of the Spartera platform
 
-The version of the OpenAPI document: 0.0.0
+The version of the OpenAPI document: 1.24.0
 Contact: support@spartera.com
 Generated by: https://openapi-generator.tech
 Generator version: 7.13.0
@@ -14,38 +14,58 @@ require 'date'
 require 'time'
 
 module SparteraApiSdk
-  # Individual users within a company
-  class User
+  # Individual users within a company with SOC2 authentication tracking
+  class Users
+    attr_accessor :date_created
+
+    attr_accessor :last_updated
+
     attr_accessor :user_id
 
     attr_accessor :company_id
 
     attr_accessor :function_id
 
+    # Enum type: StatusCodes
     attr_accessor :status
 
     attr_accessor :email_address
 
     attr_accessor :timezone
 
-    attr_accessor :date_created
-
-    attr_accessor :last_updated
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
 
-    attr_accessor :active
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'date_created' => :'date_created',
+        :'last_updated' => :'last_updated',
         :'user_id' => :'user_id',
         :'company_id' => :'company_id',
         :'function_id' => :'function_id',
         :'status' => :'status',
         :'email_address' => :'email_address',
-        :'timezone' => :'timezone',
-        :'date_created' => :'date_created',
-        :'last_updated' => :'last_updated',
-        :'active' => :'active'
+        :'timezone' => :'timezone'
       }
     end
 
@@ -62,15 +82,14 @@ module SparteraApiSdk
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'date_created' => :'Time',
+        :'last_updated' => :'Time',
         :'user_id' => :'String',
         :'company_id' => :'String',
-        :'function_id' => :'String',
+        :'function_id' => :'Integer',
         :'status' => :'String',
         :'email_address' => :'String',
-        :'timezone' => :'String',
-        :'date_created' => :'String',
-        :'last_updated' => :'String',
-        :'active' => :'String'
+        :'timezone' => :'String'
       }
     end
 
@@ -84,18 +103,26 @@ module SparteraApiSdk
     # @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 `SparteraApiSdk::User` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SparteraApiSdk::Users` 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 `SparteraApiSdk::User`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SparteraApiSdk::Users`. 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?(:'date_created')
+        self.date_created = attributes[:'date_created']
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -123,18 +150,6 @@ module SparteraApiSdk
       if attributes.key?(:'timezone')
         self.timezone = attributes[:'timezone']
       end
-
-      if attributes.key?(:'date_created')
-        self.date_created = attributes[:'date_created']
-      end
-
-      if attributes.key?(:'last_updated')
-        self.last_updated = attributes[:'last_updated']
-      end
-
-      if attributes.key?(:'active')
-        self.active = attributes[:'active']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -159,6 +174,8 @@ module SparteraApiSdk
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @company_id.nil?
       return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "PENDING", "INACTIVE", "BANNED"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
@@ -172,13 +189,13 @@ module SparteraApiSdk
       @company_id = company_id
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] status Value to be assigned
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
     def status=(status)
-      if status.nil?
-        fail ArgumentError, 'status cannot be nil'
+      validator = EnumAttributeValidator.new('String', ["ACTIVE", "PENDING", "INACTIVE", "BANNED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
-
       @status = status
     end
 
@@ -187,15 +204,14 @@ module SparteraApiSdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          date_created == o.date_created &&
+          last_updated == o.last_updated &&
           user_id == o.user_id &&
           company_id == o.company_id &&
           function_id == o.function_id &&
           status == o.status &&
           email_address == o.email_address &&
-          timezone == o.timezone &&
-          date_created == o.date_created &&
-          last_updated == o.last_updated &&
-          active == o.active
+          timezone == o.timezone
     end
 
     # @see the `==` method
@@ -207,7 +223,7 @@ module SparteraApiSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [user_id, company_id, function_id, status, email_address, timezone, date_created, last_updated, active].hash
+      [date_created, last_updated, user_id, company_id, function_id, status, email_address, timezone].hash
     end
 
     # Builds the object from hash

data/lib/spartera_api_sdk/models/{me_get200_response_profile.rb → users_input.rb}

@@ -3,7 +3,7 @@
 
 #Auto-generated API documentation for REST services of the Spartera platform
 
-The version of the OpenAPI document: 0.0.0
+The version of the OpenAPI document: 1.24.0
 Contact: support@spartera.com
 Generated by: https://openapi-generator.tech
 Generator version: 7.13.0
@@ -14,37 +14,19 @@ require 'date'
 require 'time'
 
 module SparteraApiSdk
-  class MeGet200ResponseProfile
-    # User ID (primary key)
-    attr_accessor :id
-
-    # Profile type
-    attr_accessor :type
-
-    # Company ID
+  # Input schema for creating User
+  class UsersInput
     attr_accessor :company_id
 
-    # User function/role ID
     attr_accessor :function_id
 
-    # User status
+    # Enum type: StatusCodes
     attr_accessor :status
 
-    # User email address
     attr_accessor :email_address
 
-    # User timezone
     attr_accessor :timezone
 
-    # Account creation date
-    attr_accessor :date_created
-
-    # Last profile update
-    attr_accessor :last_updated
-
-    # Account active status
-    attr_accessor :active
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -70,16 +52,11 @@ module SparteraApiSdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'type' => :'type',
         :'company_id' => :'company_id',
         :'function_id' => :'function_id',
         :'status' => :'status',
         :'email_address' => :'email_address',
-        :'timezone' => :'timezone',
-        :'date_created' => :'date_created',
-        :'last_updated' => :'last_updated',
-        :'active' => :'active'
+        :'timezone' => :'timezone'
       }
     end
 
@@ -96,16 +73,11 @@ module SparteraApiSdk
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'type' => :'String',
         :'company_id' => :'String',
         :'function_id' => :'Integer',
         :'status' => :'String',
         :'email_address' => :'String',
-        :'timezone' => :'String',
-        :'date_created' => :'Time',
-        :'last_updated' => :'Time',
-        :'active' => :'Boolean'
+        :'timezone' => :'String'
       }
     end
 
@@ -119,28 +91,22 @@ module SparteraApiSdk
     # @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 `SparteraApiSdk::MeGet200ResponseProfile` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SparteraApiSdk::UsersInput` 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 `SparteraApiSdk::MeGet200ResponseProfile`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SparteraApiSdk::UsersInput`. 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?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      end
-
       if attributes.key?(:'company_id')
         self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
       end
 
       if attributes.key?(:'function_id')
@@ -158,18 +124,6 @@ module SparteraApiSdk
       if attributes.key?(:'timezone')
         self.timezone = attributes[:'timezone']
       end
-
-      if attributes.key?(:'date_created')
-        self.date_created = attributes[:'date_created']
-      end
-
-      if attributes.key?(:'last_updated')
-        self.last_updated = attributes[:'last_updated']
-      end
-
-      if attributes.key?(:'active')
-        self.active = attributes[:'active']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -177,6 +131,10 @@ module SparteraApiSdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -184,19 +142,30 @@ module SparteraApiSdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["human_user", "service_account"])
-      return false unless type_validator.valid?(@type)
+      return false if @company_id.nil?
+      status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "PENDING", "INACTIVE", "BANNED"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] company_id Value to be assigned
+    def company_id=(company_id)
+      if company_id.nil?
+        fail ArgumentError, 'company_id cannot be nil'
+      end
+
+      @company_id = company_id
+    end
+
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["human_user", "service_account"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["ACTIVE", "PENDING", "INACTIVE", "BANNED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
-      @type = type
+      @status = status
     end
 
     # Checks equality by comparing each attribute.
@@ -204,16 +173,11 @@ module SparteraApiSdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          type == o.type &&
           company_id == o.company_id &&
           function_id == o.function_id &&
           status == o.status &&
           email_address == o.email_address &&
-          timezone == o.timezone &&
-          date_created == o.date_created &&
-          last_updated == o.last_updated &&
-          active == o.active
+          timezone == o.timezone
     end
 
     # @see the `==` method
@@ -225,7 +189,7 @@ module SparteraApiSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, type, company_id, function_id, status, email_address, timezone, date_created, last_updated, active].hash
+      [company_id, function_id, status, email_address, timezone].hash
     end
 
     # Builds the object from hash

data/lib/spartera_api_sdk/models/users_update.rb

@@ -0,0 +1,292 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 1.24.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SparteraApiSdk
+  # Update schema for modifying User
+  class UsersUpdate
+    attr_accessor :company_id
+
+    attr_accessor :function_id
+
+    # Enum type: StatusCodes
+    attr_accessor :status
+
+    attr_accessor :email_address
+
+    attr_accessor :timezone
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'company_id' => :'company_id',
+        :'function_id' => :'function_id',
+        :'status' => :'status',
+        :'email_address' => :'email_address',
+        :'timezone' => :'timezone'
+      }
+    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
+      {
+        :'company_id' => :'String',
+        :'function_id' => :'Integer',
+        :'status' => :'String',
+        :'email_address' => :'String',
+        :'timezone' => :'String'
+      }
+    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 `SparteraApiSdk::UsersUpdate` 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 `SparteraApiSdk::UsersUpdate`. 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?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'function_id')
+        self.function_id = attributes[:'function_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      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'
+      status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "PENDING", "INACTIVE", "BANNED"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["ACTIVE", "PENDING", "INACTIVE", "BANNED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          company_id == o.company_id &&
+          function_id == o.function_id &&
+          status == o.status &&
+          email_address == o.email_address &&
+          timezone == o.timezone
+    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
+      [company_id, function_id, status, email_address, timezone].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = SparteraApiSdk.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        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
+
+    # 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