Class: Bandwidth::ConferenceMember

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConferenceMember

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
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
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 74

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

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

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

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

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

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

Instance Attribute Details

#call_id ⇒ Object

The call id associated with the event.



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

def call_id
  @call_id
end

#call_ids_to_coach ⇒ Object

If this member had a value set for ‘callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join.



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

def call_ids_to_coach
  @call_ids_to_coach
end

#conference_id ⇒ Object

The unique, Bandwidth-generated ID of the conference that was recorded



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

def conference_id
  @conference_id
end

#hold ⇒ Object

Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member’s hold status. Has no effect if omitted.



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

def hold
  @hold
end

#member_url ⇒ Object

A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member’s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.



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

def member_url
  @member_url
end

#mute ⇒ Object

Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member’s mute status. Has no effect if omitted.



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

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



181
182
183
184
185
186
187
188
189
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
215
216
217
218
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 181

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_any_of) || 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



49
50
51
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 37

def self.attribute_map
  {
    :'call_id' => :'callId',
    :'conference_id' => :'conferenceId',
    :'member_url' => :'memberUrl',
    :'mute' => :'mute',
    :'hold' => :'hold',
    :'call_ids_to_coach' => :'callIdsToCoach'
  }
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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 157

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



66
67
68
69
70
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 66

def self.openapi_nullable
  Set.new([
    :'call_ids_to_coach'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 54

def self.openapi_types
  {
    :'call_id' => :'String',
    :'conference_id' => :'String',
    :'member_url' => :'String',
    :'mute' => :'Boolean',
    :'hold' => :'Boolean',
    :'call_ids_to_coach' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      call_id == o.call_id &&
      conference_id == o.conference_id &&
      member_url == o.member_url &&
      mute == o.mute &&
      hold == o.hold &&
      call_ids_to_coach == o.call_ids_to_coach
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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 252

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


144
145
146
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 144

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



150
151
152
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 150

def hash
  [call_id, conference_id, member_url, mute, hold, call_ids_to_coach].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



116
117
118
119
120
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 116

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



228
229
230
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 228

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



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

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



222
223
224
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 222

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



124
125
126
127
 
# File 'lib/bandwidth-sdk/models/conference_member.rb', line 124

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