Class: ShellEv::SingleLocationMarkerResponse

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

Overview

SingleLocationMarkerResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(request_id = SKIP, status = SKIP, data = SKIP) ⇒ SingleLocationMarkerResponse 



48
49
50
51
52
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 48

def initialize(request_id = SKIP, status = SKIP, data = SKIP)
  @request_id = request_id unless request_id == SKIP
  @status = status unless status == SKIP
  @data = data unless data == SKIP
end

Instance Attribute Details

#data ⇒ Array[Object]

status of the API call



23
24
25
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 23

def data
  @data
end

#request_id ⇒ UUID | String

requestId is unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain.



15
16
17
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 15

def request_id
  @request_id
end

#status ⇒ String

status of the API call



19
20
21
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 19

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
  status = hash.key?('status') ? hash['status'] : SKIP
  data = hash.key?('data') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:LocationMarker), hash['data']
  ) : SKIP

  # Create object from extracted values.

  SingleLocationMarkerResponse.new(request_id,
                                   status,
                                   data)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['request_id'] = 'requestId'
  @_hash['status'] = 'status'
  @_hash['data'] = 'data'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    request_id
    status
    data
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.



73
74
75
76
77
78
79
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 73

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



88
89
90
91
92
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 88

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
  " #{@data.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



82
83
84
85
 
# File 'lib/shell_ev/models/single_location_marker_response.rb', line 82

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}>"
end