Class: Twilio::REST::Studio::V2::FlowContext::ExecutionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow/execution.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, sid: nil) ⇒ ExecutionInstance

Initialize the ExecutionInstance

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.

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

    The SID of the Execution resource to fetch.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 309

def initialize(version, payload, flow_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'flow_sid' => payload['flow_sid'],
      'contact_channel_address' => payload['contact_channel_address'],
      'context' => payload['context'],
      'status' => payload['status'],
      '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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#contact_channel_address ⇒ String

Returns The phone number, SIP address or Client identifier that triggered the Execution.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that triggered the Execution



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

def contact_channel_address
  @properties['contact_channel_address']
end

#context ⇒ Hash

Returns The current state of the flow.

Returns:

  • (Hash) —

    The current state of the flow



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

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

#date_created ⇒ Time

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



380
381
382
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 380

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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



386
387
388
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 386

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ExecutionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



412
413
414
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 412

def delete
  context.delete
end

#execution_context ⇒ execution_context

Access the execution_context

Returns:



435
436
437
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 435

def execution_context
  context.execution_context
end

#fetch ⇒ ExecutionInstance

Fetch the ExecutionInstance

Returns:



405
406
407
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 405

def fetch
  context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow



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

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



448
449
450
451
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 448

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs



398
399
400
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 398

def links
  @properties['links']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#status ⇒ execution.Status

Returns The status of the Execution.

Returns:

  • (execution.Status) —

    The status of the Execution



374
375
376
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 374

def status
  @properties['status']
end

#steps ⇒ steps

Access the steps

Returns:



428
429
430
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 428

def steps
  context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



441
442
443
444
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 441

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

#update(status: nil) ⇒ ExecutionInstance

Update the ExecutionInstance

Parameters:

  • status (execution.Status) (defaults to: nil) —

    The status of the Execution. Can only be ‘ended`.

Returns:



421
422
423
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 421

def update(status: nil)
  context.update(status: status, )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



392
393
394
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 392

def url
  @properties['url']
end