Class: XeroRuby::Finance::StatementLineResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StatementLineResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Finance::StatementLineResponse` 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::Finance::StatementLineResponse`. 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?(:'statement_line_id')
    self.statement_line_id = attributes[:'statement_line_id']
  end

  if attributes.key?(:'posted_date')
    self.posted_date = attributes[:'posted_date']
  end

  if attributes.key?(:'reference')
    self.reference = attributes[:'reference']
  end

  if attributes.key?(:'notes')
    self.notes = attributes[:'notes']
  end

  if attributes.key?(:'cheque_no')
    self.cheque_no = attributes[:'cheque_no']
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'transaction_date')
    self.transaction_date = attributes[:'transaction_date']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'is_reconciled')
    self.is_reconciled = attributes[:'is_reconciled']
  end

  if attributes.key?(:'is_duplicate')
    self.is_duplicate = attributes[:'is_duplicate']
  end

  if attributes.key?(:'is_deleted')
    self.is_deleted = attributes[:'is_deleted']
  end

  if attributes.key?(:'payments')
    if (value = attributes[:'payments']).is_a?(Array)
      self.payments = value
    end
  end

  if attributes.key?(:'bank_transactions')
    if (value = attributes[:'bank_transactions']).is_a?(Array)
      self.bank_transactions = value
    end
  end
end

Instance Attribute Details

#amount ⇒ Object

Amount of statement line



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

def amount
  @amount
end

#bank_transactions ⇒ Object

List of bank transactions associated with reconciled statement lines



56
57
58
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 56

def bank_transactions
  @bank_transactions
end

#cheque_no ⇒ Object

Cheque number of statement line



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

def cheque_no
  @cheque_no
end

#is_deleted ⇒ Object

Boolean to show if statement line is deleted



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

def is_deleted
  @is_deleted
end

#is_duplicate ⇒ Object

Boolean to show if statement line is duplicate



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

def is_duplicate
  @is_duplicate
end

#is_reconciled ⇒ Object

Boolean to show if statement line is reconciled



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

def is_reconciled
  @is_reconciled
end

#notes ⇒ Object

Notes description of statement line



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

def notes
  @notes
end

#payments ⇒ Object

List of payments associated with reconciled statement lines



53
54
55
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 53

def payments
  @payments
end

#posted_date ⇒ Object

Date of when statement line was posted



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

def posted_date
  @posted_date
end

#reference ⇒ Object

Reference description of statement line



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

def reference
  @reference
end

#statement_line_id ⇒ Object

Xero Identifier of statement line



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

def statement_line_id
  @statement_line_id
end

#transaction_date ⇒ Object

Transaction date of statement line



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

def transaction_date
  @transaction_date
end

#type ⇒ Object

Type of statement line



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 59

def self.attribute_map
  {
    :'statement_line_id' => :'statementLineId',
    :'posted_date' => :'postedDate',
    :'reference' => :'reference',
    :'notes' => :'notes',
    :'cheque_no' => :'chequeNo',
    :'amount' => :'amount',
    :'transaction_date' => :'transactionDate',
    :'type' => :'type',
    :'is_reconciled' => :'isReconciled',
    :'is_duplicate' => :'isDuplicate',
    :'is_deleted' => :'isDeleted',
    :'payments' => :'payments',
    :'bank_transactions' => :'bankTransactions'
  }
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



216
217
218
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 216

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 78

def self.openapi_types
  {
    :'statement_line_id' => :'String',
    :'posted_date' => :'Date',
    :'reference' => :'String',
    :'notes' => :'String',
    :'cheque_no' => :'String',
    :'amount' => :'BigDecimal',
    :'transaction_date' => :'Date',
    :'type' => :'String',
    :'is_reconciled' => :'Boolean',
    :'is_duplicate' => :'Boolean',
    :'is_deleted' => :'Boolean',
    :'payments' => :'Array<PaymentResponse>',
    :'bank_transactions' => :'Array<BankTransactionResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      statement_line_id == o.statement_line_id &&
      posted_date == o.posted_date &&
      reference == o.reference &&
      notes == o.notes &&
      cheque_no == o.cheque_no &&
      amount == o.amount &&
      transaction_date == o.transaction_date &&
      type == o.type &&
      is_reconciled == o.is_reconciled &&
      is_duplicate == o.is_duplicate &&
      is_deleted == o.is_deleted &&
      payments == o.payments &&
      bank_transactions == o.bank_transactions
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



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
278
279
280
281
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 244

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::Finance.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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 317

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 223

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


203
204
205
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 209

def hash
  [statement_line_id, posted_date, reference, notes, cheque_no, amount, transaction_date, type, is_reconciled, is_duplicate, is_deleted, payments, bank_transactions].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



170
171
172
173
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 333

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

#to_attributes ⇒ Object

Returns the object in the form of hash with snake_case



309
310
311
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 309

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 291

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



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 297

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



285
286
287
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 285

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



177
178
179
 
# File 'lib/xero-ruby/models/finance/statement_line_response.rb', line 177

def valid?
  true
end