Class: Twilio::REST::Studio::V1::FlowContext::EngagementInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow/engagement.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, flow_sid: nil, sid: nil) ⇒ EngagementInstance

Initialize the EngagementInstance



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 514

def initialize(version, payload , flow_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'flow_sid' => payload['flow_sid'],
        'contact_sid' => payload['contact_sid'],
        'contact_channel_address' => payload['contact_channel_address'],
        'context' => payload['context'],
        'status' => payload['status'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String 



557
558
559
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 557

def 
    @properties['account_sid']
end

#contact_channel_address ⇒ String 



575
576
577
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 575

def contact_channel_address
    @properties['contact_channel_address']
end

#contact_sid ⇒ String 



569
570
571
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 569

def contact_sid
    @properties['contact_sid']
end

#context ⇒ Hash 



542
543
544
545
546
547
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 542

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

#date_created ⇒ Time 



593
594
595
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 593

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



599
600
601
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 599

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the EngagementInstance



618
619
620
621
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 618

def delete

    context.delete
end

#engagement_context ⇒ engagement_context

Access the engagement_context



641
642
643
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 641

def engagement_context
    context.engagement_context
end

#fetch ⇒ EngagementInstance

Fetch the EngagementInstance



626
627
628
629
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 626

def fetch

    context.fetch
end

#flow_sid ⇒ String 



563
564
565
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 563

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



654
655
656
657
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 654

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

#links ⇒ Hash 



611
612
613
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 611

def links
    @properties['links']
end

#sid ⇒ String 



551
552
553
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 551

def sid
    @properties['sid']
end

#status ⇒ Status 



587
588
589
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 587

def status
    @properties['status']
end

#steps ⇒ steps

Access the steps



634
635
636
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 634

def steps
    context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



647
648
649
650
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 647

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

#url ⇒ String 



605
606
607
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 605

def url
    @properties['url']
end