Class: Bandwidth::UpdateCall

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/update_call.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateCall

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 127

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::UpdateCall` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::UpdateCall`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = 'active'
  end

  if attributes.key?(:'redirect_url')
    self.redirect_url = attributes[:'redirect_url']
  end

  if attributes.key?(:'redirect_method')
    self.redirect_method = attributes[:'redirect_method']
  else
    self.redirect_method = 'POST'
  end

  if attributes.key?(:'username')
    self.username = attributes[:'username']
  end

  if attributes.key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.key?(:'redirect_fallback_url')
    self.redirect_fallback_url = attributes[:'redirect_fallback_url']
  end

  if attributes.key?(:'redirect_fallback_method')
    self.redirect_fallback_method = attributes[:'redirect_fallback_method']
  else
    self.redirect_fallback_method = 'POST'
  end

  if attributes.key?(:'fallback_username')
    self.fallback_username = attributes[:'fallback_username']
  end

  if attributes.key?(:'fallback_password')
    self.fallback_password = attributes[:'fallback_password']
  end

  if attributes.key?(:'tag')
    self.tag = attributes[:'tag']
  end
end

Instance Attribute Details

#fallback_password ⇒ Object

Basic auth password.



40
41
42
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 40

def fallback_password
  @fallback_password
end

#fallback_username ⇒ Object

Basic auth username.



37
38
39
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 37

def fallback_username
  @fallback_username
end

#password ⇒ Object

Basic auth password.



29
30
31
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 29

def password
  @password
end

#redirect_fallback_method ⇒ Object

Returns the value of attribute redirect_fallback_method.



34
35
36
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 34

def redirect_fallback_method
  @redirect_fallback_method
end

#redirect_fallback_url ⇒ Object

A fallback url which, if provided, will be used to retry the redirect callback delivery in case ‘redirectUrl` fails to respond.



32
33
34
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 32

def redirect_fallback_url
  @redirect_fallback_url
end

#redirect_method ⇒ Object

Returns the value of attribute redirect_method.



23
24
25
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 23

def redirect_method
  @redirect_method
end

#redirect_url ⇒ Object

The URL to send the [Redirect](/docs/voice/bxml/redirect) event to which will provide new BXML. Required if ‘state` is `active`. Not allowed if `state` is `completed`.



21
22
23
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 21

def redirect_url
  @redirect_url
end

#state ⇒ Object

Returns the value of attribute state.



18
19
20
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 18

def state
  @state
end

#tag ⇒ Object

A custom string that will be sent with this and all future callbacks unless overwritten by a future ‘tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=""`. Max length 256 characters. Not allowed if `state` is `completed`.



43
44
45
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 43

def tag
  @tag
end

#username ⇒ Object

Basic auth username.



26
27
28
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 26

def username
  @username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



84
85
86
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 89

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 68

def self.attribute_map
  {
    :'state' => :'state',
    :'redirect_url' => :'redirectUrl',
    :'redirect_method' => :'redirectMethod',
    :'username' => :'username',
    :'password' => :'password',
    :'redirect_fallback_url' => :'redirectFallbackUrl',
    :'redirect_fallback_method' => :'redirectFallbackMethod',
    :'fallback_username' => :'fallbackUsername',
    :'fallback_password' => :'fallbackPassword',
    :'tag' => :'tag'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 310

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 110

def self.openapi_nullable
  Set.new([
    :'state',
    :'redirect_url',
    :'redirect_method',
    :'username',
    :'password',
    :'redirect_fallback_url',
    :'redirect_fallback_method',
    :'fallback_username',
    :'fallback_password',
    :'tag'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 94

def self.openapi_types
  {
    :'state' => :'CallStateEnum',
    :'redirect_url' => :'String',
    :'redirect_method' => :'RedirectMethodEnum',
    :'username' => :'String',
    :'password' => :'String',
    :'redirect_fallback_url' => :'String',
    :'redirect_fallback_method' => :'RedirectMethodEnum',
    :'fallback_username' => :'String',
    :'fallback_password' => :'String',
    :'tag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 280

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      redirect_url == o.redirect_url &&
      redirect_method == o.redirect_method &&
      username == o.username &&
      password == o.password &&
      redirect_fallback_url == o.redirect_fallback_url &&
      redirect_fallback_method == o.redirect_fallback_method &&
      fallback_username == o.fallback_username &&
      fallback_password == o.fallback_password &&
      tag == o.tag
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 303

def hash
  [state, redirect_url, redirect_method, username, password, redirect_fallback_url, redirect_fallback_method, fallback_username, fallback_password, tag].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 190

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@username.nil? && @username.to_s.length > 1024
    invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 1024.')
  end

  if !@password.nil? && @password.to_s.length > 1024
    invalid_properties.push('invalid value for "password", the character length must be smaller than or equal to 1024.')
  end

  if !@fallback_username.nil? && @fallback_username.to_s.length > 1024
    invalid_properties.push('invalid value for "fallback_username", the character length must be smaller than or equal to 1024.')
  end

  if !@fallback_password.nil? && @fallback_password.to_s.length > 1024
    invalid_properties.push('invalid value for "fallback_password", the character length must be smaller than or equal to 1024.')
  end

  if !@tag.nil? && @tag.to_s.length > 256
    invalid_properties.push('invalid value for "tag", the character length must be smaller than or equal to 256.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 332

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



218
219
220
221
222
223
224
225
226
 
# File 'lib/bandwidth-sdk/models/update_call.rb', line 218

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@username.nil? && @username.to_s.length > 1024
  return false if !@password.nil? && @password.to_s.length > 1024
  return false if !@fallback_username.nil? && @fallback_username.to_s.length > 1024
  return false if !@fallback_password.nil? && @fallback_password.to_s.length > 1024
  return false if !@tag.nil? && @tag.to_s.length > 256
  true
end