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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 260

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 



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

def 
  @properties['account_sid']
end

#contact_channel_address ⇒ String 



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

def contact_channel_address
  @properties['contact_channel_address']
end

#contact_sid ⇒ String 



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

def contact_sid
  @properties['contact_sid']
end

#context ⇒ Hash 



287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 287

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the EngagementInstance



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

def delete
  context.delete
end

#engagement_context ⇒ engagement_context

Access the engagement_context



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

def engagement_context
  context.engagement_context
end

#fetch ⇒ EngagementInstance

Fetch a EngagementInstance



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

def fetch
  context.fetch
end

#flow_sid ⇒ String 



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

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#status ⇒ engagement.Status 



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

def status
  @properties['status']
end

#steps ⇒ steps

Access the steps



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

def steps
  context.steps
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String 



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

def url
  @properties['url']
end