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

  • flow_sid (String) (defaults to: nil)

    The SID of the Flow.

  • sid (String) (defaults to: nil)

    The SID of the Engagement resource to fetch.


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 255

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


297
298
299
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 297

def 
  @properties['account_sid']
end

#contact_channel_addressString

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


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

def contact_channel_address
  @properties['contact_channel_address']
end

#contact_sidString

Returns The SID of the Contact.

Returns:

  • (String)

    The SID of the Contact


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

def contact_sid
  @properties['contact_sid']
end

#contextHash

Returns The current state of the execution flow.

Returns:

  • (Hash)

    The current state of the execution flow


282
283
284
285
286
287
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 282

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

#date_createdTime

Returns The ISO 8601 date and time in GMT when the Engagement was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the Engagement was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the Engagement was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the Engagement was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the EngagementInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#engagement_contextengagement_context

Access the engagement_context

Returns:


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

def engagement_context
  context.engagement_context
end

#fetchEngagementInstance

Fetch the EngagementInstance

Returns:


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

def fetch
  context.fetch
end

#flow_sidString

Returns The SID of the Flow.

Returns:

  • (String)

    The SID of the Flow


303
304
305
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 303

def flow_sid
  @properties['flow_sid']
end

#inspectObject

Provide a detailed, user friendly representation


392
393
394
395
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 392

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

Returns The URLs of the Engagement's nested resources.

Returns:

  • (String)

    The URLs of the Engagement's nested resources


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

def links
  @properties['links']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


291
292
293
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 291

def sid
  @properties['sid']
end

#statusengagement.Status

Returns The status of the Engagement.

Returns:

  • (engagement.Status)

    The status of the Engagement


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

def status
  @properties['status']
end

#stepssteps

Access the steps

Returns:


372
373
374
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 372

def steps
  context.steps
end

#to_sObject

Provide a user friendly representation


385
386
387
388
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 385

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end