yapstone-so 1.0.0

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

@@ -0,0 +1,336 @@
+=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
+  # The goverment identification information.
+  class GovIdentificationResource
+    attr_accessor :type
+
+    # The display info for the identification.
+    attr_accessor :display_text
+
+    # The key to vault that contains the data associated with the government id. This key will be generated when the identification is created at YapStone.
+    attr_accessor :gov_id_data_token
+
+    # The number associated with the identification.
+    attr_accessor :number
+
+    # The expiration date of the identication.
+    attr_accessor :expiration
+
+    # The 3-letter ISO country code of the identification issuer.
+    attr_accessor :country
+
+    # The state or province of the identification issuer.
+    attr_accessor :state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'display_text' => :'displayText',
+        :'gov_id_data_token' => :'govIdDataToken',
+        :'number' => :'number',
+        :'expiration' => :'expiration',
+        :'country' => :'country',
+        :'state' => :'state'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'GovernmentIdType',
+        :'display_text' => :'String',
+        :'gov_id_data_token' => :'String',
+        :'number' => :'String',
+        :'expiration' => :'Date',
+        :'country' => :'String',
+        :'state' => :'String'
+      }
+    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::GovIdentificationResource` 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::GovIdentificationResource`. 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?(:'display_text')
+        self.display_text = attributes[:'display_text']
+      end
+
+      if attributes.key?(:'gov_id_data_token')
+        self.gov_id_data_token = attributes[:'gov_id_data_token']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'expiration')
+        self.expiration = attributes[:'expiration']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      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 @number.nil?
+        invalid_properties.push('invalid value for "number", number cannot be nil.')
+      end
+
+      pattern = Regexp.new(/.*[^\s].*/)
+      if @number !~ pattern
+        invalid_properties.push("invalid value for \"number\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@country.nil? && @country.to_s.length > 3
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@country.nil? && @country.to_s.length < 3
+        invalid_properties.push('invalid value for "country", the character length must be great than or equal to 3.')
+      end
+
+      if !@state.nil? && @state.to_s.length > 255
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@state.nil? && @state.to_s.length < 2
+        invalid_properties.push('invalid value for "state", the character length must be great than or equal to 2.')
+      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?
+      return false if @number.nil?
+      return false if @number !~ Regexp.new(/.*[^\s].*/)
+      return false if !@country.nil? && @country.to_s.length > 3
+      return false if !@country.nil? && @country.to_s.length < 3
+      return false if !@state.nil? && @state.to_s.length > 255
+      return false if !@state.nil? && @state.to_s.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number Value to be assigned
+    def number=(number)
+      if number.nil?
+        fail ArgumentError, 'number cannot be nil'
+      end
+
+      pattern = Regexp.new(/.*[^\s].*/)
+      if number !~ pattern
+        fail ArgumentError, "invalid value for \"number\", must conform to the pattern #{pattern}."
+      end
+
+      @number = number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if !country.nil? && country.to_s.length > 3
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 3.'
+      end
+
+      if !country.nil? && country.to_s.length < 3
+        fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 3.'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if !state.nil? && state.to_s.length > 255
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 255.'
+      end
+
+      if !state.nil? && state.to_s.length < 2
+        fail ArgumentError, 'invalid value for "state", the character length must be great than or equal to 2.'
+      end
+
+      @state = state
+    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 &&
+          display_text == o.display_text &&
+          gov_id_data_token == o.gov_id_data_token &&
+          number == o.number &&
+          expiration == o.expiration &&
+          country == o.country &&
+          state == o.state
+    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, display_text, gov_id_data_token, number, expiration, country, state].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/gov_identification_update_resource.rb

@@ -0,0 +1,322 @@
+=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
+  # The goverment identification information.
+  class GovIdentificationUpdateResource
+    attr_accessor :type
+
+    # The display info for the identification.
+    attr_accessor :display_text
+
+    # The key to vault that contains the data associated with the government id. This key will be generated when the identification is created at YapStone.
+    attr_accessor :gov_id_data_token
+
+    # The number associated with the identification.
+    attr_accessor :number
+
+    # The expiration date of the identication.
+    attr_accessor :expiration
+
+    # The 3-letter ISO country code of the identification issuer.
+    attr_accessor :country
+
+    # The state or province of the identification issuer.
+    attr_accessor :state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'display_text' => :'displayText',
+        :'gov_id_data_token' => :'govIdDataToken',
+        :'number' => :'number',
+        :'expiration' => :'expiration',
+        :'country' => :'country',
+        :'state' => :'state'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'GovernmentIdType',
+        :'display_text' => :'String',
+        :'gov_id_data_token' => :'String',
+        :'number' => :'String',
+        :'expiration' => :'Date',
+        :'country' => :'String',
+        :'state' => :'String'
+      }
+    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::GovIdentificationUpdateResource` 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::GovIdentificationUpdateResource`. 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?(:'display_text')
+        self.display_text = attributes[:'display_text']
+      end
+
+      if attributes.key?(:'gov_id_data_token')
+        self.gov_id_data_token = attributes[:'gov_id_data_token']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'expiration')
+        self.expiration = attributes[:'expiration']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      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
+      pattern = Regexp.new(/.*[^\s].*/)
+      if !@number.nil? && @number !~ pattern
+        invalid_properties.push("invalid value for \"number\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@country.nil? && @country.to_s.length > 3
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@country.nil? && @country.to_s.length < 3
+        invalid_properties.push('invalid value for "country", the character length must be great than or equal to 3.')
+      end
+
+      if !@state.nil? && @state.to_s.length > 255
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@state.nil? && @state.to_s.length < 2
+        invalid_properties.push('invalid value for "state", the character length must be great than or equal to 2.')
+      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 !@number.nil? && @number !~ Regexp.new(/.*[^\s].*/)
+      return false if !@country.nil? && @country.to_s.length > 3
+      return false if !@country.nil? && @country.to_s.length < 3
+      return false if !@state.nil? && @state.to_s.length > 255
+      return false if !@state.nil? && @state.to_s.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number Value to be assigned
+    def number=(number)
+      pattern = Regexp.new(/.*[^\s].*/)
+      if !number.nil? && number !~ pattern
+        fail ArgumentError, "invalid value for \"number\", must conform to the pattern #{pattern}."
+      end
+
+      @number = number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if !country.nil? && country.to_s.length > 3
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 3.'
+      end
+
+      if !country.nil? && country.to_s.length < 3
+        fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 3.'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if !state.nil? && state.to_s.length > 255
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 255.'
+      end
+
+      if !state.nil? && state.to_s.length < 2
+        fail ArgumentError, 'invalid value for "state", the character length must be great than or equal to 2.'
+      end
+
+      @state = state
+    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 &&
+          display_text == o.display_text &&
+          gov_id_data_token == o.gov_id_data_token &&
+          number == o.number &&
+          expiration == o.expiration &&
+          country == o.country &&
+          state == o.state
+    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, display_text, gov_id_data_token, number, expiration, country, state].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/government_id_type.rb

@@ -0,0 +1,43 @@
+=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 GovernmentIdType
+    DRIVERS_LICENSE = "DRIVERS_LICENSE".freeze
+    PASSPORT = "PASSPORT".freeze
+    GOVERNMENT_ID = "GOVERNMENT_ID".freeze
+    PASSPORT_CARD = "PASSPORT_CARD".freeze
+    LAST_FOUR_SSN = "LAST_FOUR_SSN".freeze
+    TAX_ID = "TAX_ID".freeze
+    SIN = "SIN".freeze
+    NIF = "NIF".freeze
+    CODICE_FISCALE = "CODICE_FISCALE".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = GovernmentIdType.constants.select { |c| GovernmentIdType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #GovernmentIdType" if constantValues.empty?
+      value
+    end
+  end
+end