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 SID of the Flow.

  • execution_sid (String) (defaults to: nil)

    The SID of the Step's Execution resource.

  • sid (String) (defaults to: nil)

    The SID of the ExecutionStep resource to fetch.


223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 223

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 SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#contextHash

Returns The current state of the flow.

Returns:

  • (Hash)

    The current state of the flow


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

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 ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#execution_sidString

Returns The SID of the Execution.

Returns:

  • (String)

    The SID of the Execution


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

def execution_sid
  @properties['execution_sid']
end

#fetchExecutionStepInstance

Fetch the ExecutionStepInstance

Returns:


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

def fetch
  context.fetch
end

#flow_sidString

Returns The SID of the Flow.

Returns:

  • (String)

    The SID of the Flow


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

def flow_sid
  @properties['flow_sid']
end

#inspectObject

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#nameString

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


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

def name
  @properties['name']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#step_contextstep_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_sObject

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_fromString

Returns The Widget that preceded the Widget for the Step.

Returns:

  • (String)

    The Widget that preceded the Widget for the Step


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

def transitioned_from
  @properties['transitioned_from']
end

#transitioned_toString

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

Returns:

  • (String)

    The Widget that will follow the Widget for the Step


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

def transitioned_to
  @properties['transitioned_to']
end

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end