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.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 288

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.



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

def 
    @properties['account_sid']
end

#agent_id ⇒ String

Returns The id of the Agent.

Returns:

  • (String) —

    The id of the Agent



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

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



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

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



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

def answer_text
    @properties['answer_text']
end

#assessment ⇒ Hash

Returns Assessment Details associated with an assessment.

Returns:

  • (Hash) —

    Assessment Details associated with an assessment



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

def assessment
    @properties['assessment']
end

#assessment_sid ⇒ String

Returns The SID of the assessment.

Returns:

  • (String) —

    The SID of the assessment



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

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:



318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 318

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



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

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



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

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



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

def report
    @properties['report']
end

#segment_id ⇒ String

Returns Segment Id of conversation.

Returns:

  • (String) —

    Segment Id of conversation



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

def segment_id
    @properties['segment_id']
end

#timestamp ⇒ Float

Returns:

  • (Float) 


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

def timestamp
    @properties['timestamp']
end

#to_s ⇒ Object

Provide a user friendly representation



433
434
435
436
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 433

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, authorization: :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

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

    The Authorization HTTP request header

Returns:



416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 416

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

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

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end

#user_email ⇒ String

Returns The email id of the user.

Returns:

  • (String) —

    The email id of the user.



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

def user_email
    @properties['user_email']
end

#user_name ⇒ String

Returns The name of the user.

Returns:

  • (String) —

    The name of the user.



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

def user_name
    @properties['user_name']
end

#weight ⇒ Float

Returns The weightage given to this comment.

Returns:

  • (Float) —

    The weightage given to this comment



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

def weight
    @properties['weight']
end