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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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 flow_sid

  • execution_sid (String) (defaults to: nil)

    The execution_sid

  • sid (String) (defaults to: nil)

    The sid



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/twilio-ruby/rest/studio/v2/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,
      'execution_sid' => execution_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid



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

def 
  @properties['account_sid']
end

#contextHash

Returns The context.

Returns:

  • (Hash)

    The context



270
271
272
273
274
275
276
277
278
279
280
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 270

def context
  unless @instance_context
    @instance_context = ExecutionStepContext.new(
        @version,
        @params['flow_sid'],
        @params['execution_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#execution_sidString

Returns The execution_sid.

Returns:

  • (String)

    The execution_sid



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

def execution_sid
  @properties['execution_sid']
end

#fetchExecutionStepInstance

Fetch a ExecutionStepInstance

Returns:



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

def fetch
  context.fetch
end

#flow_sidString

Returns The flow_sid.

Returns:

  • (String)

    The flow_sid



296
297
298
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 296

def flow_sid
  @properties['flow_sid']
end

#inspectObject

Provide a detailed, user friendly representation



377
378
379
380
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 377

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

Returns The links.

Returns:

  • (String)

    The links



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

def links
  @properties['links']
end

#nameString

Returns The name.

Returns:

  • (String)

    The name



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

def name
  @properties['name']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



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

def sid
  @properties['sid']
end

#step_contextstep_context

Access the step_context

Returns:



364
365
366
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 364

def step_context
  context.step_context
end

#to_sObject

Provide a user friendly representation



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

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

#transitioned_fromString

Returns The transitioned_from.

Returns:

  • (String)

    The transitioned_from



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

def transitioned_from
  @properties['transitioned_from']
end

#transitioned_toString

Returns The transitioned_to.

Returns:

  • (String)

    The transitioned_to



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

def transitioned_to
  @properties['transitioned_to']
end

#urlString

Returns The url.

Returns:

  • (String)

    The url



344
345
346
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 344

def url
  @properties['url']
end