Class: XeroRuby::Finance::AccountUsage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountUsage

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
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The account this usage item contains data for



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

def 
  @account_id
end

#account_name ⇒ Object

The name of the account



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

def 
  @account_name
end

#count_manual_journal ⇒ Object

Count of manual journals



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

def count_manual_journal
  @count_manual_journal
end

#count_paid ⇒ Object

Count of paid



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

def count_paid
  @count_paid
end

#count_received ⇒ Object

Count of received



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

def count_received
  @count_received
end

#currency_code ⇒ Object

The currency code this usage item contains data for



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

def currency_code
  @currency_code
end

#month ⇒ Object

The month this usage item contains data for



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

def month
  @month
end

#report_code_updated_date_utc ⇒ Object

Last modified date UTC format



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

def report_code_updated_date_utc
  @report_code_updated_date_utc
end

#reporting_code ⇒ Object

Shown if set



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

def reporting_code
  @reporting_code
end

#reporting_code_name ⇒ Object

Shown if set



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

def reporting_code_name
  @reporting_code_name
end

#total_manual_journal ⇒ Object

Total value of manual journals



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

def total_manual_journal
  @total_manual_journal
end

#total_paid ⇒ Object

Total paid



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

def total_paid
  @total_paid
end

#total_received ⇒ Object

Total received



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

def total_received
  @total_received
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/account_usage.rb', line 59

def self.attribute_map
  {
    :'month' => :'month',
    :'account_id' => :'accountId',
    :'currency_code' => :'currencyCode',
    :'total_received' => :'totalReceived',
    :'count_received' => :'countReceived',
    :'total_paid' => :'totalPaid',
    :'count_paid' => :'countPaid',
    :'total_manual_journal' => :'totalManualJournal',
    :'count_manual_journal' => :'countManualJournal',
    :'account_name' => :'accountName',
    :'reporting_code' => :'reportingCode',
    :'reporting_code_name' => :'reportingCodeName',
    :'report_code_updated_date_utc' => :'reportCodeUpdatedDateUtc'
  }
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



212
213
214
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 212

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/account_usage.rb', line 78

def self.openapi_types
  {
    :'month' => :'String',
    :'account_id' => :'String',
    :'currency_code' => :'String',
    :'total_received' => :'BigDecimal',
    :'count_received' => :'Integer',
    :'total_paid' => :'BigDecimal',
    :'count_paid' => :'Integer',
    :'total_manual_journal' => :'BigDecimal',
    :'count_manual_journal' => :'Integer',
    :'account_name' => :'String',
    :'reporting_code' => :'String',
    :'reporting_code_name' => :'String',
    :'report_code_updated_date_utc' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      month == o.month &&
       == o. &&
      currency_code == o.currency_code &&
      total_received == o.total_received &&
      count_received == o.count_received &&
      total_paid == o.total_paid &&
      count_paid == o.count_paid &&
      total_manual_journal == o.total_manual_journal &&
      count_manual_journal == o.count_manual_journal &&
       == o. &&
      reporting_code == o.reporting_code &&
      reporting_code_name == o.reporting_code_name &&
      report_code_updated_date_utc == o.report_code_updated_date_utc
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



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/finance/account_usage.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::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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 313

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/xero-ruby/models/finance/account_usage.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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 205

def hash
  [month, , currency_code, total_received, count_received, total_paid, count_paid, total_manual_journal, count_manual_journal, , reporting_code, reporting_code_name, report_code_updated_date_utc].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



166
167
168
169
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 166

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 329

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



305
306
307
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 305

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



287
288
289
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 287

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



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 293

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



281
282
283
 
# File 'lib/xero-ruby/models/finance/account_usage.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

Returns:

  • (Boolean) —

    true if the model is valid



173
174
175
 
# File 'lib/xero-ruby/models/finance/account_usage.rb', line 173

def valid?
  true
end