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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ExecutionStepInstance

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 ExecutionStep resource.

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

    The SID of the Call resource to fetch.



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 231

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  || @properties['flow_sid']  ,'execution_sid' => execution_sid  || @properties['execution_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 ExecutionStep resource.

Returns:



274
275
276
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 274

def 
    @properties['account_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.



259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 259

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

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

Returns:



316
317
318
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 316

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:



322
323
324
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 322

def date_updated
    @properties['date_updated']
end

#execution_sid ⇒ String

Returns The SID of the Step’s Execution resource.

Returns:

  • (String) —

    The SID of the Step’s Execution resource.



286
287
288
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 286

def execution_sid
    @properties['execution_sid']
end

#fetch ⇒ ExecutionStepInstance

Fetch the ExecutionStepInstance

Returns:



341
342
343
344
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 341

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



280
281
282
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 280

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



334
335
336
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 334

def links
    @properties['links']
end

#name ⇒ String

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

Returns:

  • (String) —

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



292
293
294
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 292

def name
    @properties['name']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



268
269
270
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 268

def sid
    @properties['sid']
end

#step_context ⇒ step_context

Access the step_context

Returns:



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

def step_context
    context.step_context
end

#to_s ⇒ Object

Provide a user friendly representation



355
356
357
358
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 355

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

#transitioned_from ⇒ String

Returns The Widget that preceded the Widget for the Step.

Returns:

  • (String) —

    The Widget that preceded the Widget for the Step.



304
305
306
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 304

def transitioned_from
    @properties['transitioned_from']
end

#transitioned_to ⇒ String

Returns The Widget that will follow the Widget for the Step.

Returns:

  • (String) —

    The Widget that will follow the Widget for the Step.



310
311
312
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 310

def transitioned_to
    @properties['transitioned_to']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



328
329
330
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 328

def url
    @properties['url']
end