Class: Twilio::REST::Studio::V2::FlowContext::ExecutionContext::ExecutionStepInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Studio::V2::FlowContext::ExecutionContext::ExecutionStepInstance

Defined in:

lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #context ⇒ Hash

  The current state of the flow.

• #date_created ⇒ Time

  The ISO 8601 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The ISO 8601 date and time in GMT when the resource was last updated.

• #execution_sid ⇒ String

  The SID of the Execution.

• #fetch ⇒ ExecutionStepInstance

  Fetch a ExecutionStepInstance.

• #flow_sid ⇒ String

  The SID of the Flow.

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

  Initialize the ExecutionStepInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  The URLs of related resources.

• #name ⇒ String

  The event that caused the Flow to transition to the Step.

• #sid ⇒ String

  The unique string that identifies the resource.

• #step_context ⇒ step_context

  Access the step_context.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #transitioned_from ⇒ String

  The Widget that preceded the Widget for the Step.

• #transitioned_to ⇒ String

  The Widget that will follow the Widget for the Step.

• #url ⇒ String

  The absolute URL of the resource.

Constructor Details

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

Initialize the ExecutionStepInstance

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 239

def initialize(version, payload, flow_sid: nil, execution_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'flow_sid' => payload['flow_sid'],
      'execution_sid' => payload['execution_sid'],
      'name' => payload['name'],
      'context' => payload['context'],
      'transitioned_from' => payload['transitioned_from'],
      'transitioned_to' => payload['transitioned_to'],
      '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,
      'execution_sid' => execution_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 291

def account_sid
  @properties['account_sid']
end

#context ⇒ Hash

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 271

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 333

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 339

def date_updated
  @properties['date_updated']
end

#execution_sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 303

def execution_sid
  @properties['execution_sid']
end

#fetch ⇒ ExecutionStepInstance

Fetch a ExecutionStepInstance

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 358

def fetch
  context.fetch
end

#flow_sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 297

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 378

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

#links ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 351

def links
  @properties['links']
end

#name ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 309

def name
  @properties['name']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 285

def sid
  @properties['sid']
end

#step_context ⇒ step_context

Access the step_context

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 365

def step_context
  context.step_context
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 371

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

#transitioned_from ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 321

def transitioned_from
  @properties['transitioned_from']
end

#transitioned_to ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 327

def transitioned_to
  @properties['transitioned_to']
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 345

def url
  @properties['url']
end