Class: Bandwidth::ModifyCallRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/bandwidth/voice_lib/voice/models/modify_call_request.rb

Overview

ModifyCallRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(state = StateEnum::ACTIVE, redirect_url = nil, redirect_fallback_url = nil, redirect_method = nil, redirect_fallback_method = nil, username = nil, password = nil, fallback_username = nil, fallback_password = nil, tag = nil) ⇒ ModifyCallRequest

Returns a new instance of ModifyCallRequest.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 65

def initialize(state = StateEnum::ACTIVE,
               redirect_url = nil,
               redirect_fallback_url = nil,
               redirect_method = nil,
               redirect_fallback_method = nil,
               username = nil,
               password = nil,
               fallback_username = nil,
               fallback_password = nil,
               tag = nil)
  @state = state
  @redirect_url = redirect_url
  @redirect_fallback_url = redirect_fallback_url
  @redirect_method = redirect_method
  @redirect_fallback_method = redirect_fallback_method
  @username = username
  @password = password
  @fallback_username = fallback_username
  @fallback_password = fallback_password
  @tag = tag
end

Instance Attribute Details

#fallback_password ⇒ String

Required if state is ‘active’

Returns:

  • (String) 


43
44
45
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 43

def fallback_password
  @fallback_password
end

#fallback_username ⇒ String

Required if state is ‘active’

Returns:

  • (String) 


39
40
41
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 39

def fallback_username
  @fallback_username
end

#password ⇒ String

Required if state is ‘active’

Returns:

  • (String) 


35
36
37
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 35

def password
  @password
end

#redirect_fallback_method ⇒ RedirectFallbackMethodEnum

Required if state is ‘active’

Returns:



27
28
29
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 27

def redirect_fallback_method
  @redirect_fallback_method
end

#redirect_fallback_url ⇒ String

Required if state is ‘active’

Returns:

  • (String) 


19
20
21
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 19

def redirect_fallback_url
  @redirect_fallback_url
end

#redirect_method ⇒ RedirectMethodEnum

Required if state is ‘active’

Returns:



23
24
25
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 23

def redirect_method
  @redirect_method
end

#redirect_url ⇒ String

Required if state is ‘active’

Returns:

  • (String) 


15
16
17
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 15

def redirect_url
  @redirect_url
end

#state ⇒ StateEnum

TODO: Write general description for this method

Returns:



11
12
13
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 11

def state
  @state
end

#tag ⇒ String

Required if state is ‘active’

Returns:

  • (String) 


47
48
49
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 47

def tag
  @tag
end

#username ⇒ String

Required if state is ‘active’

Returns:

  • (String) 


31
32
33
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 31

def username
  @username
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 88

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  state = hash['state'] ||= StateEnum::ACTIVE
  redirect_url = hash['redirectUrl']
  redirect_fallback_url = hash['redirectFallbackUrl']
  redirect_method = hash['redirectMethod']
  redirect_fallback_method = hash['redirectFallbackMethod']
  username = hash['username']
  password = hash['password']
  fallback_username = hash['fallbackUsername']
  fallback_password = hash['fallbackPassword']
  tag = hash['tag']

  # Create object from extracted values.
  ModifyCallRequest.new(state,
                        redirect_url,
                        redirect_fallback_url,
                        redirect_method,
                        redirect_fallback_method,
                        username,
                        password,
                        fallback_username,
                        fallback_password,
                        tag)
end

.names ⇒ Object

A mapping from model property names to API property names.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/bandwidth/voice_lib/voice/models/modify_call_request.rb', line 50

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['state'] = 'state'
  @_hash['redirect_url'] = 'redirectUrl'
  @_hash['redirect_fallback_url'] = 'redirectFallbackUrl'
  @_hash['redirect_method'] = 'redirectMethod'
  @_hash['redirect_fallback_method'] = 'redirectFallbackMethod'
  @_hash['username'] = 'username'
  @_hash['password'] = 'password'
  @_hash['fallback_username'] = 'fallbackUsername'
  @_hash['fallback_password'] = 'fallbackPassword'
  @_hash['tag'] = 'tag'
  @_hash
end