Class: Twilio::REST::Conversations::V1::ConversationContext::ParticipantContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid, sid) ⇒ ParticipantContext

Initialize the ParticipantContext



205
206
207
208
209
210
211
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 205

def initialize(version, conversation_sid, sid)
  super(version)

  # Path Solution
  @solution = {conversation_sid: conversation_sid, sid: sid, }
  @uri = "/Conversations/#{@solution[:conversation_sid]}/Participants/#{@solution[:sid]}"
end

Instance Method Details

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ParticipantInstance



271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 271

def delete(x_twilio_webhook_enabled: :unset)
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

   @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 280

def fetch
  payload = @version.fetch('GET', @uri)

  ParticipantInstance.new(
      @version,
      payload,
      conversation_sid: @solution[:conversation_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



300
301
302
303
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 300

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Conversations.V1.ParticipantContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



293
294
295
296
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 293

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Conversations.V1.ParticipantContext #{context}>"
end

#update(date_created: :unset, date_updated: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, identity: :unset, last_read_message_index: :unset, last_read_timestamp: :unset, x_twilio_webhook_enabled: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 242

def update(date_created: :unset, date_updated: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, identity: :unset, last_read_message_index: :unset, last_read_timestamp: :unset, x_twilio_webhook_enabled: :unset)
  data = Twilio::Values.of({
      'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
      'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
      'Attributes' => attributes,
      'RoleSid' => role_sid,
      'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
      'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
      'Identity' => identity,
      'LastReadMessageIndex' => last_read_message_index,
      'LastReadTimestamp' => last_read_timestamp,
  })
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

  payload = @version.update('POST', @uri, data: data, headers: headers)

  ParticipantInstance.new(
      @version,
      payload,
      conversation_sid: @solution[:conversation_sid],
      sid: @solution[:sid],
  )
end