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](www.twilio.com/docs/iam/api/account) that created the Step resource.

• #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.

• #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 ⇒ Hash

  The URLs of related resources.

• #name ⇒ String

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

• #sid ⇒ String

  The unique string that we created to identify the Step 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 230

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  || @properties['flow_sid']  ,'engagement_sid' => engagement_sid  || @properties['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 273

def account_sid
    @properties['account_sid']
end

#context ⇒ Hash

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

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 315

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
    @properties['date_updated']
end

#engagement_sid ⇒ String

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

def engagement_sid
    @properties['engagement_sid']
end

#fetch ⇒ StepInstance

Fetch the StepInstance

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

def fetch

    context.fetch
end

#flow_sid ⇒ String

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

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 361

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

#links ⇒ Hash

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

def links
    @properties['links']
end

#name ⇒ String

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

def name
    @properties['name']
end

#sid ⇒ String

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

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 348

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 354

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 303

def transitioned_from
    @properties['transitioned_from']
end

#transitioned_to ⇒ String

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

def transitioned_to
    @properties['transitioned_to']
end

#url ⇒ String

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

def url
    @properties['url']
end