Class: ShellEv::RatelimitErrMsg

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

Overview

RatelimitErrMsg 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, details = SKIP) ⇒ RatelimitErrMsg

Returns a new instance of RatelimitErrMsg.



57
58
59
60
61
62
63
 
# File 'lib/shell_ev/models/ratelimit_err_msg.rb', line 57

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

Instance Attribute Details

#code ⇒ String

Error code

Returns:

  • (String) 


14
15
16
 
# File 'lib/shell_ev/models/ratelimit_err_msg.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 scenarios. actual response will vary based on the technical nature

Returns:

  • (String) 


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

def description
  @description
end

#details ⇒ Array[String]

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

Returns:

  • (Array[String]) 


30
31
32
 
# File 'lib/shell_ev/models/ratelimit_err_msg.rb', line 30

def details
  @details
end

#message ⇒ String

Error desctiption in English

Returns:

  • (String) 


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

def message
  @message
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/shell_ev/models/ratelimit_err_msg.rb', line 66

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
  details = hash.key?('details') ? hash['details'] : SKIP

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

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
 
# File 'lib/shell_ev/models/ratelimit_err_msg.rb', line 33

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

.nullables ⇒ Object

An array for nullable fields



53
54
55
 
# File 'lib/shell_ev/models/ratelimit_err_msg.rb', line 53

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



43
44
45
46
47
48
49
50
 
# File 'lib/shell_ev/models/ratelimit_err_msg.rb', line 43

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