Class: Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ InsightsQuestionnairesQuestionList

Initialize the InsightsQuestionnairesQuestionList



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

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

Instance Method Details

#create(category_sid: nil, question: nil, answer_set_id: nil, allow_na: nil, description: :unset, authorization: :unset) ⇒ InsightsQuestionnairesQuestionInstance

Create the InsightsQuestionnairesQuestionInstance



42
43
44
45
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
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 42

def create(
    category_sid: nil, 
    question: nil, 
    answer_set_id: nil, 
    allow_na: nil, 
    description: :unset, 
    authorization: :unset
)

    data = Twilio::Values.of({
        'CategorySid' => category_sid,
        'Question' => question,
        'AnswerSetId' => answer_set_id,
        'AllowNa' => allow_na,
        'Description' => description,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    InsightsQuestionnairesQuestionInstance.new(
        @version,
        payload,
    )
end

#each ⇒ Object

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



123
124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 123

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 InsightsQuestionnairesQuestionInstance records from the API. Request is executed immediately.



165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 165

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

#list(authorization: :unset, category_sid: :unset, limit: nil, page_size: nil) ⇒ Array

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



86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 86

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

#page(authorization: :unset, category_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 142

def page(authorization: :unset, category_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Authorization' => authorization,
        
        'CategorySid' =>  Twilio.serialize_list(category_sid) { |e| e },
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(authorization: :unset, category_sid: :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.



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

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

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



176
177
178
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 176

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