class Plaid::PaymentInitiationRecipientCreateRequest
PaymentInitiationRecipientCreateRequest
defines the request schema for ‘/payment_initiation/recipient/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 International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required.
The name of the recipient. We recommend using strings of length 18 or less and avoid special characters to ensure compatibility with all institutions.
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/payment_initiation_recipient_create_request.rb, line 48 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 36 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'name' => :'name', :'iban' => :'iban', :'bacs' => :'bacs', :'address' => :'address' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 206 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/payment_initiation_recipient_create_request.rb, line 75 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PaymentInitiationRecipientCreateRequest` 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::PaymentInitiationRecipientCreateRequest`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'iban') self.iban = attributes[:'iban'] end if attributes.key?(:'bacs') self.bacs = attributes[:'bacs'] end if attributes.key?(:'address') self.address = attributes[:'address'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 65 def self.openapi_nullable Set.new([ :'iban', :'bacs', :'address' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 53 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'name' => :'String', :'iban' => :'String', :'bacs' => :'RecipientBACSNullable', :'address' => :'PaymentInitiationAddress' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 180 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && secret == o.secret && name == o.name && iban == o.iban && bacs == o.bacs && address == o.address end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 237 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/payment_initiation_recipient_create_request.rb, line 308 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/payment_initiation_recipient_create_request.rb, line 213 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/payment_initiation_recipient_create_request.rb, line 193 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 199 def hash [client_id, secret, name, iban, bacs, address].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 165 def iban=(iban) if !iban.nil? && iban.to_s.length > 34 fail ArgumentError, 'invalid value for "iban", the character length must be smaller than or equal to 34.' end if !iban.nil? && iban.to_s.length < 15 fail ArgumentError, 'invalid value for "iban", the character length must be great than or equal to 15.' end @iban = iban end
Custom attribute writer method with validation @param [Object] iban Value to be assigned
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 115 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @name.to_s.length < 1 invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end if !@iban.nil? && @iban.to_s.length > 34 invalid_properties.push('invalid value for "iban", the character length must be smaller than or equal to 34.') end if !@iban.nil? && @iban.to_s.length < 15 invalid_properties.push('invalid value for "iban", the character length must be great than or equal to 15.') 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/payment_initiation_recipient_create_request.rb, line 150 def name=(name) if name.nil? fail ArgumentError, 'name cannot be nil' end if name.to_s.length < 1 fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.' end @name = name end
Custom attribute writer method with validation @param [Object] name Value to be assigned
Source
Source
# File lib/plaid/models/payment_initiation_recipient_create_request.rb, line 290 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/payment_initiation_recipient_create_request.rb, line 278 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/payment_initiation_recipient_create_request.rb, line 140 def valid? return false if @name.nil? return false if @name.to_s.length < 1 return false if !@iban.nil? && @iban.to_s.length > 34 return false if !@iban.nil? && @iban.to_s.length < 15 true end
Check to see if the all the properties in the model are valid @return true if the model is valid