spartera_api_sdk 1.0.74 → 1.0.78

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

@@ -3,10 +3,10 @@
 
 #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.25.0
 Contact: support@spartera.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.13.0
+Generator version: 7.21.0
 
 =end
 
@@ -14,36 +14,28 @@ 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 < ApiModelBase
+    # References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.
     attr_accessor :company_id
 
-    # User function/role ID
+    # User's role for RBAC - single source of truth
+    attr_accessor :role_id
+
+    # User's job function/title
     attr_accessor :function_id
 
-    # User status
+    # Required. One of: ACTIVE, PENDING, INACTIVE, BANNED.
     attr_accessor :status
 
-    # User email address
+    # Optional. Must be unique.
     attr_accessor :email_address
 
-    # User timezone
+    # Optional.
     attr_accessor :timezone
 
-    # Account creation date
-    attr_accessor :date_created
-
-    # Last profile update
-    attr_accessor :last_updated
-
-    # Account active status
-    attr_accessor :active
+    # Whether user has opted out of marketing communications. Default false = opted in per ToS.
+    attr_accessor :marketing_opt_out
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -70,16 +62,13 @@ module SparteraApiSdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'type' => :'type',
         :'company_id' => :'company_id',
+        :'role_id' => :'role_id',
         :'function_id' => :'function_id',
         :'status' => :'status',
         :'email_address' => :'email_address',
         :'timezone' => :'timezone',
-        :'date_created' => :'date_created',
-        :'last_updated' => :'last_updated',
-        :'active' => :'active'
+        :'marketing_opt_out' => :'marketing_opt_out'
       }
     end
 
@@ -96,16 +85,13 @@ module SparteraApiSdk
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'type' => :'String',
         :'company_id' => :'String',
+        :'role_id' => :'Integer',
         :'function_id' => :'Integer',
         :'status' => :'String',
         :'email_address' => :'String',
         :'timezone' => :'String',
-        :'date_created' => :'Time',
-        :'last_updated' => :'Time',
-        :'active' => :'Boolean'
+        :'marketing_opt_out' => :'Boolean'
       }
     end
 
@@ -119,28 +105,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::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?(:'role_id')
+        self.role_id = attributes[:'role_id']
       end
 
       if attributes.key?(:'function_id')
@@ -159,16 +143,8 @@ module SparteraApiSdk
         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']
+      if attributes.key?(:'marketing_opt_out')
+        self.marketing_opt_out = attributes[:'marketing_opt_out']
       end
     end
 
@@ -177,6 +153,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 +164,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 +195,13 @@ 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 &&
+          role_id == o.role_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
+          marketing_opt_out == o.marketing_opt_out
     end
 
     # @see the `==` method
@@ -225,7 +213,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, role_id, function_id, status, email_address, timezone, marketing_opt_out].hash
     end
 
     # Builds the object from hash
@@ -251,61 +239,6 @@ module SparteraApiSdk
       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
@@ -322,24 +255,6 @@ module SparteraApiSdk
       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/spartera_api_sdk/models/{me_get200_response_token_metadata.rb → users_update.rb}

@@ -3,10 +3,10 @@
 
 #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.25.0
 Contact: support@spartera.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.13.0
+Generator version: 7.21.0
 
 =end
 
@@ -14,27 +14,61 @@ require 'date'
 require 'time'
 
 module SparteraApiSdk
-  # JWT token metadata (null for API keys)
-  class MeGet200ResponseTokenMetadata
-    # Token issuer
-    attr_accessor :issuer
-
-    # Authentication time
-    attr_accessor :auth_time
-
-    # Token issued timestamp
-    attr_accessor :issued_at
+  # Update schema for modifying User
+  class UsersUpdate < ApiModelBase
+    # References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.
+    attr_accessor :company_id
+
+    # User's role for RBAC - single source of truth
+    attr_accessor :role_id
+
+    # User's job function/title
+    attr_accessor :function_id
+
+    # Required. One of: ACTIVE, PENDING, INACTIVE, BANNED.
+    attr_accessor :status
+
+    # Optional. Must be unique.
+    attr_accessor :email_address
+
+    # Optional.
+    attr_accessor :timezone
+
+    # Whether user has opted out of marketing communications. Default false = opted in per ToS.
+    attr_accessor :marketing_opt_out
+
+    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
 
-    # Token expiration timestamp
-    attr_accessor :expires_at
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'issuer' => :'issuer',
-        :'auth_time' => :'auth_time',
-        :'issued_at' => :'issued_at',
-        :'expires_at' => :'expires_at'
+        :'company_id' => :'company_id',
+        :'role_id' => :'role_id',
+        :'function_id' => :'function_id',
+        :'status' => :'status',
+        :'email_address' => :'email_address',
+        :'timezone' => :'timezone',
+        :'marketing_opt_out' => :'marketing_opt_out'
       }
     end
 
@@ -51,10 +85,13 @@ module SparteraApiSdk
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'issuer' => :'String',
-        :'auth_time' => :'Integer',
-        :'issued_at' => :'Integer',
-        :'expires_at' => :'Integer'
+        :'company_id' => :'String',
+        :'role_id' => :'Integer',
+        :'function_id' => :'Integer',
+        :'status' => :'String',
+        :'email_address' => :'String',
+        :'timezone' => :'String',
+        :'marketing_opt_out' => :'Boolean'
       }
     end
 
@@ -68,32 +105,44 @@ 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::MeGet200ResponseTokenMetadata` initialize method"
+        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::MeGet200ResponseTokenMetadata`. 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::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?(:'issuer')
-        self.issuer = attributes[:'issuer']
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'role_id')
+        self.role_id = attributes[:'role_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?(:'auth_time')
-        self.auth_time = attributes[:'auth_time']
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
       end
 
-      if attributes.key?(:'issued_at')
-        self.issued_at = attributes[:'issued_at']
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
       end
 
-      if attributes.key?(:'expires_at')
-        self.expires_at = attributes[:'expires_at']
+      if attributes.key?(:'marketing_opt_out')
+        self.marketing_opt_out = attributes[:'marketing_opt_out']
       end
     end
 
@@ -109,18 +158,33 @@ module SparteraApiSdk
     # @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 &&
-          issuer == o.issuer &&
-          auth_time == o.auth_time &&
-          issued_at == o.issued_at &&
-          expires_at == o.expires_at
+          company_id == o.company_id &&
+          role_id == o.role_id &&
+          function_id == o.function_id &&
+          status == o.status &&
+          email_address == o.email_address &&
+          timezone == o.timezone &&
+          marketing_opt_out == o.marketing_opt_out
     end
 
     # @see the `==` method
@@ -132,7 +196,7 @@ module SparteraApiSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [issuer, auth_time, issued_at, expires_at].hash
+      [company_id, role_id, function_id, status, email_address, timezone, marketing_opt_out].hash
     end
 
     # Builds the object from hash
@@ -158,61 +222,6 @@ module SparteraApiSdk
       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
@@ -229,24 +238,6 @@ module SparteraApiSdk
       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/spartera_api_sdk/version.rb

@@ -1,3 +1,15 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 1.25.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
 module SparteraApiSdk
-  VERSION = '1.0.74'
+  VERSION = '1.0.78'
 end