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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow/execution.rb

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

  • account_sid (String) —

    The SID of the Account that created this Execution resource.

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

    The SID of the Call resource to fetch.



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 314

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  || @properties['flow_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 Execution resource.

Returns:



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

def 
    @properties['account_sid']
end

#contact_channel_address ⇒ String

Returns The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.



367
368
369
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 367

def contact_channel_address
    @properties['contact_channel_address']
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.



340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 340

def context
    unless @instance_context
        @instance_context = ExecutionContext.new(@version , @params['flow_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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ExecutionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#execution_context ⇒ execution_context

Access the execution_context

Returns:



439
440
441
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 439

def execution_context
    context.execution_context
end

#fetch ⇒ ExecutionInstance

Fetch the ExecutionInstance

Returns:



418
419
420
421
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 418

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



459
460
461
462
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 459

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

#links ⇒ Hash

Returns The URLs of nested resources.

Returns:

  • (Hash) —

    The URLs of nested resources.



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

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that we created to identify the Execution resource.

Returns:

  • (String) —

    The unique string that we created to identify the Execution resource.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#steps ⇒ steps

Access the steps

Returns:



446
447
448
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 446

def steps
    context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



452
453
454
455
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 452

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 (Status) (defaults to: nil)

Returns:



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

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.



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

def url
    @properties['url']
end