Class: XeroRuby::Accounting::BankTransfer

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/bank_transfer.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BankTransfer

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


88
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
# 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. = attributes[:'from_bank_account']
  end

  if attributes.key?(:'to_bank_account')
    self. = 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

Instance Attribute Details

#amountObject

amount of the transaction


26
27
28
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 26

def amount
  @amount
end

#bank_transfer_idObject

The identifier of the Bank Transfer


32
33
34
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 32

def bank_transfer_id
  @bank_transfer_id
end

#created_date_utcObject

UTC timestamp of creation date of bank transfer


47
48
49
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 47

def created_date_utc
  @created_date_utc
end

#currency_rateObject

The currency rate


35
36
37
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 35

def currency_rate
  @currency_rate
end

#dateObject

The date of the Transfer YYYY-MM-DD


29
30
31
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 29

def date
  @date
end

#from_bank_accountObject

Returns the value of attribute from_bank_account


20
21
22
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 20

def 
  @from_bank_account
end

#from_bank_transaction_idObject

The Bank Transaction ID for the source account


38
39
40
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 38

def from_bank_transaction_id
  @from_bank_transaction_id
end

#has_attachmentsObject

Boolean to indicate if a Bank Transfer has an attachment


44
45
46
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 44

def has_attachments
  @has_attachments
end

#to_bank_accountObject

Returns the value of attribute to_bank_account


23
24
25
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 23

def 
  @to_bank_account
end

#to_bank_transaction_idObject

The Bank Transaction ID for the destination account


41
42
43
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 41

def to_bank_transaction_id
  @to_bank_transaction_id
end

#validation_errorsObject

Displays array of validation error messages from the API


50
51
52
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 50

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# 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

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


211
212
213
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 211

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_typesObject

Attribute type mapping.


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


239
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
# 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

#_to_hash(value, downcase: false) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# 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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

198
199
200
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 198

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


204
205
206
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 204

def hash
  [, , amount, date, bank_transfer_id, currency_rate, from_bank_transaction_id, to_bank_transaction_id, has_attachments, created_date_utc, validation_errors].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# 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

#parse_date(datestring) ⇒ Object


328
329
330
331
332
333
334
335
336
337
# 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
  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

#to_attributesObject

Returns the object in the form of hash with snake_case


304
305
306
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 304

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


286
287
288
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 286

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


292
293
294
295
296
297
298
299
300
301
# 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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


280
281
282
# File 'lib/xero-ruby/models/accounting/bank_transfer.rb', line 280

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


171
172
173
174
175
176
# 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