Class: Twilio::REST::FlexApi::V1::AssessmentsList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/assessments.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) ⇒ AssessmentsList

Initialize the AssessmentsList

Parameters:

  • version (Version) —

    Version that contains the resource



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Insights/QM/Assessments"
end

Instance Method Details

#create(category_id: nil, category_name: nil, segment_id: nil, user_name: nil, user_email: nil, agent_id: nil, offset: nil, metric_id: nil, metric_name: nil, answer_text: nil, answer_id: nil, questionnaire_id: nil, token: :unset) ⇒ AssessmentsInstance

Create the AssessmentsInstance

Parameters:

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

    The id of the category

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

    The name of the category

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

    Segment Id of the conversation

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

    Name of the user assessing conversation

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

    Email of the user assessing conversation

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

    The id of the Agent

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

    The offset of the conversation.

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

    The question Id selected for assessment

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

    The question name of the assessment

  • 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

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

    Questionnaire Id of the associated question

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

    The Token HTTP request header

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 44

def create(category_id: nil, category_name: nil, segment_id: nil, user_name: nil, user_email: nil, agent_id: nil, offset: nil, metric_id: nil, metric_name: nil, answer_text: nil, answer_id: nil, questionnaire_id: nil, token: :unset)
  data = Twilio::Values.of({
      'CategoryId' => category_id,
      'CategoryName' => category_name,
      'SegmentId' => segment_id,
      'UserName' => user_name,
      'UserEmail' => user_email,
      'AgentId' => agent_id,
      'Offset' => offset,
      'MetricId' => metric_id,
      'MetricName' => metric_name,
      'AnswerText' => answer_text,
      'AnswerId' => answer_id,
      'QuestionnaireId' => questionnaire_id,
  })
  headers = Twilio::Values.of({'Token' => token, })

  payload = @version.create('POST', @uri, data: data, headers: headers)

  AssessmentsInstance.new(@version, payload, )
end

#each ⇒ Object

When passed a block, yields AssessmentsInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 108

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of AssessmentsInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of AssessmentsInstance



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 146

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  AssessmentsPage.new(@version, response, @solution)
end

#list(segment_id: :unset, token: :unset, limit: nil, page_size: nil) ⇒ Array

Lists AssessmentsInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    The id of the segment.

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

    The Token HTTP request header

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



79
80
81
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 79

def list(segment_id: :unset, token: :unset, limit: nil, page_size: nil)
  self.stream(segment_id: segment_id, token: token, limit: limit, page_size: page_size).entries
end

#page(segment_id: :unset, token: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of AssessmentsInstance records from the API. Request is executed immediately.

Parameters:

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

    The id of the segment.

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

    The Token HTTP request header

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of AssessmentsInstance



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 127

def page(segment_id: :unset, token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'SegmentId' => segment_id,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  headers = Twilio::Values.of({'Token' => token, })

  response = @version.page('GET', @uri, params: params, headers: headers)

  AssessmentsPage.new(@version, response, @solution)
end

#stream(segment_id: :unset, token: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams AssessmentsInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The id of the segment.

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

    The Token HTTP request header

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 96

def stream(segment_id: :unset, token: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(segment_id: segment_id, token: token, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



156
157
158
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 156

def to_s
  '#<Twilio.FlexApi.V1.AssessmentsList>'
end