Class: Twilio::REST::Studio::V1::FlowContext::EngagementContext::StepInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Studio::V1::FlowContext::EngagementContext::StepInstance

Defined in:

lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb

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.

• #engagement_sid ⇒ String

  The SID of the Engagement.

• #fetch ⇒ StepInstance

  Fetch the StepInstance.

• #flow_sid ⇒ String

  The SID of the Flow.

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

  Initialize the StepInstance.

• #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, engagement_sid: nil, sid: nil) ⇒ StepInstance

Initialize the StepInstance

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 217

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'flow_sid' => payload['flow_sid'],
      'engagement_sid' => payload['engagement_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,
      'engagement_sid' => engagement_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 269

def account_sid
  @properties['account_sid']
end

#context ⇒ Hash

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 249

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 311

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 317

def date_updated
  @properties['date_updated']
end

#engagement_sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 281

def engagement_sid
  @properties['engagement_sid']
end

#fetch ⇒ StepInstance

Fetch the StepInstance

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 336

def fetch
  context.fetch
end

#flow_sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 275

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 356

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

#links ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 329

def links
  @properties['links']
end

#name ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 287

def name
  @properties['name']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 263

def sid
  @properties['sid']
end

#step_context ⇒ step_context

Access the step_context

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 343

def step_context
  context.step_context
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 349

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

#transitioned_from ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 299

def transitioned_from
  @properties['transitioned_from']
end

#transitioned_to ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 305

def transitioned_to
  @properties['transitioned_to']
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 323

def url
  @properties['url']
end