Class: Verizon::AsynchronousRequestResult

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

Overview

A successful request returns the request ID and the current status.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(request_id = SKIP, status = SKIP) ⇒ AsynchronousRequestResult

Returns a new instance of AsynchronousRequestResult.



41
42
43
44
 
# File 'lib/verizon/models/asynchronous_request_result.rb', line 41

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

Instance Attribute Details

#request_id ⇒ String

The unique ID of the asynchronous request.

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/asynchronous_request_result.rb', line 14

def request_id
  @request_id
end

#status ⇒ RequestStatusEnum

The current status of the callback response.

Returns:



18
19
20
 
# File 'lib/verizon/models/asynchronous_request_result.rb', line 18

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/verizon/models/asynchronous_request_result.rb', line 47

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

  # Create object from extracted values.
  AsynchronousRequestResult.new(request_id,
                                status)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/verizon/models/asynchronous_request_result.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/verizon/models/asynchronous_request_result.rb', line 29

def self.optionals
  %w[
    request_id
    status
  ]
end