class Plaid::TransferCreditUsageConfiguration
Specifies the originator’s expected usage of credits. For all dollar amounts, use a decimal string with two digits of precision e.g. "10.00". This field is required if the originator is expected to process credit transfers.
Attributes
The originator’s expected average amount per credit.
The originator’s expected highest amount for a single credit transfer.
The originator’s monthly expected ACH credit processing amount for the next 6-12 months.
Specifies the expected use cases for the originator’s credit transfers. This should be a list that contains one or more of the following codes: ‘"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts `"ppd"` - Prearranged Payment or Deposit. The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained from the consumer in person via writing, or through online authorization, or via an electronic document signing, e.g. Docusign. For example language for online authorization, see the 2025 NACHA Operating Rules — Section 2.3.2, Authorization of Entries via Electronic Means. Can be used for credits or debits. `"web"` - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits.
Public Class Methods
Source
# File lib/plaid/models/transfer_credit_usage_configuration.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_credit_usage_configuration.rb, line 56 def self.attribute_map { :'expected_frequency' => :'expected_frequency', :'expected_highest_amount' => :'expected_highest_amount', :'expected_average_amount' => :'expected_average_amount', :'expected_monthly_amount' => :'expected_monthly_amount', :'sec_codes' => :'sec_codes' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 191 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_credit_usage_configuration.rb, line 90 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferCreditUsageConfiguration` 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::TransferCreditUsageConfiguration`. 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?(:'expected_frequency') self.expected_frequency = attributes[:'expected_frequency'] end if attributes.key?(:'expected_highest_amount') self.expected_highest_amount = attributes[:'expected_highest_amount'] end if attributes.key?(:'expected_average_amount') self.expected_average_amount = attributes[:'expected_average_amount'] end if attributes.key?(:'expected_monthly_amount') self.expected_monthly_amount = attributes[:'expected_monthly_amount'] end if attributes.key?(:'sec_codes') if (value = attributes[:'sec_codes']).is_a?(Array) self.sec_codes = value end end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 83 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 72 def self.openapi_types { :'expected_frequency' => :'OriginatorExpectedTransferFrequency', :'expected_highest_amount' => :'String', :'expected_average_amount' => :'String', :'expected_monthly_amount' => :'String', :'sec_codes' => :'Array<CreditACHClass>' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 166 def ==(o) return true if self.equal?(o) self.class == o.class && expected_frequency == o.expected_frequency && expected_highest_amount == o.expected_highest_amount && expected_average_amount == o.expected_average_amount && expected_monthly_amount == o.expected_monthly_amount && sec_codes == o.sec_codes end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 222 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_credit_usage_configuration.rb, line 293 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_credit_usage_configuration.rb, line 198 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_credit_usage_configuration.rb, line 178 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 184 def hash [expected_frequency, expected_highest_amount, expected_average_amount, expected_monthly_amount, sec_codes].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 128 def list_invalid_properties invalid_properties = Array.new if @expected_frequency.nil? invalid_properties.push('invalid value for "expected_frequency", expected_frequency cannot be nil.') end if @expected_highest_amount.nil? invalid_properties.push('invalid value for "expected_highest_amount", expected_highest_amount cannot be nil.') end if @expected_average_amount.nil? invalid_properties.push('invalid value for "expected_average_amount", expected_average_amount cannot be nil.') end if @expected_monthly_amount.nil? invalid_properties.push('invalid value for "expected_monthly_amount", expected_monthly_amount cannot be nil.') end if @sec_codes.nil? invalid_properties.push('invalid value for "sec_codes", sec_codes cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/transfer_credit_usage_configuration.rb, line 275 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_credit_usage_configuration.rb, line 263 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_credit_usage_configuration.rb, line 155 def valid? return false if @expected_frequency.nil? return false if @expected_highest_amount.nil? return false if @expected_average_amount.nil? return false if @expected_monthly_amount.nil? return false if @sec_codes.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid