Class: Bandwidth::Conference

Inherits:
ApiModelBase 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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Conference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
158
159
160
161
162
163
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 114

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
  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::Conference`. 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?(:'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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 83

def self.acceptable_attributes
  acceptable_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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 210

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



102
103
104
105
106
107
108
109
110
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 88

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



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 182

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 203

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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 232

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



175
176
177
178
 
# File 'lib/bandwidth-sdk/models/conference.rb', line 175

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