Class: Twilio::REST::Conversations::V1::ConversationInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ConversationInstance

Initialize the ConversationInstance



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 426

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_sid'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'unique_name' => payload['unique_name'],
        'attributes' => payload['attributes'],
        'state' => payload['state'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'timers' => payload['timers'],
        'url' => payload['url'],
        'links' => payload['links'],
        'bindings' => payload['bindings'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



465
466
467
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 465

def 
    @properties['account_sid']
end

#attributes ⇒ String 



501
502
503
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 501

def attributes
    @properties['attributes']
end

#bindings ⇒ Hash 



543
544
545
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 543

def bindings
    @properties['bindings']
end

#chat_service_sid ⇒ String 



471
472
473
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 471

def chat_service_sid
    @properties['chat_service_sid']
end

#context ⇒ ConversationContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



456
457
458
459
460
461
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 456

def context
    unless @instance_context
        @instance_context = ConversationContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time 



513
514
515
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 513

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



519
520
521
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 519

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ConversationInstance



551
552
553
554
555
556
557
558
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 551

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance



563
564
565
566
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 563

def fetch

    context.fetch
end

#friendly_name ⇒ String 



489
490
491
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 489

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



644
645
646
647
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 644

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Conversations.V1.ConversationInstance #{values}>"
end

#links ⇒ Hash 



537
538
539
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 537

def links
    @properties['links']
end

#messages ⇒ messages

Access the messages



617
618
619
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 617

def messages
    context.messages
end

#messaging_service_sid ⇒ String 



477
478
479
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 477

def messaging_service_sid
    @properties['messaging_service_sid']
end

#participants ⇒ participants

Access the participants



624
625
626
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 624

def participants
    context.participants
end

#sid ⇒ String 



483
484
485
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 483

def sid
    @properties['sid']
end

#state ⇒ State 



507
508
509
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 507

def state
    @properties['state']
end

#timers ⇒ Hash 



525
526
527
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 525

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



637
638
639
640
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 637

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Conversations.V1.ConversationInstance #{values}>"
end

#unique_name ⇒ String 



495
496
497
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 495

def unique_name
    @properties['unique_name']
end

#update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, bindings_email_address: :unset, bindings_email_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance

Update the ConversationInstance



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 583

def update(
    friendly_name: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    messaging_service_sid: :unset, 
    state: :unset, 
    timers_inactive: :unset, 
    timers_closed: :unset, 
    unique_name: :unset, 
    bindings_email_address: :unset, 
    bindings_email_name: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        friendly_name: friendly_name, 
        date_created: date_created, 
        date_updated: date_updated, 
        attributes: attributes, 
        messaging_service_sid: messaging_service_sid, 
        state: state, 
        timers_inactive: timers_inactive, 
        timers_closed: timers_closed, 
        unique_name: unique_name, 
        bindings_email_address: bindings_email_address, 
        bindings_email_name: bindings_email_name, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String 



531
532
533
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 531

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks



631
632
633
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 631

def webhooks
    context.webhooks
end