Class: Twilio::REST::FlexApi::V1::InsightsQuestionnairesList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::FlexApi::V1::InsightsQuestionnairesList
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb
Instance Method Summary collapse
-
#create(name: nil, description: :unset, active: :unset, question_sids: :unset, authorization: :unset) ⇒ InsightsQuestionnairesInstance
Create the InsightsQuestionnairesInstance.
-
#each ⇒ Object
When passed a block, yields InsightsQuestionnairesInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of InsightsQuestionnairesInstance records from the API.
-
#initialize(version) ⇒ InsightsQuestionnairesList
constructor
Initialize the InsightsQuestionnairesList.
-
#list(authorization: :unset, include_inactive: :unset, limit: nil, page_size: nil) ⇒ Array
Lists InsightsQuestionnairesInstance records from the API as a list.
-
#page(authorization: :unset, include_inactive: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of InsightsQuestionnairesInstance records from the API.
-
#stream(authorization: :unset, include_inactive: :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) ⇒ InsightsQuestionnairesList
Initialize the InsightsQuestionnairesList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Insights/QualityManagement/Questionnaires" end |
Instance Method Details
#create(name: nil, description: :unset, active: :unset, question_sids: :unset, authorization: :unset) ⇒ InsightsQuestionnairesInstance
Create the InsightsQuestionnairesInstance
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 40 def create( name: nil, description: :unset, active: :unset, question_sids: :unset, authorization: :unset ) data = Twilio::Values.of({ 'Name' => name, 'Description' => description, 'Active' => active, 'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e }, }) headers = Twilio::Values.of({ 'Authorization' => , }) payload = @version.create('POST', @uri, data: data, headers: headers) InsightsQuestionnairesInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields InsightsQuestionnairesInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
114 115 116 117 118 119 120 121 122 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 114 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 InsightsQuestionnairesInstance records from the API. Request is executed immediately.
152 153 154 155 156 157 158 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 152 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) InsightsQuestionnairesPage.new(@version, response, @solution) end |
#list(authorization: :unset, include_inactive: :unset, limit: nil, page_size: nil) ⇒ Array
Lists InsightsQuestionnairesInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
77 78 79 80 81 82 83 84 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 77 def list(authorization: :unset, include_inactive: :unset, limit: nil, page_size: nil) self.stream( authorization: , include_inactive: include_inactive, limit: limit, page_size: page_size ).entries end |
#page(authorization: :unset, include_inactive: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of InsightsQuestionnairesInstance records from the API. Request is executed immediately.
133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 133 def page(authorization: :unset, include_inactive: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Authorization' => , 'IncludeInactive' => include_inactive, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) InsightsQuestionnairesPage.new(@version, response, @solution) end |
#stream(authorization: :unset, include_inactive: :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.
99 100 101 102 103 104 105 106 107 108 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 99 def stream(authorization: :unset, include_inactive: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( authorization: , include_inactive: include_inactive, 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
163 164 165 |
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb', line 163 def to_s '#<Twilio.FlexApi.V1.InsightsQuestionnairesList>' end |