Class: Twilio::REST::Preview::Studio::FlowContext::EngagementInstance

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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

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

    The unique SID identifier of the Flow.

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

    The sid



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 245

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'],
      'status' => payload['status'],
      'context' => payload['context'],
      '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.



287
288
289
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 287

def 
  @properties['account_sid']
end

#contact_channel_address ⇒ String

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

Returns:

  • (String) —

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



305
306
307
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 305

def contact_channel_address
  @properties['contact_channel_address']
end

#contact_sid ⇒ String

Returns Contact Sid.

Returns:

  • (String) —

    Contact Sid.



299
300
301
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 299

def contact_sid
  @properties['contact_sid']
end

#context ⇒ Hash

Returns Nested resource URLs.

Returns:

  • (Hash) —

    Nested resource URLs.



272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 272

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

Returns:

  • (Time) —

    The date this Engagement was created



323
324
325
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 323

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Engagement was updated.

Returns:

  • (Time) —

    The date this Engagement was updated



329
330
331
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 329

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the EngagementInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ EngagementInstance

Fetch a EngagementInstance

Returns:



348
349
350
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 348

def fetch
  context.fetch
end

#flow_sid ⇒ String

Returns Flow Sid.

Returns:

  • (String) —

    Flow Sid.



293
294
295
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 293

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



341
342
343
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 341

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Engagement.

Returns:

  • (String) —

    A string that uniquely identifies this Engagement.



281
282
283
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 281

def sid
  @properties['sid']
end

#status ⇒ engagement.Status

Returns The Status of this Engagement.

Returns:

  • (engagement.Status) —

    The Status of this Engagement



311
312
313
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 311

def status
  @properties['status']
end

#steps ⇒ steps

Access the steps

Returns:



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

def steps
  context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



335
336
337
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 335

def url
  @properties['url']
end