masspay_ruby_sdk 1.0.0

data/lib/masspay_ruby_sdk/models/stored_user.rb

@@ -0,0 +1,500 @@
+=begin
+#MassPay API
+
+#MassPay API
+
+The version of the OpenAPI document: 0.1.4
+Contact: support@masspay.io
+Generated by: MassPay Inc.
+OpenAPI Generator version: 6.5.0
+=end
+
+require 'date'
+require 'time'
+
+module MassPayRubySdk
+  class StoredUser
+    # Token representing the user that was just created
+    attr_accessor :user_token
+
+    # The status of the user
+    attr_accessor :status
+
+    # The timestamp the user was created in the system. Using UTC timestamp.[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+    attr_accessor :created_on
+
+    # A client-defined identifier for the user. This is the unique ID assigned to the user on your system. Max 75 characters. Allows letters, numbers, and + , - . / _ ~ |
+    attr_accessor :internal_user_id
+
+    # The user's street address.
+    attr_accessor :address1
+
+    # The user's street address, line 2.
+    attr_accessor :address2
+
+    # The user's city.
+    attr_accessor :city
+
+    # The user's state/province.
+    attr_accessor :state_province
+
+    # The user's postal code.
+    attr_accessor :postal_code
+
+    # The user's country code. ISO_3166-1_alpha-3 code
+    attr_accessor :country
+
+    # The user's first name. (If Business account, the first name of the representative)
+    attr_accessor :first_name
+
+    # The user's middle name. (If Business account, the middle name of the representative)
+    attr_accessor :middle_name
+
+    # The user's last name. (If Business account, the last name of the representative)
+    attr_accessor :last_name
+
+    # The user's e-mail address. Must be unique. Cannot have two users with the same e-mail address.
+    attr_accessor :email
+
+    # The user's preferred language of communication. If not provided, defaults to English (en)
+    attr_accessor :language
+
+    # (Optional) Mobile number of user. Allows for SMS notifications upon availability of funds
+    attr_accessor :mobile_number
+
+    # Company legal name (Only if Business account)
+    attr_accessor :business_name
+
+    # User's computed timezone
+    attr_accessor :timezone
+
+    # Date of birth. (optional). Minimum 18 years old
+    attr_accessor :date_of_birth
+
+    # Optional JSON object with attributes that can later be searched to locate this user. Do not include PII as this object is not encrypted.
+    attr_accessor :metadata
+
+    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
+      {
+        :'user_token' => :'user_token',
+        :'status' => :'status',
+        :'created_on' => :'created_on',
+        :'internal_user_id' => :'internal_user_id',
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'city' => :'city',
+        :'state_province' => :'state_province',
+        :'postal_code' => :'postal_code',
+        :'country' => :'country',
+        :'first_name' => :'first_name',
+        :'middle_name' => :'middle_name',
+        :'last_name' => :'last_name',
+        :'email' => :'email',
+        :'language' => :'language',
+        :'mobile_number' => :'mobile_number',
+        :'business_name' => :'business_name',
+        :'timezone' => :'timezone',
+        :'date_of_birth' => :'date_of_birth',
+        :'metadata' => :'metadata'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'user_token' => :'String',
+        :'status' => :'String',
+        :'created_on' => :'String',
+        :'internal_user_id' => :'String',
+        :'address1' => :'String',
+        :'address2' => :'String',
+        :'city' => :'String',
+        :'state_province' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String',
+        :'first_name' => :'String',
+        :'middle_name' => :'String',
+        :'last_name' => :'String',
+        :'email' => :'String',
+        :'language' => :'String',
+        :'mobile_number' => :'String',
+        :'business_name' => :'String',
+        :'timezone' => :'String',
+        :'date_of_birth' => :'Date',
+        :'metadata' => :'Object'
+      }
+    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 `MassPayRubySdk::StoredUser` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MassPayRubySdk::StoredUser`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'user_token')
+        self.user_token = attributes[:'user_token']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'created_on')
+        self.created_on = attributes[:'created_on']
+      end
+
+      if attributes.key?(:'internal_user_id')
+        self.internal_user_id = attributes[:'internal_user_id']
+      end
+
+      if attributes.key?(:'address1')
+        self.address1 = attributes[:'address1']
+      end
+
+      if attributes.key?(:'address2')
+        self.address2 = attributes[:'address2']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'state_province')
+        self.state_province = attributes[:'state_province']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'mobile_number')
+        self.mobile_number = attributes[:'mobile_number']
+      end
+
+      if attributes.key?(:'business_name')
+        self.business_name = attributes[:'business_name']
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      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
+      invalid_properties = Array.new
+      if @user_token.nil?
+        invalid_properties.push('invalid value for "user_token", user_token cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @created_on.nil?
+        invalid_properties.push('invalid value for "created_on", created_on cannot be nil.')
+      end
+
+      if @internal_user_id.nil?
+        invalid_properties.push('invalid value for "internal_user_id", internal_user_id cannot be nil.')
+      end
+
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if !@mobile_number.nil? && @mobile_number !~ pattern
+        invalid_properties.push("invalid value for \"mobile_number\", must conform to the pattern #{pattern}.")
+      end
+
+      if @timezone.nil?
+        invalid_properties.push('invalid value for "timezone", timezone 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?
+      return false if @user_token.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED", "DEACTIVE"])
+      return false unless status_validator.valid?(@status)
+      return false if @created_on.nil?
+      return false if @internal_user_id.nil?
+      return false if @first_name.nil?
+      return false if @last_name.nil?
+      return false if @email.nil?
+      return false if !@mobile_number.nil? && @mobile_number !~ Regexp.new(/^[0-9]+$/)
+      return false if @timezone.nil?
+      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", "LOCKED", "DEACTIVE"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mobile_number Value to be assigned
+    def mobile_number=(mobile_number)
+      pattern = Regexp.new(/^[0-9]+$/)
+      if !mobile_number.nil? && mobile_number !~ pattern
+        fail ArgumentError, "invalid value for \"mobile_number\", must conform to the pattern #{pattern}."
+      end
+
+      @mobile_number = mobile_number
+    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 &&
+          user_token == o.user_token &&
+          status == o.status &&
+          created_on == o.created_on &&
+          internal_user_id == o.internal_user_id &&
+          address1 == o.address1 &&
+          address2 == o.address2 &&
+          city == o.city &&
+          state_province == o.state_province &&
+          postal_code == o.postal_code &&
+          country == o.country &&
+          first_name == o.first_name &&
+          middle_name == o.middle_name &&
+          last_name == o.last_name &&
+          email == o.email &&
+          language == o.language &&
+          mobile_number == o.mobile_number &&
+          business_name == o.business_name &&
+          timezone == o.timezone &&
+          date_of_birth == o.date_of_birth &&
+          metadata == o.metadata
+    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
+      [user_token, status, created_on, internal_user_id, address1, address2, city, state_province, postal_code, country, first_name, middle_name, last_name, email, language, mobile_number, business_name, timezone, date_of_birth, metadata].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)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[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
+      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 :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 = MassPayRubySdk.const_get(type)
+        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