Class: ShellEv::InternalErrorObject

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_ev/models/internal_error_object.rb

Overview

InternalErrorObject Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(code = SKIP, message = SKIP, description = SKIP) ⇒ InternalErrorObject

Returns a new instance of InternalErrorObject.



49
50
51
52
53
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 49

def initialize(code = SKIP, message = SKIP, description = SKIP)
  @code = code unless code == SKIP
  @message = message unless message == SKIP
  @description = description unless description == SKIP
end

Instance Attribute Details

#code ⇒ String

Error code

Returns:

  • (String) 


14
15
16
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 14

def code
  @code
end

#description ⇒ String

Technical details of the error message, the example which is given in the sample payload is one of the scenario. actual response will vary based on the technical nature

Returns:

  • (String) 


24
25
26
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 24

def description
  @description
end

#message ⇒ String

Error description in English

Returns:

  • (String) 


18
19
20
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 18

def message
  @message
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 56

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  code = hash.key?('code') ? hash['code'] : SKIP
  message = hash.key?('message') ? hash['message'] : SKIP
  description = hash.key?('description') ? hash['description'] : SKIP

  # Create object from extracted values.
  InternalErrorObject.new(code,
                          message,
                          description)
end

.names ⇒ Object

A mapping from model property names to API property names.



27
28
29
30
31
32
33
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 27

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

.nullables ⇒ Object

An array for nullable fields



45
46
47
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 45

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



36
37
38
39
40
41
42
 
# File 'lib/shell_ev/models/internal_error_object.rb', line 36

def self.optionals
  %w[
    code
    message
    description
  ]
end