Class: Twilio::REST::Insights::V1::CallSummariesList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Insights::V1::CallSummariesList
- Defined in:
- lib/twilio-ruby/rest/insights/v1/call_summaries.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields CallSummariesInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of CallSummariesInstance records from the API.
-
#initialize(version) ⇒ CallSummariesList
constructor
Initialize the CallSummariesList.
-
#list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, limit: nil, page_size: nil) ⇒ Array
Lists CallSummariesInstance records from the API as a list.
-
#page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of CallSummariesInstance records from the API.
-
#stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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) ⇒ CallSummariesList
Initialize the CallSummariesList
26 27 28 29 30 31 32 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 26 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Voice/Summaries" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields CallSummariesInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
220 221 222 223 224 225 226 227 228 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 220 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 CallSummariesInstance records from the API. Request is executed immediately.
329 330 331 332 333 334 335 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 329 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) CallSummariesPage.new(@version, response, @solution) end |
#list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, limit: nil, page_size: nil) ⇒ Array
Lists CallSummariesInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 81 def list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, limit: nil, page_size: nil) self.stream( from: from, to: to, from_carrier: from_carrier, to_carrier: to_carrier, from_country_code: from_country_code, to_country_code: to_country_code, verified_caller: verified_caller, has_tag: has_tag, start_time: start_time, end_time: end_time, call_type: call_type, call_state: call_state, direction: direction, processing_state: processing_state, sort_by: sort_by, subaccount: subaccount, abnormal_session: abnormal_session, answered_by: answered_by, answered_by_annotation: answered_by_annotation, connectivity_issue_annotation: connectivity_issue_annotation, quality_issue_annotation: quality_issue_annotation, spam_annotation: spam_annotation, call_score_annotation: call_score_annotation, branded_enabled: branded_enabled, voice_integrity_enabled: voice_integrity_enabled, branded_bundle_sid: branded_bundle_sid, branded_logo: branded_logo, branded_type: branded_type, branded_use_case: branded_use_case, branded_call_reason: branded_call_reason, voice_integrity_bundle_sid: voice_integrity_bundle_sid, voice_integrity_use_case: voice_integrity_use_case, business_profile_identity: business_profile_identity, business_profile_industry: business_profile_industry, business_profile_bundle_sid: business_profile_bundle_sid, business_profile_type: business_profile_type, limit: limit, page_size: page_size ).entries end |
#page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of CallSummariesInstance records from the API. Request is executed immediately.
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 273 def page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'From' => from, 'To' => to, 'FromCarrier' => from_carrier, 'ToCarrier' => to_carrier, 'FromCountryCode' => from_country_code, 'ToCountryCode' => to_country_code, 'VerifiedCaller' => verified_caller, 'HasTag' => has_tag, 'StartTime' => start_time, 'EndTime' => end_time, 'CallType' => call_type, 'CallState' => call_state, 'Direction' => direction, 'ProcessingState' => processing_state, 'SortBy' => sort_by, 'Subaccount' => subaccount, 'AbnormalSession' => abnormal_session, 'AnsweredBy' => answered_by, 'AnsweredByAnnotation' => answered_by_annotation, 'ConnectivityIssueAnnotation' => connectivity_issue_annotation, 'QualityIssueAnnotation' => quality_issue_annotation, 'SpamAnnotation' => spam_annotation, 'CallScoreAnnotation' => call_score_annotation, 'BrandedEnabled' => branded_enabled, 'VoiceIntegrityEnabled' => voice_integrity_enabled, 'BrandedBundleSid' => branded_bundle_sid, 'BrandedLogo' => branded_logo, 'BrandedType' => branded_type, 'BrandedUseCase' => branded_use_case, 'BrandedCallReason' => branded_call_reason, 'VoiceIntegrityBundleSid' => voice_integrity_bundle_sid, 'VoiceIntegrityUseCase' => voice_integrity_use_case, 'BusinessProfileIdentity' => business_profile_identity, 'BusinessProfileIndustry' => business_profile_industry, 'BusinessProfileBundleSid' => business_profile_bundle_sid, 'BusinessProfileType' => business_profile_type, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) headers = Twilio::Values.of({}) response = @version.page('GET', @uri, params: params, headers: headers) CallSummariesPage.new(@version, response, @solution) end |
#stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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.
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 171 def stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( from: from, to: to, from_carrier: from_carrier, to_carrier: to_carrier, from_country_code: from_country_code, to_country_code: to_country_code, verified_caller: verified_caller, has_tag: has_tag, start_time: start_time, end_time: end_time, call_type: call_type, call_state: call_state, direction: direction, processing_state: processing_state, sort_by: sort_by, subaccount: subaccount, abnormal_session: abnormal_session, answered_by: answered_by, answered_by_annotation: answered_by_annotation, connectivity_issue_annotation: connectivity_issue_annotation, quality_issue_annotation: quality_issue_annotation, spam_annotation: spam_annotation, call_score_annotation: call_score_annotation, branded_enabled: branded_enabled, voice_integrity_enabled: voice_integrity_enabled, branded_bundle_sid: branded_bundle_sid, branded_logo: branded_logo, branded_type: branded_type, branded_use_case: branded_use_case, branded_call_reason: branded_call_reason, voice_integrity_bundle_sid: voice_integrity_bundle_sid, voice_integrity_use_case: voice_integrity_use_case, business_profile_identity: business_profile_identity, business_profile_industry: business_profile_industry, business_profile_bundle_sid: business_profile_bundle_sid, business_profile_type: business_profile_type, 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
340 341 342 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 340 def to_s '#<Twilio.Insights.V1.CallSummariesList>' end |