Class: Bandwidth::UpdateConference

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/update_conference.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateConference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
121
122
123
124
125
126
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
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 116

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = '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
end

Instance Attribute Details

#fallback_password ⇒ Object

Basic auth password.



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

def fallback_password
  @fallback_password
end

#fallback_username ⇒ Object

Basic auth username.



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

def fallback_username
  @fallback_username
end

#password ⇒ Object

Basic auth password.



29
30
31
 
# File 'lib/bandwidth-sdk/models/update_conference.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_conference.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 ‘conferenceRedirect` webhook delivery in case `redirectUrl` fails to respond. Not allowed if `state` is `completed`.



32
33
34
 
# File 'lib/bandwidth-sdk/models/update_conference.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_conference.rb', line 23

def redirect_method
  @redirect_method
end

#redirect_url ⇒ Object

The URL to send the [conferenceRedirect](/docs/voice/webhooks/conferenceRedirect) event which will provide new BXML. Not allowed if ‘state` is `completed`, but required if `state` is `active`.



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

def redirect_url
  @redirect_url
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#username ⇒ Object

Basic auth username.



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

def username
  @username
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 302

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Bandwidth.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 65

def self.attribute_map
  {
    :'status' => :'status',
    :'redirect_url' => :'redirectUrl',
    :'redirect_method' => :'redirectMethod',
    :'username' => :'username',
    :'password' => :'password',
    :'redirect_fallback_url' => :'redirectFallbackUrl',
    :'redirect_fallback_method' => :'redirectFallbackMethod',
    :'fallback_username' => :'fallbackUsername',
    :'fallback_password' => :'fallbackPassword'
  }
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 278

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



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 85

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      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
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 373

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


265
266
267
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 271

def hash
  [status, redirect_url, redirect_method, username, password, redirect_fallback_url, redirect_fallback_method, fallback_username, fallback_password].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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 174

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



349
350
351
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 349

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 355

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



343
344
345
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 343

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



198
199
200
201
202
203
204
205
 
# File 'lib/bandwidth-sdk/models/update_conference.rb', line 198

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
  true
end