Class: XeroRuby::Accounting::BankTransfer
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::BankTransfer
- Defined in:
- lib/xero-ruby/models/accounting/bank_transfer.rb
Instance Attribute Summary collapse
-
#amount ⇒ Object
amount of the transaction.
-
#bank_transfer_id ⇒ Object
The identifier of the Bank Transfer.
-
#created_date_utc ⇒ Object
UTC timestamp of creation date of bank transfer.
-
#currency_rate ⇒ Object
The currency rate.
-
#date ⇒ Object
The date of the Transfer YYYY-MM-DD.
-
#from_bank_account ⇒ Object
Returns the value of attribute from_bank_account.
-
#from_bank_transaction_id ⇒ Object
The Bank Transaction ID for the source account.
-
#has_attachments ⇒ Object
Boolean to indicate if a Bank Transfer has an attachment.
-
#to_bank_account ⇒ Object
Returns the value of attribute to_bank_account.
-
#to_bank_transaction_id ⇒ Object
The Bank Transaction ID for the destination account.
-
#validation_errors ⇒ Object
Displays array of validation error messages from the API.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BankTransfer
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#parse_date(datestring) ⇒ Object
customized data_parser.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ BankTransfer
Initializes the object
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 89 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. = attributes[:'has_attachments'] else self. = 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 |
Instance Attribute Details
#amount ⇒ Object
amount of the transaction
27 28 29 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 27 def amount @amount end |
#bank_transfer_id ⇒ Object
The identifier of the Bank Transfer
33 34 35 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 33 def bank_transfer_id @bank_transfer_id end |
#created_date_utc ⇒ Object
UTC timestamp of creation date of bank transfer
48 49 50 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 48 def created_date_utc @created_date_utc end |
#currency_rate ⇒ Object
The currency rate
36 37 38 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 36 def currency_rate @currency_rate end |
#date ⇒ Object
The date of the Transfer YYYY-MM-DD
30 31 32 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 30 def date @date end |
#from_bank_account ⇒ Object
Returns the value of attribute from_bank_account.
21 22 23 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 21 def from_bank_account @from_bank_account end |
#from_bank_transaction_id ⇒ Object
The Bank Transaction ID for the source account
39 40 41 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 39 def from_bank_transaction_id @from_bank_transaction_id end |
#has_attachments ⇒ Object
Boolean to indicate if a Bank Transfer has an attachment
45 46 47 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 45 def @has_attachments end |
#to_bank_account ⇒ Object
Returns the value of attribute to_bank_account.
24 25 26 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 24 def to_bank_account @to_bank_account end |
#to_bank_transaction_id ⇒ Object
The Bank Transaction ID for the destination account
42 43 44 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 42 def to_bank_transaction_id @to_bank_transaction_id end |
#validation_errors ⇒ Object
Displays array of validation error messages from the API
51 52 53 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 51 def validation_errors @validation_errors end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 54 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 |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
212 213 214 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 212 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 71 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 181 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 && == o. && created_date_utc == o.created_date_utc && validation_errors == o.validation_errors end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 240 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 307 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 219 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 |
#eql?(o) ⇒ Boolean
199 200 201 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 199 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
205 206 207 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 205 def hash [from_bank_account, to_bank_account, amount, date, bank_transfer_id, currency_rate, from_bank_transaction_id, to_bank_transaction_id, , created_date_utc, validation_errors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 153 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 |
#parse_date(datestring) ⇒ Object
customized data_parser
322 323 324 325 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 322 def parse_date(datestring) seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0 return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
287 288 289 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 287 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
293 294 295 296 297 298 299 300 301 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 293 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
281 282 283 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 281 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
172 173 174 175 176 177 |
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 172 def valid? return false if @from_bank_account.nil? return false if @to_bank_account.nil? return false if @amount.nil? true end |