class VeloPayments::CreatePayoutRequest
Attributes
Deprecated in v2.16. Any value supplied here will be ignored.
The id of the payor whose source account(s) will be debited. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted.
Text applied to all payment memos unless specified explicitly on a payment. This should be the reference field on the statement seen by the payee (but not via ACH)
The id of the payor whose payees will be paid. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/velopayments/models/create_payout_request.rb, line 32 def self.attribute_map { :'payor_id' => :'payorId', :'payout_from_payor_id' => :'payoutFromPayorId', :'payout_to_payor_id' => :'payoutToPayorId', :'payout_memo' => :'payoutMemo', :'payments' => :'payments' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/velopayments/models/create_payout_request.rb, line 157 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/velopayments/models/create_payout_request.rb, line 61 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::CreatePayoutRequest` 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 `VeloPayments::CreatePayoutRequest`. 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?(:'payor_id') self.payor_id = attributes[:'payor_id'] end if attributes.key?(:'payout_from_payor_id') self.payout_from_payor_id = attributes[:'payout_from_payor_id'] end if attributes.key?(:'payout_to_payor_id') self.payout_to_payor_id = attributes[:'payout_to_payor_id'] end if attributes.key?(:'payout_memo') self.payout_memo = attributes[:'payout_memo'] end if attributes.key?(:'payments') if (value = attributes[:'payments']).is_a?(Array) self.payments = value end end end
List of attributes with nullable: true
# File lib/velopayments/models/create_payout_request.rb, line 54 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/velopayments/models/create_payout_request.rb, line 43 def self.openapi_types { :'payor_id' => :'String', :'payout_from_payor_id' => :'String', :'payout_to_payor_id' => :'String', :'payout_memo' => :'String', :'payments' => :'Array<PaymentInstruction>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/velopayments/models/create_payout_request.rb, line 132 def ==(o) return true if self.equal?(o) self.class == o.class && payor_id == o.payor_id && payout_from_payor_id == o.payout_from_payor_id && payout_to_payor_id == o.payout_to_payor_id && payout_memo == o.payout_memo && payments == o.payments end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/velopayments/models/create_payout_request.rb, line 185 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 VeloPayments.const_get(type).build_from_hash(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
# File lib/velopayments/models/create_payout_request.rb, line 254 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/velopayments/models/create_payout_request.rb, line 164 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
@see the `==` method @param [Object] Object to be compared
# File lib/velopayments/models/create_payout_request.rb, line 144 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/velopayments/models/create_payout_request.rb, line 150 def hash [payor_id, payout_from_payor_id, payout_to_payor_id, payout_memo, payments].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/velopayments/models/create_payout_request.rb, line 99 def list_invalid_properties invalid_properties = Array.new if !@payout_memo.nil? && @payout_memo.to_s.length > 40 invalid_properties.push('invalid value for "payout_memo", the character length must be smaller than or equal to 40.') end if @payments.nil? invalid_properties.push('invalid value for "payments", payments cannot be nil.') end invalid_properties end
Custom attribute writer method with validation @param [Object] payout_memo
Value to be assigned
# File lib/velopayments/models/create_payout_request.rb, line 122 def payout_memo=(payout_memo) if !payout_memo.nil? && payout_memo.to_s.length > 40 fail ArgumentError, 'invalid value for "payout_memo", the character length must be smaller than or equal to 40.' end @payout_memo = payout_memo end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/velopayments/models/create_payout_request.rb, line 236 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 string representation of the object @return [String] String presentation of the object
# File lib/velopayments/models/create_payout_request.rb, line 224 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/velopayments/models/create_payout_request.rb, line 114 def valid? return false if !@payout_memo.nil? && @payout_memo.to_s.length > 40 return false if @payments.nil? true end