class VeloPayments::PaymentInstruction
Attributes
<p>Amount to send to Payee
</p> <p>The maximum payment amount is dependent on the currency</p>
Valid ISO 4217 3 letter currency code. See the <a href="www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
Your identifier for payee
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/velopayments/models/payment_instruction.rb, line 33 def self.attribute_map { :'remote_id' => :'remoteId', :'currency' => :'currency', :'amount' => :'amount', :'payment_memo' => :'paymentMemo', :'source_account_name' => :'sourceAccountName', :'payor_payment_id' => :'payorPaymentId' } 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/payment_instruction.rb, line 325 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/payment_instruction.rb, line 64 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PaymentInstruction` 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::PaymentInstruction`. 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?(:'remote_id') self.remote_id = attributes[:'remote_id'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'payment_memo') self.payment_memo = attributes[:'payment_memo'] end if attributes.key?(:'source_account_name') self.source_account_name = attributes[:'source_account_name'] end if attributes.key?(:'payor_payment_id') self.payor_payment_id = attributes[:'payor_payment_id'] end end
List of attributes with nullable: true
# File lib/velopayments/models/payment_instruction.rb, line 57 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/velopayments/models/payment_instruction.rb, line 45 def self.openapi_types { :'remote_id' => :'String', :'currency' => :'String', :'amount' => :'Integer', :'payment_memo' => :'String', :'source_account_name' => :'String', :'payor_payment_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/velopayments/models/payment_instruction.rb, line 299 def ==(o) return true if self.equal?(o) self.class == o.class && remote_id == o.remote_id && currency == o.currency && amount == o.amount && payment_memo == o.payment_memo && source_account_name == o.source_account_name && payor_payment_id == o.payor_payment_id 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/payment_instruction.rb, line 353 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/payment_instruction.rb, line 422 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
Custom attribute writer method with validation @param [Object] amount Value to be assigned
# File lib/velopayments/models/payment_instruction.rb, line 239 def amount=(amount) if amount.nil? fail ArgumentError, 'amount cannot be nil' end if amount < 1 fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 1.' end @amount = amount 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/payment_instruction.rb, line 332 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
Custom attribute writer method with validation @param [Object] currency Value to be assigned
# File lib/velopayments/models/payment_instruction.rb, line 216 def currency=(currency) if currency.nil? fail ArgumentError, 'currency cannot be nil' end if currency.to_s.length > 3 fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.' end if currency.to_s.length < 3 fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.' end pattern = Regexp.new(/^[A-Z]{3}$/) if currency !~ pattern fail ArgumentError, "invalid value for \"currency\", must conform to the pattern #{pattern}." end @currency = currency end
@see the `==` method @param [Object] Object to be compared
# File lib/velopayments/models/payment_instruction.rb, line 312 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/velopayments/models/payment_instruction.rb, line 318 def hash [remote_id, currency, amount, payment_memo, source_account_name, payor_payment_id].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/payment_instruction.rb, line 104 def list_invalid_properties invalid_properties = Array.new if @remote_id.nil? invalid_properties.push('invalid value for "remote_id", remote_id cannot be nil.') end if @remote_id.to_s.length > 100 invalid_properties.push('invalid value for "remote_id", the character length must be smaller than or equal to 100.') end if @remote_id.to_s.length < 1 invalid_properties.push('invalid value for "remote_id", the character length must be great than or equal to 1.') end if @currency.nil? invalid_properties.push('invalid value for "currency", currency cannot be nil.') end if @currency.to_s.length > 3 invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.') end if @currency.to_s.length < 3 invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.') end pattern = Regexp.new(/^[A-Z]{3}$/) if @currency !~ pattern invalid_properties.push("invalid value for \"currency\", must conform to the pattern #{pattern}.") end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @amount < 1 invalid_properties.push('invalid value for "amount", must be greater than or equal to 1.') end if !@payment_memo.nil? && @payment_memo.to_s.length > 40 invalid_properties.push('invalid value for "payment_memo", the character length must be smaller than or equal to 40.') end if !@payment_memo.nil? && @payment_memo.to_s.length < 0 invalid_properties.push('invalid value for "payment_memo", the character length must be great than or equal to 0.') end if @source_account_name.nil? invalid_properties.push('invalid value for "source_account_name", source_account_name cannot be nil.') end if @source_account_name.to_s.length > 64 invalid_properties.push('invalid value for "source_account_name", the character length must be smaller than or equal to 64.') end if @source_account_name.to_s.length < 1 invalid_properties.push('invalid value for "source_account_name", the character length must be great than or equal to 1.') end if !@payor_payment_id.nil? && @payor_payment_id.to_s.length > 40 invalid_properties.push('invalid value for "payor_payment_id", the character length must be smaller than or equal to 40.') end if !@payor_payment_id.nil? && @payor_payment_id.to_s.length < 0 invalid_properties.push('invalid value for "payor_payment_id", the character length must be great than or equal to 0.') end invalid_properties end
Custom attribute writer method with validation @param [Object] payment_memo
Value to be assigned
# File lib/velopayments/models/payment_instruction.rb, line 253 def payment_memo=(payment_memo) if !payment_memo.nil? && payment_memo.to_s.length > 40 fail ArgumentError, 'invalid value for "payment_memo", the character length must be smaller than or equal to 40.' end if !payment_memo.nil? && payment_memo.to_s.length < 0 fail ArgumentError, 'invalid value for "payment_memo", the character length must be great than or equal to 0.' end @payment_memo = payment_memo end
Custom attribute writer method with validation @param [Object] payor_payment_id
Value to be assigned
# File lib/velopayments/models/payment_instruction.rb, line 285 def payor_payment_id=(payor_payment_id) if !payor_payment_id.nil? && payor_payment_id.to_s.length > 40 fail ArgumentError, 'invalid value for "payor_payment_id", the character length must be smaller than or equal to 40.' end if !payor_payment_id.nil? && payor_payment_id.to_s.length < 0 fail ArgumentError, 'invalid value for "payor_payment_id", the character length must be great than or equal to 0.' end @payor_payment_id = payor_payment_id end
Custom attribute writer method with validation @param [Object] remote_id
Value to be assigned
# File lib/velopayments/models/payment_instruction.rb, line 198 def remote_id=(remote_id) if remote_id.nil? fail ArgumentError, 'remote_id cannot be nil' end if remote_id.to_s.length > 100 fail ArgumentError, 'invalid value for "remote_id", the character length must be smaller than or equal to 100.' end if remote_id.to_s.length < 1 fail ArgumentError, 'invalid value for "remote_id", the character length must be great than or equal to 1.' end @remote_id = remote_id end
Custom attribute writer method with validation @param [Object] source_account_name
Value to be assigned
# File lib/velopayments/models/payment_instruction.rb, line 267 def source_account_name=(source_account_name) if source_account_name.nil? fail ArgumentError, 'source_account_name cannot be nil' end if source_account_name.to_s.length > 64 fail ArgumentError, 'invalid value for "source_account_name", the character length must be smaller than or equal to 64.' end if source_account_name.to_s.length < 1 fail ArgumentError, 'invalid value for "source_account_name", the character length must be great than or equal to 1.' end @source_account_name = source_account_name end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/velopayments/models/payment_instruction.rb, line 404 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/payment_instruction.rb, line 392 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/payment_instruction.rb, line 176 def valid? return false if @remote_id.nil? return false if @remote_id.to_s.length > 100 return false if @remote_id.to_s.length < 1 return false if @currency.nil? return false if @currency.to_s.length > 3 return false if @currency.to_s.length < 3 return false if @currency !~ Regexp.new(/^[A-Z]{3}$/) return false if @amount.nil? return false if @amount < 1 return false if !@payment_memo.nil? && @payment_memo.to_s.length > 40 return false if !@payment_memo.nil? && @payment_memo.to_s.length < 0 return false if @source_account_name.nil? return false if @source_account_name.to_s.length > 64 return false if @source_account_name.to_s.length < 1 return false if !@payor_payment_id.nil? && @payor_payment_id.to_s.length > 40 return false if !@payor_payment_id.nil? && @payor_payment_id.to_s.length < 0 true end