Class: Twilio::REST::Conversations::V2::ParticipantContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid, sid) ⇒ ParticipantContext

Initialize the ParticipantContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • conversation_sid (String)
  • sid (String) 


349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/twilio-ruby/rest/conversations/v2/participant.rb', line 349

def initialize(version, conversation_sid, sid)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)

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

    
end

Instance Method Details

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/twilio-ruby/rest/conversations/v2/participant.rb', line 363

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ParticipantInstance.new(
        @version,
        payload,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ ParticipantInstance

Fetch the ParticipantInstanceMetadata

Returns:



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/twilio-ruby/rest/conversations/v2/participant.rb', line 383

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    participant_instance = ParticipantInstance.new(
        @version,
        response.body,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
    ParticipantInstanceMetadata.new(
        @version,
        participant_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



466
467
468
469
 
# File 'lib/twilio-ruby/rest/conversations/v2/participant.rb', line 466

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

#to_s ⇒ Object

Provide a user friendly representation



459
460
461
462
 
# File 'lib/twilio-ruby/rest/conversations/v2/participant.rb', line 459

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

#update(update_participant_in_conversation_request: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance

Parameters:

  • update_participant_in_conversation_request (UpdateParticipantInConversationRequest) (defaults to: :unset)

Returns:



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/twilio-ruby/rest/conversations/v2/participant.rb', line 410

def update(update_participant_in_conversation_request: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.update('PUT', @uri, headers: headers, data: update_participant_in_conversation_request.to_json)
    ParticipantInstance.new(
        @version,
        payload,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(update_participant_in_conversation_request: :unset) ⇒ ParticipantInstance

Update the ParticipantInstanceMetadata

Parameters:

  • update_participant_in_conversation_request (UpdateParticipantInConversationRequest) (defaults to: :unset)

Returns:



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/twilio-ruby/rest/conversations/v2/participant.rb', line 432

def update_with_metadata(update_participant_in_conversation_request: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.update_with_metadata('PUT', @uri, headers: headers, data: update_participant_in_conversation_request.to_json)
    participant_instance = ParticipantInstance.new(
        @version,
        response.body,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
    ParticipantInstanceMetadata.new(
        @version,
        participant_instance,
        response.headers,
        response.status_code
    )
end