yapstone-so 1.0.0

data/lib/yapstone-so/models/consent.rb

@@ -0,0 +1,329 @@
+=begin
+#Yapstone Staged On-Boarding Services
+
+#Set of API's that allow clients to onboard with Yapstone.
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Yapstone
+  class Consent
+    # Type of the consent
+    attr_accessor :type
+
+    # Indicates the acceptance of the T&Cs.
+    attr_accessor :accepted
+
+    # Time of the consent
+    attr_accessor :time_of_consent
+
+    # Version of the consent
+    attr_accessor :version
+
+    # IP Address of machine from which consent was given
+    attr_accessor :ip_address
+
+    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
+      {
+        :'type' => :'type',
+        :'accepted' => :'accepted',
+        :'time_of_consent' => :'timeOfConsent',
+        :'version' => :'version',
+        :'ip_address' => :'ipAddress'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'accepted' => :'Boolean',
+        :'time_of_consent' => :'DateTime',
+        :'version' => :'Integer',
+        :'ip_address' => :'String'
+      }
+    end
+
+    # discriminator's property name in OpenAPI v3
+    def self.openapi_discriminator_name
+      :'type'
+    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 `Yapstone::Consent` 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 `Yapstone::Consent`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'accepted')
+        self.accepted = attributes[:'accepted']
+      end
+
+      if attributes.key?(:'time_of_consent')
+        self.time_of_consent = attributes[:'time_of_consent']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
+
+      if attributes.key?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @accepted.nil?
+        invalid_properties.push('invalid value for "accepted", accepted cannot be nil.')
+      end
+
+      if @time_of_consent.nil?
+        invalid_properties.push('invalid value for "time_of_consent", time_of_consent cannot be nil.')
+      end
+
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version cannot be nil.')
+      end
+
+      if @ip_address.nil?
+        invalid_properties.push('invalid value for "ip_address", ip_address cannot be nil.')
+      end
+
+      if @ip_address.to_s.length > 15
+        invalid_properties.push('invalid value for "ip_address", the character length must be smaller than or equal to 15.')
+      end
+
+      if @ip_address.to_s.length < 1
+        invalid_properties.push('invalid value for "ip_address", the character length must be great 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?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["DIRECT_DEBIT"])
+      return false unless type_validator.valid?(@type)
+      return false if @accepted.nil?
+      return false if @time_of_consent.nil?
+      return false if @version.nil?
+      return false if @ip_address.nil?
+      return false if @ip_address.to_s.length > 15
+      return false if @ip_address.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["DIRECT_DEBIT"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ip_address Value to be assigned
+    def ip_address=(ip_address)
+      if ip_address.nil?
+        fail ArgumentError, 'ip_address cannot be nil'
+      end
+
+      if ip_address.to_s.length > 15
+        fail ArgumentError, 'invalid value for "ip_address", the character length must be smaller than or equal to 15.'
+      end
+
+      if ip_address.to_s.length < 1
+        fail ArgumentError, 'invalid value for "ip_address", the character length must be great than or equal to 1.'
+      end
+
+      @ip_address = ip_address
+    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 &&
+          type == o.type &&
+          accepted == o.accepted &&
+          time_of_consent == o.time_of_consent &&
+          version == o.version &&
+          ip_address == o.ip_address
+    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
+      [type, accepted, time_of_consent, version, ip_address].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        Yapstone.const_get(type).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)
+        next if value.nil?
+        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

data/lib/yapstone-so/models/consent_request.rb

@@ -0,0 +1,318 @@
+=begin
+#Yapstone Staged On-Boarding Services
+
+#Set of API's that allow clients to onboard with Yapstone.
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Yapstone
+  # Represents the consent necessary for onboard an entity.
+  class ConsentRequest
+    # The version of the consent if there is one.
+    attr_accessor :version
+
+    # Indicates the acceptance of the T&Cs.
+    attr_accessor :accepted
+
+    # The ipAddress origin of the incoming call.
+    attr_accessor :ip_address
+
+    # The device fingerprint identifier.
+    attr_accessor :device_fingerprint_id
+
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'version' => :'version',
+        :'accepted' => :'accepted',
+        :'ip_address' => :'ipAddress',
+        :'device_fingerprint_id' => :'deviceFingerprintId',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'version' => :'Integer',
+        :'accepted' => :'Boolean',
+        :'ip_address' => :'String',
+        :'device_fingerprint_id' => :'String',
+        :'type' => :'ConsentType'
+      }
+    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 `Yapstone::ConsentRequest` 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 `Yapstone::ConsentRequest`. 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?(:'version')
+        self.version = attributes[:'version']
+      end
+
+      if attributes.key?(:'accepted')
+        self.accepted = attributes[:'accepted']
+      end
+
+      if attributes.key?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.key?(:'device_fingerprint_id')
+        self.device_fingerprint_id = attributes[:'device_fingerprint_id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @version.nil?
+        invalid_properties.push('invalid value for "version", version cannot be nil.')
+      end
+
+      if @accepted.nil?
+        invalid_properties.push('invalid value for "accepted", accepted cannot be nil.')
+      end
+
+      if @ip_address.nil?
+        invalid_properties.push('invalid value for "ip_address", ip_address cannot be nil.')
+      end
+
+      if @ip_address.to_s.length > 64
+        invalid_properties.push('invalid value for "ip_address", the character length must be smaller than or equal to 64.')
+      end
+
+      if @ip_address.to_s.length < 1
+        invalid_properties.push('invalid value for "ip_address", the character length must be great than or equal to 1.')
+      end
+
+      if @device_fingerprint_id.nil?
+        invalid_properties.push('invalid value for "device_fingerprint_id", device_fingerprint_id cannot be nil.')
+      end
+
+      if @device_fingerprint_id.to_s.length > 32
+        invalid_properties.push('invalid value for "device_fingerprint_id", the character length must be smaller than or equal to 32.')
+      end
+
+      if @device_fingerprint_id.to_s.length < 1
+        invalid_properties.push('invalid value for "device_fingerprint_id", the character length must be great than or equal to 1.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type 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 @version.nil?
+      return false if @accepted.nil?
+      return false if @ip_address.nil?
+      return false if @ip_address.to_s.length > 64
+      return false if @ip_address.to_s.length < 1
+      return false if @device_fingerprint_id.nil?
+      return false if @device_fingerprint_id.to_s.length > 32
+      return false if @device_fingerprint_id.to_s.length < 1
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ip_address Value to be assigned
+    def ip_address=(ip_address)
+      if ip_address.nil?
+        fail ArgumentError, 'ip_address cannot be nil'
+      end
+
+      if ip_address.to_s.length > 64
+        fail ArgumentError, 'invalid value for "ip_address", the character length must be smaller than or equal to 64.'
+      end
+
+      if ip_address.to_s.length < 1
+        fail ArgumentError, 'invalid value for "ip_address", the character length must be great than or equal to 1.'
+      end
+
+      @ip_address = ip_address
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] device_fingerprint_id Value to be assigned
+    def device_fingerprint_id=(device_fingerprint_id)
+      if device_fingerprint_id.nil?
+        fail ArgumentError, 'device_fingerprint_id cannot be nil'
+      end
+
+      if device_fingerprint_id.to_s.length > 32
+        fail ArgumentError, 'invalid value for "device_fingerprint_id", the character length must be smaller than or equal to 32.'
+      end
+
+      if device_fingerprint_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "device_fingerprint_id", the character length must be great than or equal to 1.'
+      end
+
+      @device_fingerprint_id = device_fingerprint_id
+    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 &&
+          version == o.version &&
+          accepted == o.accepted &&
+          ip_address == o.ip_address &&
+          device_fingerprint_id == o.device_fingerprint_id &&
+          type == o.type
+    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
+      [version, accepted, ip_address, device_fingerprint_id, type].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        Yapstone.const_get(type).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)
+        next if value.nil?
+        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