Class: Bandwidth::OrderResponse

Inherits:
BaseModel show all
Defined in:
lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb

Overview

The request has been accepted for processing but not yet finished and in a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED)

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 = nil, status = nil) ⇒ OrderResponse

Returns a new instance of OrderResponse.



42
43
44
45
46
 
# File 'lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb', line 42

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

Instance Attribute Details

#request_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


15
16
17
 
# File 'lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb', line 15

def request_id
  @request_id
end

#status ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


19
20
21
 
# File 'lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb', line 19

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb', line 49

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.
  OrderResponse.new(request_id,
                    status)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb', line 22

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

Instance Method Details

#nullables ⇒ Object

An array for nullable fields



38
39
40
 
# File 'lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb', line 38

def nullables
  []
end

#optionals ⇒ Object

An array for optional fields



30
31
32
33
34
35
 
# File 'lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb', line 30

def optionals
  %w[
    request_id
    status
  ]
end