Class: XeroRuby::Finance::DataSourceResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataSourceResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#direct_bank_feed ⇒ Object

Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data.



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

def direct_bank_feed
  @direct_bank_feed
end

#direct_bank_feed_neg ⇒ Object

Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.



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

def direct_bank_feed_neg
  @direct_bank_feed_neg
end

#direct_bank_feed_pos ⇒ Object

Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.



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

def direct_bank_feed_pos
  @direct_bank_feed_pos
end

#file_upload ⇒ Object

Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data.



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

def file_upload
  @file_upload
end

#file_upload_neg ⇒ Object

Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.



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

def file_upload_neg
  @file_upload_neg
end

#file_upload_pos ⇒ Object

Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.



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

def file_upload_pos
  @file_upload_pos
end

#indirect_bank_feed ⇒ Object

No longer in use.



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

def indirect_bank_feed
  @indirect_bank_feed
end

#indirect_bank_feed_neg ⇒ Object

No longer in use.



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

def indirect_bank_feed_neg
  @indirect_bank_feed_neg
end

#indirect_bank_feed_pos ⇒ Object

No longer in use.



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

def indirect_bank_feed_pos
  @indirect_bank_feed_pos
end

#manual ⇒ Object

Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data.



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

def manual
  @manual
end

#manual_neg ⇒ Object

Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.



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

def manual_neg
  @manual_neg
end

#manual_pos ⇒ Object

Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.



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

def manual_pos
  @manual_pos
end

#other ⇒ Object

Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data.



62
63
64
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 62

def other
  @other
end

#other_neg ⇒ Object

Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.



59
60
61
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 59

def other_neg
  @other_neg
end

#other_pos ⇒ Object

Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.



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

def other_pos
  @other_pos
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 65

def self.attribute_map
  {
    :'direct_bank_feed' => :'directBankFeed',
    :'indirect_bank_feed' => :'indirectBankFeed',
    :'file_upload' => :'fileUpload',
    :'manual' => :'manual',
    :'direct_bank_feed_pos' => :'directBankFeedPos',
    :'indirect_bank_feed_pos' => :'indirectBankFeedPos',
    :'file_upload_pos' => :'fileUploadPos',
    :'manual_pos' => :'manualPos',
    :'direct_bank_feed_neg' => :'directBankFeedNeg',
    :'indirect_bank_feed_neg' => :'indirectBankFeedNeg',
    :'file_upload_neg' => :'fileUploadNeg',
    :'manual_neg' => :'manualNeg',
    :'other_pos' => :'otherPos',
    :'other_neg' => :'otherNeg',
    :'other' => :'other'
  }
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



232
233
234
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 232

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 86

def self.openapi_types
  {
    :'direct_bank_feed' => :'BigDecimal',
    :'indirect_bank_feed' => :'BigDecimal',
    :'file_upload' => :'BigDecimal',
    :'manual' => :'BigDecimal',
    :'direct_bank_feed_pos' => :'BigDecimal',
    :'indirect_bank_feed_pos' => :'BigDecimal',
    :'file_upload_pos' => :'BigDecimal',
    :'manual_pos' => :'BigDecimal',
    :'direct_bank_feed_neg' => :'BigDecimal',
    :'indirect_bank_feed_neg' => :'BigDecimal',
    :'file_upload_neg' => :'BigDecimal',
    :'manual_neg' => :'BigDecimal',
    :'other_pos' => :'BigDecimal',
    :'other_neg' => :'BigDecimal',
    :'other' => :'BigDecimal'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      direct_bank_feed == o.direct_bank_feed &&
      indirect_bank_feed == o.indirect_bank_feed &&
      file_upload == o.file_upload &&
      manual == o.manual &&
      direct_bank_feed_pos == o.direct_bank_feed_pos &&
      indirect_bank_feed_pos == o.indirect_bank_feed_pos &&
      file_upload_pos == o.file_upload_pos &&
      manual_pos == o.manual_pos &&
      direct_bank_feed_neg == o.direct_bank_feed_neg &&
      indirect_bank_feed_neg == o.indirect_bank_feed_neg &&
      file_upload_neg == o.file_upload_neg &&
      manual_neg == o.manual_neg &&
      other_pos == o.other_pos &&
      other_neg == o.other_neg &&
      other == o.other
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 260

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



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

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 239

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


219
220
221
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 225

def hash
  [direct_bank_feed, indirect_bank_feed, file_upload, manual, direct_bank_feed_pos, indirect_bank_feed_pos, file_upload_pos, manual_pos, direct_bank_feed_neg, indirect_bank_feed_neg, file_upload_neg, manual_neg, other_pos, other_neg, other].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



184
185
186
187
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 184

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 349

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



325
326
327
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 325

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



307
308
309
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 313

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



301
302
303
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 301

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



191
192
193
 
# File 'lib/xero-ruby/models/finance/data_source_response.rb', line 191

def valid?
  true
end