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

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

    The unique SID identifier of the Flow.

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

    The unique SID identifier of the Execution.

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

    The unique SID identifier of the Step.



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

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,
      'execution_sid' => execution_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



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

def 
  @properties['account_sid']
end

#context ⇒ Hash

Returns The context.

Returns:

  • (Hash) —

    The context



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

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 this Step was created.

Returns:

  • (Time) —

    The date this Step was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Step was updated.

Returns:

  • (Time) —

    The date this Step was updated



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

def date_updated
  @properties['date_updated']
end

#execution_sid ⇒ String

Returns Execution Sid.

Returns:

  • (String) —

    Execution Sid.



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

def execution_sid
  @properties['execution_sid']
end

#fetch ⇒ ExecutionStepInstance

Fetch a ExecutionStepInstance

Returns:



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

def fetch
  context.fetch
end

#flow_sid ⇒ String

Returns Flow Sid.

Returns:

  • (String) —

    Flow Sid.



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

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 ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#name ⇒ String

Returns The event that caused the flow to transition to this Step.

Returns:

  • (String) —

    The event that caused the flow to transition to this Step.



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

def name
  @properties['name']
end

#sid ⇒ String

Returns A string that uniquely identifies this Step.

Returns:

  • (String) —

    A string that uniquely identifies this Step.



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

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 this Step.

Returns:

  • (String) —

    The Widget that preceded the Widget for this Step.



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

def transitioned_from
  @properties['transitioned_from']
end

#transitioned_to ⇒ String

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

Returns:

  • (String) —

    The Widget that will follow the Widget for this Step.



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

def transitioned_to
  @properties['transitioned_to']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end