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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/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.



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

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:



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

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.



257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 257

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:



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

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:



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

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.



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

def execution_sid
    @properties['execution_sid']
end

#fetch ⇒ ExecutionStepInstance

Fetch the ExecutionStepInstance

Returns:



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

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



360
361
362
363
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 360

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

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.



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

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.



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

def sid
    @properties['sid']
end

#step_context ⇒ step_context

Access the step_context

Returns:



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

def step_context
    context.step_context
end

#to_s ⇒ Object

Provide a user friendly representation



353
354
355
356
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 353

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Studio.V2.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.



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

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.



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

def transitioned_to
    @properties['transitioned_to']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end