Class: Bandwidth::FieldError

Inherits:
BaseModel show all
Defined in:
lib/bandwidth/messaging_lib/messaging/models/field_error.rb

Overview

FieldError Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(field_name = nil, description = nil) ⇒ FieldError

Returns a new instance of FieldError.



25
26
27
28
29
 
# File 'lib/bandwidth/messaging_lib/messaging/models/field_error.rb', line 25

def initialize(field_name = nil,
               description = nil)
  @field_name = field_name
  @description = description
end

Instance Attribute Details

#description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


15
16
17
 
# File 'lib/bandwidth/messaging_lib/messaging/models/field_error.rb', line 15

def description
  @description
end

#field_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


11
12
13
 
# File 'lib/bandwidth/messaging_lib/messaging/models/field_error.rb', line 11

def field_name
  @field_name
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bandwidth/messaging_lib/messaging/models/field_error.rb', line 32

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  field_name = hash['fieldName']
  description = hash['description']

  # Create object from extracted values.

  FieldError.new(field_name,
                 description)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
23
 
# File 'lib/bandwidth/messaging_lib/messaging/models/field_error.rb', line 18

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['field_name'] = 'fieldName'
  @_hash['description'] = 'description'
  @_hash
end