Class: Twilio::REST::Studio::V1::FlowContext::ExecutionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/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 unique SID identifier of the Flow.

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

    The unique SID identifier of the Execution.



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 272

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_sid' => payload['contact_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 Account Sid.

Returns:

  • (String) —

    Account Sid.



314
315
316
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 314

def 
  @properties['account_sid']
end

#contact_channel_address ⇒ String

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

Returns:

  • (String) —

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



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

def contact_channel_address
  @properties['contact_channel_address']
end

#contact_sid ⇒ String

Returns Contact Sid.

Returns:

  • (String) —

    Contact Sid.



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

def contact_sid
  @properties['contact_sid']
end

#context ⇒ Hash

Returns The context.

Returns:

  • (Hash) —

    The context



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

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

Returns:

  • (Time) —

    The date this Execution was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Execution was updated.

Returns:

  • (Time) —

    The date this Execution was updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ExecutionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



382
383
384
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 382

def delete
  context.delete
end

#execution_context ⇒ execution_context

Access the execution_context

Returns:



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

def execution_context
  context.execution_context
end

#fetch ⇒ ExecutionInstance

Fetch a ExecutionInstance

Returns:



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

def fetch
  context.fetch
end

#flow_sid ⇒ String

Returns Flow Sid.

Returns:

  • (String) —

    Flow Sid.



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

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



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

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Execution.

Returns:

  • (String) —

    A string that uniquely identifies this Execution.



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

def sid
  @properties['sid']
end

#status ⇒ execution.Status

Returns The Status of this Execution.

Returns:

  • (execution.Status) —

    The Status of this Execution



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

def status
  @properties['status']
end

#steps ⇒ steps

Access the steps

Returns:



389
390
391
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 389

def steps
  context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end