Class: XeroRuby::Assets::ResourceValidationErrorsElement

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceValidationErrorsElement

Initializes the object

Parameters:

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

    Model attributes in the form of hash


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 58

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

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

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

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

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

Instance Attribute Details

#detailObject

Detail of the resource validation error


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

def detail
  @detail
end

#localised_messageObject

Explanation of the resource validation error


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

def localised_message
  @localised_message
end

#resource_nameObject

The field name of the erroneous field


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

def resource_name
  @resource_name
end

#titleObject

Title of the resource validation error


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

def title
  @title
end

#typeObject

Internal type of the resource error message


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

def type
  @type
end

Class Method Details

.attribute_mapObject

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


35
36
37
38
39
40
41
42
43
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 35

def self.attribute_map
  {
    :'resource_name' => :'resourceName',
    :'localised_message' => :'localisedMessage',
    :'type' => :'type',
    :'title' => :'title',
    :'detail' => :'detail'
  }
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


132
133
134
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 132

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

.openapi_typesObject

Attribute type mapping.


46
47
48
49
50
51
52
53
54
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 46

def self.openapi_types
  {
    :'resource_name' => :'String',
    :'localised_message' => :'String',
    :'type' => :'String',
    :'title' => :'String',
    :'detail' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


107
108
109
110
111
112
113
114
115
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      resource_name == o.resource_name &&
      localised_message == o.localised_message &&
      type == o.type &&
      title == o.title &&
      detail == o.detail
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


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 160

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


233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 233

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


139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 139

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

119
120
121
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 119

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


125
126
127
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 125

def hash
  [resource_name, localised_message, type, title, detail].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


94
95
96
97
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 94

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


249
250
251
252
253
254
255
256
257
258
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 249

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


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

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


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

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


213
214
215
216
217
218
219
220
221
222
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 213

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


201
202
203
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 201

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


101
102
103
# File 'lib/xero-ruby/models/assets/resource_validation_errors_element.rb', line 101

def valid?
  true
end