Class: XeroRuby::Accounting::TrackingCategory

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrackingCategory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 84

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

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

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

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

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

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

Instance Attribute Details

#name ⇒ Object

The name of the tracking category e.g. Department, Region (max length = 100)



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

def name
  @name
end

#option ⇒ Object

The option name of the tracking option e.g. East, West (max length = 100)



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

def option
  @option
end

#options ⇒ Object

See Tracking Options



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

def options
  @options
end

#status ⇒ Object

The status of a tracking category



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

def status
  @status
end

#tracking_category_id ⇒ Object

The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9



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

def tracking_category_id
  @tracking_category_id
end

#tracking_option_id ⇒ Object

The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f



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

def tracking_option_id
  @tracking_option_id
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
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 59

def self.attribute_map
  {
    :'tracking_category_id' => :'TrackingCategoryID',
    :'tracking_option_id' => :'TrackingOptionID',
    :'name' => :'Name',
    :'option' => :'Option',
    :'status' => :'Status',
    :'options' => :'Options'
  }
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



207
208
209
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 207

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 71

def self.openapi_types
  {
    :'tracking_category_id' => :'String',
    :'tracking_option_id' => :'String',
    :'name' => :'String',
    :'option' => :'String',
    :'status' => :'String',
    :'options' => :'Array<TrackingOption>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tracking_category_id == o.tracking_category_id &&
      tracking_option_id == o.tracking_option_id &&
      name == o.name &&
      option == o.option &&
      status == o.status &&
      options == o.options
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



235
236
237
238
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
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 235

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 :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) ⇒ 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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 300

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 214

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


194
195
196
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 200

def hash
  [tracking_category_id, tracking_option_id, name, option, status, options].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



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 126

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  if !@option.nil? && @option.to_s.length > 100
    invalid_properties.push('invalid value for "option", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



315
316
317
318
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 315

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 286

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



274
275
276
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 274

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



141
142
143
144
145
146
147
 
# File 'lib/xero-ruby/models/accounting/tracking_category.rb', line 141

def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  return false if !@option.nil? && @option.to_s.length > 100
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED", "DELETED"])
  return false unless status_validator.valid?(@status)
  true
end