Class: Twilio::REST::Studio::V1::FlowContext::EngagementInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, flow_sid: nil, sid: nil) ⇒ EngagementInstance

Initialize the EngagementInstance

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 Engagement resource.

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

    The SID of the Call resource to fetch.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 285

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  || @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 Engagement resource.

Returns:



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

def 
    @properties['account_sid']
end

#contact_channel_address ⇒ String

Returns The phone number, SIP address or Client identifier that triggered this Engagement. Phone numbers are in E.164 format (+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 this Engagement. Phone numbers are in E.164 format (+16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.



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

def contact_channel_address
    @properties['contact_channel_address']
end

#contact_sid ⇒ String

Returns The SID of the Contact.

Returns:

  • (String) —

    The SID of the Contact.



339
340
341
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 339

def contact_sid
    @properties['contact_sid']
end

#context ⇒ Hash

Returns The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution.

Returns:

  • (Hash) —

    The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution.



312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 312

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

#date_created ⇒ Time

Returns The date and time in GMT when the Engagement was created in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the Engagement was updated in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the EngagementInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#engagement_context ⇒ engagement_context

Access the engagement_context

Returns:



411
412
413
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 411

def engagement_context
    context.engagement_context
end

#fetch ⇒ EngagementInstance

Fetch the EngagementInstance

Returns:



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

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



424
425
426
427
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 424

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

#links ⇒ Hash

Returns The URLs of the Engagement’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Engagement’s nested resources.



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

def links
    @properties['links']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#steps ⇒ steps

Access the steps

Returns:



404
405
406
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 404

def steps
    context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



417
418
419
420
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 417

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end