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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 240

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.



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

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.



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

def contact_channel_address
  @properties['contact_channel_address']
end

#contact_sid ⇒ String

Returns Contact Sid.

Returns:

  • (String) —

    Contact Sid.



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

def contact_sid
  @properties['contact_sid']
end

#context ⇒ Hash

Returns Nested resource URLs.

Returns:

  • (Hash) —

    Nested resource URLs.



267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 267

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



318
319
320
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 318

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



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ EngagementInstance

Fetch a EngagementInstance

Returns:



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

def fetch
  context.fetch
end

#flow_sid ⇒ String

Returns Flow Sid.

Returns:

  • (String) —

    Flow Sid.



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

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Engagement.

Returns:

  • (String) —

    A string that uniquely identifies this Engagement.



276
277
278
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement.rb', line 276

def sid
  @properties['sid']
end

#status ⇒ engagement.Status

Returns The Status of this Engagement.

Returns:

  • (engagement.Status) —

    The Status of this Engagement



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

def status
  @properties['status']
end

#steps ⇒ steps

Access the steps

Returns:



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

def steps
  context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def url
  @properties['url']
end