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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Studio::V1::FlowContext::ExecutionInstance

Defined in:

lib/twilio-ruby/rest/studio/v1/flow/execution.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #contact_channel_address ⇒ String

  The phone number, SIP address or Client identifier that triggered the Execution.

• #contact_sid ⇒ String

  The SID of the Contact.

• #context ⇒ Hash

  The current state of the Flow’s Execution.

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #delete ⇒ Boolean

  Delete the ExecutionInstance.

• #execution_context ⇒ execution_context

  Access the execution_context.

• #fetch ⇒ ExecutionInstance

  Fetch the ExecutionInstance.

• #flow_sid ⇒ String

  The SID of the Flow.

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

  Initialize the ExecutionInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ Hash

  The URLs of nested resources.

• #sid ⇒ String

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

• #status ⇒ Status
• #steps ⇒ steps

  Access the steps.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(status: nil) ⇒ ExecutionInstance

  Update the ExecutionInstance.

• #url ⇒ String

  The absolute URL of the resource.

Constructor Details

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

Initialize the ExecutionInstance

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

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

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

def account_sid
    @properties['account_sid']
end

#contact_channel_address ⇒ String

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

def contact_channel_address
    @properties['contact_channel_address']
end

#contact_sid ⇒ String

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

def contact_sid
    @properties['contact_sid']
end

#context ⇒ Hash

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

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

#date_created ⇒ Time

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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ExecutionInstance

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

def delete

    context.delete
end

#execution_context ⇒ execution_context

Access the execution_context

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

def execution_context
    context.execution_context
end

#fetch ⇒ ExecutionInstance

Fetch the ExecutionInstance

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

def fetch

    context.fetch
end

#flow_sid ⇒ String

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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#links ⇒ Hash

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

def links
    @properties['links']
end

#sid ⇒ String

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

def sid
    @properties['sid']
end

#status ⇒ Status

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

def status
    @properties['status']
end

#steps ⇒ steps

Access the steps

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

def steps
    context.steps
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#update(status: nil) ⇒ ExecutionInstance

Update the ExecutionInstance

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

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#url ⇒ String

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

def url
    @properties['url']
end