Class: Verizon::LogInResult

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/log_in_result.rb

Overview

Response to initiate a Connectivity Management session and returns a VZ-M2M session token that is required in subsequent API requests.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(session_token = SKIP) ⇒ LogInResult

Returns a new instance of LogInResult.



37
38
39
 
# File 'lib/verizon/models/log_in_result.rb', line 37

def initialize(session_token = SKIP)
  @session_token = session_token unless session_token == SKIP
end

Instance Attribute Details

#session_token ⇒ String

The identifier for the session that was created by the request. Store the sessionToken for use in the header of all other API requests.

Returns:

  • (String) 


16
17
18
 
# File 'lib/verizon/models/log_in_result.rb', line 16

def session_token
  @session_token
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



42
43
44
45
46
47
48
49
50
 
# File 'lib/verizon/models/log_in_result.rb', line 42

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  session_token = hash.key?('sessionToken') ? hash['sessionToken'] : SKIP

  # Create object from extracted values.
  LogInResult.new(session_token)
end

.names ⇒ Object

A mapping from model property names to API property names.



19
20
21
22
23
 
# File 'lib/verizon/models/log_in_result.rb', line 19

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['session_token'] = 'sessionToken'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



33
34
35
 
# File 'lib/verizon/models/log_in_result.rb', line 33

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



26
27
28
29
30
 
# File 'lib/verizon/models/log_in_result.rb', line 26

def self.optionals
  %w[
    session_token
  ]
end