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

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AssessmentsList

Initialize the AssessmentsList

Parameters:

  • version (Version) —

    Version that contains the resource



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 25

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/Insights/QualityManagement/Assessments"
    
end

Instance Method Details

#create(category_sid: nil, category_name: nil, segment_id: nil, agent_id: nil, offset: nil, metric_id: nil, metric_name: nil, answer_text: nil, answer_id: nil, questionnaire_sid: nil, authorization: :unset) ⇒ AssessmentsInstance

Create the AssessmentsInstance

Parameters:

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

    The SID 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

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

    The id of the Agent

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

    The offset of the conversation.

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

    The question SID 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_sid (String) (defaults to: nil) —

    Questionnaire SID of the associated question

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

    The Authorization HTTP request header

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 46

def create(
    category_sid: nil, 
    category_name: nil, 
    segment_id: nil, 
    agent_id: nil, 
    offset: nil, 
    metric_id: nil, 
    metric_name: nil, 
    answer_text: nil, 
    answer_id: nil, 
    questionnaire_sid: nil, 
    authorization: :unset
)

    data = Twilio::Values.of({
        'CategorySid' => category_sid,
        'CategoryName' => category_name,
        'SegmentId' => segment_id,
        'AgentId' => agent_id,
        'Offset' => offset,
        'MetricId' => metric_id,
        'MetricName' => metric_name,
        'AnswerText' => answer_text,
        'AnswerId' => answer_id,
        'QuestionnaireSid' => questionnaire_sid,
    })

    headers = Twilio::Values.of({ 'Authorization' => authorization, })
    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.



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

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



170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 170

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

#list(authorization: :unset, segment_id: :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:

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

    The Authorization HTTP request header

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

    The id of the segment.

  • 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



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

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

#page(authorization: :unset, segment_id: :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:

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

    The Authorization HTTP request header

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

    The id of the segment.

  • 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



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 151

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

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

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

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

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

Parameters:

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

    The Authorization HTTP request header

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

    The id of the segment.

  • 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



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 117

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

    page = self.page(
        authorization: authorization,
        segment_id: segment_id,
        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



181
182
183
 
# File 'lib/twilio-ruby/rest/flex_api/v1/assessments.rb', line 181

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