class Plaid::PaymentInitiationConsentPaymentExecuteRequest
PaymentInitiationConsentPaymentExecuteRequest
defines the request schema for ‘/payment_initiation/consent/payment/execute`
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 consent ID.
A random key provided by the client, per unique consent payment. Maximum of 128 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a consent payment fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single payment is created. If the request was successfully processed, it will prevent any payment that uses the same idempotency key, and was received within 48 hours of the first request, from being processed.
A reference for the payment. This must be an alphanumeric string with at most 18 characters and must not contain any special characters (since not all institutions support them). If not provided, Plaid
will automatically fall back to the reference from consent. In order to track settlement via Payment Confirmation, each payment must have a unique reference. If the reference provided through the API is not unique, Plaid
will adjust it. Some institutions may limit the reference to less than 18 characters. If necessary, Plaid
will adjust the reference by truncating it to fit the institution’s requirements. Both the originally provided and automatically adjusted references (if any) can be found in the ‘reference` and `adjusted_reference` fields, respectively.
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_consent_payment_execute_request.rb, line 77 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 63 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'consent_id' => :'consent_id', :'amount' => :'amount', :'idempotency_key' => :'idempotency_key', :'reference' => :'reference', :'scope' => :'scope', :'processing_mode' => :'processing_mode' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 264 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_consent_payment_execute_request.rb, line 104 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PaymentInitiationConsentPaymentExecuteRequest` 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::PaymentInitiationConsentPaymentExecuteRequest`. 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?(:'consent_id') self.consent_id = attributes[:'consent_id'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'idempotency_key') self.idempotency_key = attributes[:'idempotency_key'] end if attributes.key?(:'reference') self.reference = attributes[:'reference'] end if attributes.key?(:'scope') self.scope = attributes[:'scope'] end if attributes.key?(:'processing_mode') self.processing_mode = attributes[:'processing_mode'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 96 def self.openapi_nullable Set.new([ :'reference', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 82 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'consent_id' => :'String', :'amount' => :'PaymentAmount', :'idempotency_key' => :'String', :'reference' => :'String', :'scope' => :'PaymentInitiationConsentScope', :'processing_mode' => :'PaymentInitiationConsentProcessingMode' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 236 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && secret == o.secret && consent_id == o.consent_id && amount == o.amount && idempotency_key == o.idempotency_key && reference == o.reference && scope == o.scope && processing_mode == o.processing_mode end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 295 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_consent_payment_execute_request.rb, line 366 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_consent_payment_execute_request.rb, line 271 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_consent_payment_execute_request.rb, line 251 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 257 def hash [client_id, secret, consent_id, amount, idempotency_key, reference, scope, processing_mode].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 202 def idempotency_key=(idempotency_key) if idempotency_key.nil? fail ArgumentError, 'idempotency_key cannot be nil' end if idempotency_key.to_s.length > 128 fail ArgumentError, 'invalid value for "idempotency_key", the character length must be smaller than or equal to 128.' end if idempotency_key.to_s.length < 1 fail ArgumentError, 'invalid value for "idempotency_key", the character length must be great than or equal to 1.' end @idempotency_key = idempotency_key end
Custom attribute writer method with validation @param [Object] idempotency_key
Value to be assigned
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 152 def list_invalid_properties invalid_properties = Array.new if @consent_id.nil? invalid_properties.push('invalid value for "consent_id", consent_id cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @idempotency_key.nil? invalid_properties.push('invalid value for "idempotency_key", idempotency_key cannot be nil.') end if @idempotency_key.to_s.length > 128 invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 128.') end if @idempotency_key.to_s.length < 1 invalid_properties.push('invalid value for "idempotency_key", the character length must be great than or equal to 1.') end if !@reference.nil? && @reference.to_s.length > 18 invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 18.') end if !@reference.nil? && @reference.to_s.length < 1 invalid_properties.push('invalid value for "reference", the character length must be great than or equal to 1.') 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_consent_payment_execute_request.rb, line 221 def reference=(reference) if !reference.nil? && reference.to_s.length > 18 fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 18.' end if !reference.nil? && reference.to_s.length < 1 fail ArgumentError, 'invalid value for "reference", the character length must be great than or equal to 1.' end @reference = reference end
Custom attribute writer method with validation @param [Object] reference Value to be assigned
Source
Source
# File lib/plaid/models/payment_initiation_consent_payment_execute_request.rb, line 348 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_consent_payment_execute_request.rb, line 336 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_consent_payment_execute_request.rb, line 189 def valid? return false if @consent_id.nil? return false if @amount.nil? return false if @idempotency_key.nil? return false if @idempotency_key.to_s.length > 128 return false if @idempotency_key.to_s.length < 1 return false if !@reference.nil? && @reference.to_s.length > 18 return false if !@reference.nil? && @reference.to_s.length < 1 true end
Check to see if the all the properties in the model are valid @return true if the model is valid