class Plaid::TransferPlatformPersonCreateRequest
Defines the request schema for ‘/transfer/platform/person/create`
Attributes
Your Plaid
API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
The date of birth of the person. Formatted as YYYY-MM-DD.
A valid email address. Must not have leading or trailing spaces.
The client ID of the originator
The percentage of ownership this person has in the onboarding business. Only applicable to beneficial owners with 25% or more ownership.
A valid phone number in E.164 format.
The relationship between this person and the originator they are related to.
Your Plaid
API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
Public Class Methods
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 67 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 50 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'originator_client_id' => :'originator_client_id', :'name' => :'name', :'email_address' => :'email_address', :'phone_number' => :'phone_number', :'address' => :'address', :'id_number' => :'id_number', :'date_of_birth' => :'date_of_birth', :'relationship_to_originator' => :'relationship_to_originator', :'ownership_percentage' => :'ownership_percentage' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 231 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
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 96 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferPlatformPersonCreateRequest` 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 `Plaid::TransferPlatformPersonCreateRequest`. 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?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end if attributes.key?(:'originator_client_id') self.originator_client_id = attributes[:'originator_client_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'email_address') self.email_address = attributes[:'email_address'] end if attributes.key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end if attributes.key?(:'address') self.address = attributes[:'address'] end if attributes.key?(:'id_number') self.id_number = attributes[:'id_number'] end if attributes.key?(:'date_of_birth') self.date_of_birth = attributes[:'date_of_birth'] end if attributes.key?(:'relationship_to_originator') self.relationship_to_originator = attributes[:'relationship_to_originator'] end if attributes.key?(:'ownership_percentage') self.ownership_percentage = attributes[:'ownership_percentage'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 89 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 72 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'originator_client_id' => :'String', :'name' => :'TransferPlatformPersonName', :'email_address' => :'String', :'phone_number' => :'String', :'address' => :'TransferPlatformPersonAddress', :'id_number' => :'TransferPlatformPersonIDNumber', :'date_of_birth' => :'Date', :'relationship_to_originator' => :'String', :'ownership_percentage' => :'Integer' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 200 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && secret == o.secret && originator_client_id == o.originator_client_id && name == o.name && email_address == o.email_address && phone_number == o.phone_number && address == o.address && id_number == o.id_number && date_of_birth == o.date_of_birth && relationship_to_originator == o.relationship_to_originator && ownership_percentage == o.ownership_percentage end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 262 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 = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 333 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
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
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 238 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 218 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 224 def hash [client_id, secret, originator_client_id, name, email_address, phone_number, address, id_number, date_of_birth, relationship_to_originator, ownership_percentage].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 156 def list_invalid_properties invalid_properties = Array.new if @originator_client_id.nil? invalid_properties.push('invalid value for "originator_client_id", originator_client_id cannot be nil.') end if !@ownership_percentage.nil? && @ownership_percentage > 100 invalid_properties.push('invalid value for "ownership_percentage", must be smaller than or equal to 100.') end if !@ownership_percentage.nil? && @ownership_percentage < 25 invalid_properties.push('invalid value for "ownership_percentage", must be greater than or equal to 25.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 185 def ownership_percentage=(ownership_percentage) if !ownership_percentage.nil? && ownership_percentage > 100 fail ArgumentError, 'invalid value for "ownership_percentage", must be smaller than or equal to 100.' end if !ownership_percentage.nil? && ownership_percentage < 25 fail ArgumentError, 'invalid value for "ownership_percentage", must be greater than or equal to 25.' end @ownership_percentage = ownership_percentage end
Custom attribute writer method with validation @param [Object] ownership_percentage
Value to be assigned
Source
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 315 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 303 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/transfer_platform_person_create_request.rb, line 176 def valid? return false if @originator_client_id.nil? return false if !@ownership_percentage.nil? && @ownership_percentage > 100 return false if !@ownership_percentage.nil? && @ownership_percentage < 25 true end
Check to see if the all the properties in the model are valid @return true if the model is valid