Class: Bandwidth::Conference

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Conference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
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
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::Conference` 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::Conference`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

  if attributes.key?(:'active_members')
    if (value = attributes[:'active_members']).is_a?(Array)
      self.active_members = value
    end
  end
end

Instance Attribute Details

#active_members ⇒ Object

A list of active members of the conference. Omitted if this is a response to the [Get Conferences endpoint](/apis/voice#tag/Conferences/operation/listConferences).



39
40
41
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 39

def active_members
  @active_members
end

#completed_time ⇒ Object

The time the conference was terminated, in ISO 8601 format.



28
29
30
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 28

def completed_time
  @completed_time
end

#conference_event_method ⇒ Object

Returns the value of attribute conference_event_method.



33
34
35
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 33

def conference_event_method
  @conference_event_method
end

#conference_event_url ⇒ Object

The URL to send the conference-related events.



31
32
33
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 31

def conference_event_url
  @conference_event_url
end

#created_time ⇒ Object

The time the conference was initiated, in ISO 8601 format.



25
26
27
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 25

def created_time
  @created_time
end

#id ⇒ Object

The Bandwidth-generated conference ID.



19
20
21
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 19

def id
  @id
end

#name ⇒ Object

The name of the conference, as specified by your application.



22
23
24
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 22

def name
  @name
end

#tag ⇒ Object

The custom string attached to the conference that will be sent with callbacks.



36
37
38
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 36

def tag
  @tag
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 228

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



78
79
80
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'created_time' => :'createdTime',
    :'completed_time' => :'completedTime',
    :'conference_event_url' => :'conferenceEventUrl',
    :'conference_event_method' => :'conferenceEventMethod',
    :'tag' => :'tag',
    :'active_members' => :'activeMembers'
  }
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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 204

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



97
98
99
100
101
102
103
104
105
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 97

def self.openapi_nullable
  Set.new([
    :'completed_time',
    :'conference_event_url',
    :'conference_event_method',
    :'tag',
    :'active_members'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 83

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'created_time' => :'Time',
    :'completed_time' => :'Time',
    :'conference_event_url' => :'String',
    :'conference_event_method' => :'CallbackMethodEnum',
    :'tag' => :'String',
    :'active_members' => :'Array<ConferenceMember>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      created_time == o.created_time &&
      completed_time == o.completed_time &&
      conference_event_url == o.conference_event_url &&
      conference_event_method == o.conference_event_method &&
      tag == o.tag &&
      active_members == o.active_members
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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 299

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


191
192
193
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



197
198
199
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 197

def hash
  [id, name, created_time, completed_time, conference_event_url, conference_event_method, tag, active_members].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



161
162
163
164
165
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 161

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



275
276
277
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 275

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



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

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



269
270
271
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 269

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



169
170
171
172
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 169

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end