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.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 238

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:



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

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.



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

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:



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

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:



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

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.



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

def execution_sid
    @properties['execution_sid']
end

#fetch ⇒ ExecutionStepInstance

Fetch the ExecutionStepInstance

Returns:



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

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



369
370
371
372
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 369

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.



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

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.



299
300
301
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 299

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.



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

def sid
    @properties['sid']
end

#step_context ⇒ step_context

Access the step_context

Returns:



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

def step_context
    context.step_context
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

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.



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

def transitioned_to
    @properties['transitioned_to']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end