Class: XeroRuby::Accounting::ImportSummaryAccounts

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportSummaryAccounts

Initializes the object

Parameters:

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

    Model attributes in the form of hash


79
80
81
82
83
84
85
86
87
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
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 79

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#deletedObject

The number of accounts deleted


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

def deleted
  @deleted
end

#erroredObject

The number of accounts that had an error


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

def errored
  @errored
end

#lockedObject

The number of locked accounts


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

def locked
  @locked
end

#newObject

The number of new accounts created


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

def new
  @new
end

#new_or_updatedObject

The number of new or updated accounts


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

def new_or_updated
  @new_or_updated
end

#presentObject

Returns the value of attribute present


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

def present
  @present
end

#systemObject

The number of system accounts


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

def system
  @system
end

#totalObject

The total number of accounts in the org


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

def total
  @total
end

#updatedObject

The number of accounts updated


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

def updated
  @updated
end

Class Method Details

.attribute_mapObject

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


48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 48

def self.attribute_map
  {
    :'total' => :'Total',
    :'new' => :'New',
    :'updated' => :'Updated',
    :'deleted' => :'Deleted',
    :'locked' => :'Locked',
    :'system' => :'System',
    :'errored' => :'Errored',
    :'present' => :'Present',
    :'new_or_updated' => :'NewOrUpdated'
  }
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


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

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

.openapi_typesObject

Attribute type mapping.


63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 63

def self.openapi_types
  {
    :'total' => :'Integer',
    :'new' => :'Integer',
    :'updated' => :'Integer',
    :'deleted' => :'Integer',
    :'locked' => :'Integer',
    :'system' => :'Integer',
    :'errored' => :'Integer',
    :'present' => :'Boolean',
    :'new_or_updated' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      new == o.new &&
      updated == o.updated &&
      deleted == o.deleted &&
      locked == o.locked &&
      system == o.system &&
      errored == o.errored &&
      present == o.present &&
      new_or_updated == o.new_or_updated
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


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 201

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


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 274

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


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

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

160
161
162
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 160

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


166
167
168
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 166

def hash
  [total, new, updated, deleted, locked, system, errored, present, new_or_updated].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


131
132
133
134
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


290
291
292
293
294
295
296
297
298
299
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 290

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


266
267
268
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 266

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


248
249
250
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 248

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


254
255
256
257
258
259
260
261
262
263
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 254

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


242
243
244
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 242

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


138
139
140
# File 'lib/xero-ruby/models/accounting/import_summary_accounts.rb', line 138

def valid?
  true
end