Class: Twilio::REST::Studio::V1::FlowContext::ExecutionInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ExecutionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Execution resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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/studio/v1/flow/execution.rb', line 590

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

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Execution resource.

Returns:



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

def 
    @properties['account_sid']
end

#contact_channel_address ⇒ String

Returns The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted client:name.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted client:name.



651
652
653
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 651

def contact_channel_address
    @properties['contact_channel_address']
end

#contact_sid ⇒ String

Returns The SID of the Contact.

Returns:

  • (String) —

    The SID of the Contact.



645
646
647
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 645

def contact_sid
    @properties['contact_sid']
end

#context ⇒ Hash

Returns The current state of the Flow’s Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.

Returns:

  • (Hash) —

    The current state of the Flow’s Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.



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

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



669
670
671
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 669

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



675
676
677
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 675

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ExecutionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



694
695
696
697
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 694

def delete

    context.delete
end

#execution_context ⇒ execution_context

Access the execution_context

Returns:



723
724
725
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 723

def execution_context
    context.execution_context
end

#fetch ⇒ ExecutionInstance

Fetch the ExecutionInstance

Returns:



702
703
704
705
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 702

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



639
640
641
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 639

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



743
744
745
746
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 743

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

#links ⇒ Hash

Returns The URLs of nested resources.

Returns:

  • (Hash) —

    The URLs of nested resources.



687
688
689
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 687

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that we created to identify the Execution resource.

Returns:

  • (String) —

    The unique string that we created to identify the Execution resource.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


663
664
665
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 663

def status
    @properties['status']
end

#steps ⇒ steps

Access the steps

Returns:



730
731
732
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 730

def steps
    context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



736
737
738
739
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 736

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

#update(status: nil) ⇒ ExecutionInstance

Update the ExecutionInstance

Parameters:

  • status (Status) (defaults to: nil)

Returns:



711
712
713
714
715
716
717
718
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 711

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



681
682
683
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 681

def url
    @properties['url']
end