Class: Twilio::REST::FlexApi::V1::AssessmentsInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/assessments.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assessment_sid: nil) ⇒ AssessmentsInstance

Initialize the AssessmentsInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 296

def initialize(version, payload , assessment_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'assessment_sid' => payload['assessment_sid'],
        'offset' => payload['offset'],
        'report' => payload['report'],
        'weight' => payload['weight'],
        'agent_id' => payload['agent_id'],
        'segment_id' => payload['segment_id'],
        'user_name' => payload['user_name'],
        'user_email' => payload['user_email'],
        'answer_text' => payload['answer_text'],
        'answer_id' => payload['answer_id'],
        'assessment' => payload['assessment'],
        'timestamp' => payload['timestamp'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'assessment_sid' => assessment_sid  || @properties['assessment_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



335
336
337
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 335

def 
    @properties['account_sid']
end

#agent_id ⇒ String

Returns The id of the Agent.

Returns:

  • (String) —

    The id of the Agent



365
366
367
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 365

def agent_id
    @properties['agent_id']
end

#answer_id ⇒ String

Returns The id of the answer selected by user.

Returns:

  • (String) —

    The id of the answer selected by user



395
396
397
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 395

def answer_id
    @properties['answer_id']
end

#answer_text ⇒ String

Returns The answer text selected by user.

Returns:

  • (String) —

    The answer text selected by user



389
390
391
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 389

def answer_text
    @properties['answer_text']
end

#assessment ⇒ Hash

Returns Assessment Details associated with an assessment.

Returns:

  • (Hash) —

    Assessment Details associated with an assessment



401
402
403
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 401

def assessment
    @properties['assessment']
end

#assessment_sid ⇒ String

Returns The SID of the assessment.

Returns:

  • (String) —

    The SID of the assessment



341
342
343
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 341

def assessment_sid
    @properties['assessment_sid']
end

#context ⇒ AssessmentsContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



326
327
328
329
330
331
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 326

def context
    unless @instance_context
        @instance_context = AssessmentsContext.new(@version , @params['assessment_sid'])
    end
    @instance_context
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



448
449
450
451
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 448

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

#offset ⇒ Float

Returns Offset of the conversation.

Returns:

  • (Float) —

    Offset of the conversation



347
348
349
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 347

def offset
    @properties['offset']
end

#report ⇒ Boolean

Returns The flag indicating if this assessment is part of report.

Returns:

  • (Boolean) —

    The flag indicating if this assessment is part of report



353
354
355
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 353

def report
    @properties['report']
end

#segment_id ⇒ String

Returns Segment Id of conversation.

Returns:

  • (String) —

    Segment Id of conversation



371
372
373
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 371

def segment_id
    @properties['segment_id']
end

#timestamp ⇒ Float

Returns:

  • (Float) 


407
408
409
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 407

def timestamp
    @properties['timestamp']
end

#to_s ⇒ Object

Provide a user friendly representation



441
442
443
444
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 441

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

#update(offset: nil, answer_text: nil, answer_id: nil, token: :unset) ⇒ AssessmentsInstance

Update the AssessmentsInstance

Parameters:

  • offset (Float) (defaults to: nil) —

    The offset of the conversation

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

    The answer text selected by user

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

    The id of the answer selected by user

  • token (String) (defaults to: :unset) —

    The Token HTTP request header

Returns:



424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 424

def update(
    offset: nil, 
    answer_text: nil, 
    answer_id: nil, 
    token: :unset
)

    context.update(
        offset: offset, 
        answer_text: answer_text, 
        answer_id: answer_id, 
        token: token, 
    )
end

#url ⇒ String

Returns:

  • (String) 


413
414
415
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 413

def url
    @properties['url']
end

#user_email ⇒ String

Returns The email id of the user.

Returns:

  • (String) —

    The email id of the user.



383
384
385
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 383

def user_email
    @properties['user_email']
end

#user_name ⇒ String

Returns The name of the user.

Returns:

  • (String) —

    The name of the user.



377
378
379
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 377

def user_name
    @properties['user_name']
end

#weight ⇒ Float

Returns The weightage given to this comment.

Returns:

  • (Float) —

    The weightage given to this comment



359
360
361
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 359

def weight
    @properties['weight']
end