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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ConversationInstance



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 415

def initialize(version, payload , chat_service_sid: nil, 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 = { 'chat_service_sid' => chat_service_sid  || @properties['chat_service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



454
455
456
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 454

def 
    @properties['account_sid']
end

#attributes ⇒ String 



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

def attributes
    @properties['attributes']
end

#bindings ⇒ Hash 



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

def bindings
    @properties['bindings']
end

#chat_service_sid ⇒ String 



460
461
462
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 460

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



445
446
447
448
449
450
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 445

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ConversationInstance



540
541
542
543
544
545
546
547
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 540

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



633
634
635
636
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 633

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#messages ⇒ messages

Access the messages



613
614
615
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 613

def messages
    context.messages
end

#messaging_service_sid ⇒ String 



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

def messaging_service_sid
    @properties['messaging_service_sid']
end

#participants ⇒ participants

Access the participants



606
607
608
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 606

def participants
    context.participants
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#state ⇒ State 



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

def state
    @properties['state']
end

#timers ⇒ Hash 



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

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



626
627
628
629
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 626

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

#unique_name ⇒ String 



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

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



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 572

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 



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

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks



620
621
622
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 620

def webhooks
    context.webhooks
end