Class: Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionList
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb
Instance Method Summary collapse
-
#create(category_sid: nil, question: nil, answer_set_id: nil, allow_na: nil, description: :unset, authorization: :unset) ⇒ InsightsQuestionnairesQuestionInstance
Create the InsightsQuestionnairesQuestionInstance.
-
#each ⇒ Object
When passed a block, yields InsightsQuestionnairesQuestionInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of InsightsQuestionnairesQuestionInstance records from the API.
-
#initialize(version) ⇒ InsightsQuestionnairesQuestionList
constructor
Initialize the InsightsQuestionnairesQuestionList.
-
#list(authorization: :unset, category_sid: :unset, limit: nil, page_size: nil) ⇒ Array
Lists InsightsQuestionnairesQuestionInstance records from the API as a list.
-
#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.
-
#stream(authorization: :unset, category_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ InsightsQuestionnairesQuestionList
Initialize the InsightsQuestionnairesQuestionList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 25 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
41 42 43 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/insights_questionnaires_question.rb', line 41 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({ '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.
117 118 119 120 121 122 123 124 125 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 117 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.
156 157 158 159 160 161 162 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 156 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.
80 81 82 83 84 85 86 87 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 80 def list(authorization: :unset, category_sid: :unset, limit: nil, page_size: nil) self.stream( 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.
136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 136 def page(authorization: :unset, category_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Authorization' => , 'CategorySid' => Twilio.serialize_list(category_sid) { |e| e }, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) 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.
102 103 104 105 106 107 108 109 110 111 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 102 def stream(authorization: :unset, category_sid: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( 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
167 168 169 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb', line 167 def to_s '#<Twilio.FlexApi.V1.InsightsQuestionnairesQuestionList>' end |