class XeroRuby::Accounting::BankTransfer
Attributes
amount of the transaction
The identifier of the Bank Transfer
UTC timestamp of creation date of bank transfer
The currency rate
The date of the Transfer YYYY-MM-DD
The Bank Transaction ID for the source account
Boolean to indicate if a Bank Transfer has an attachment
The Bank Transaction ID for the destination account
Displays array of validation error messages from the API
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 53 def self.attribute_map { :'from_bank_account' => :'FromBankAccount', :'to_bank_account' => :'ToBankAccount', :'amount' => :'Amount', :'date' => :'Date', :'bank_transfer_id' => :'BankTransferID', :'currency_rate' => :'CurrencyRate', :'from_bank_transaction_id' => :'FromBankTransactionID', :'to_bank_transaction_id' => :'ToBankTransactionID', :'has_attachments' => :'HasAttachments', :'created_date_utc' => :'CreatedDateUTC', :'validation_errors' => :'ValidationErrors' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 211 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/xero-ruby/models/accounting/bank_transfer.rb, line 88 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::BankTransfer` 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 `XeroRuby::Accounting::BankTransfer`. 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?(:'from_bank_account') self.from_bank_account = attributes[:'from_bank_account'] end if attributes.key?(:'to_bank_account') self.to_bank_account = attributes[:'to_bank_account'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'bank_transfer_id') self.bank_transfer_id = attributes[:'bank_transfer_id'] end if attributes.key?(:'currency_rate') self.currency_rate = attributes[:'currency_rate'] end if attributes.key?(:'from_bank_transaction_id') self.from_bank_transaction_id = attributes[:'from_bank_transaction_id'] end if attributes.key?(:'to_bank_transaction_id') self.to_bank_transaction_id = attributes[:'to_bank_transaction_id'] end if attributes.key?(:'has_attachments') self.has_attachments = attributes[:'has_attachments'] else self.has_attachments = false end if attributes.key?(:'created_date_utc') self.created_date_utc = attributes[:'created_date_utc'] end if attributes.key?(:'validation_errors') if (value = attributes[:'validation_errors']).is_a?(Array) self.validation_errors = value end end end
Attribute type mapping.
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 70 def self.openapi_types { :'from_bank_account' => :'Account', :'to_bank_account' => :'Account', :'amount' => :'BigDecimal', :'date' => :'Date', :'bank_transfer_id' => :'String', :'currency_rate' => :'BigDecimal', :'from_bank_transaction_id' => :'String', :'to_bank_transaction_id' => :'String', :'has_attachments' => :'Boolean', :'created_date_utc' => :'DateTime', :'validation_errors' => :'Array<ValidationError>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 180 def ==(o) return true if self.equal?(o) self.class == o.class && from_bank_account == o.from_bank_account && to_bank_account == o.to_bank_account && amount == o.amount && date == o.date && bank_transfer_id == o.bank_transfer_id && currency_rate == o.currency_rate && from_bank_transaction_id == o.from_bank_transaction_id && to_bank_transaction_id == o.to_bank_transaction_id && has_attachments == o.has_attachments && created_date_utc == o.created_date_utc && validation_errors == o.validation_errors 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/xero-ruby/models/accounting/bank_transfer.rb, line 239 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(parse_date(value)) when :Date Date.parse(parse_date(value)) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BigDecimal BigDecimal(value.to_s) 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 XeroRuby::Accounting.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/xero-ruby/models/accounting/bank_transfer.rb, line 312 def _to_hash(value, downcase: false) if value.is_a?(Array) value.map do |v| v.to_hash(downcase: downcase) end elsif value.is_a?(Hash) {}.tap do |hash| value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) } end elsif value.respond_to? :to_hash value.to_hash(downcase: downcase) 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/xero-ruby/models/accounting/bank_transfer.rb, line 218 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/xero-ruby/models/accounting/bank_transfer.rb, line 198 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 204 def hash [from_bank_account, to_bank_account, amount, date, bank_transfer_id, currency_rate, from_bank_transaction_id, to_bank_transaction_id, has_attachments, created_date_utc, validation_errors].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 152 def list_invalid_properties invalid_properties = Array.new if @from_bank_account.nil? invalid_properties.push('invalid value for "from_bank_account", from_bank_account cannot be nil.') end if @to_bank_account.nil? invalid_properties.push('invalid value for "to_bank_account", to_bank_account cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end invalid_properties end
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 328 def parse_date(datestring) if datestring.include?('Date') date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\// original, date, timezone = *date_pattern.match(datestring) date = (date.to_i / 1000) Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s else # handle date 'types' for small subset of payroll API's Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s end end
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 304 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 292 def to_hash(downcase: false) hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? key = downcase ? attr : param hash[key] = _to_hash(value, downcase: downcase) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/accounting/bank_transfer.rb, line 280 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/xero-ruby/models/accounting/bank_transfer.rb, line 171 def valid? return false if @from_bank_account.nil? return false if @to_bank_account.nil? return false if @amount.nil? true end