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, branded: :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, 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, branded: :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, 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, branded: :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, limit: nil, page_size: nil) ⇒ Enumerable
Streams CallSummariesInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ CallSummariesList
Initialize the CallSummariesList
18 19 20 21 22 23 24 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 18 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.
143 144 145 146 147 148 149 150 151 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 143 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.
214 215 216 217 218 219 220 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 214 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, branded: :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, 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.
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/insights/v1/call_summaries.rb', line 56 def list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :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, 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, branded: branded, 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, 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, branded: :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, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of CallSummariesInstance records from the API. Request is executed immediately.
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 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 179 def page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :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, 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, 'Branded' => branded, '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, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) 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, branded: :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, limit: nil, page_size: nil) ⇒ Enumerable
Streams CallSummariesInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 111 def stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :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, 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, branded: branded, 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, 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
224 225 226 |
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 224 def to_s '#<Twilio.Insights.V1.CallSummariesList>' end |