Class: Twilio::REST::Insights::V1::CallSummariesList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CallSummariesList

Initialize the CallSummariesList

Parameters:

  • version (Version) —

    Version that contains the resource



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 25

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.



151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 151

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CallSummariesInstance



243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 243

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, answered_by: :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.

Parameters:

  • from (String) (defaults to: :unset)
  • to (String) (defaults to: :unset)
  • from_carrier (String) (defaults to: :unset)
  • to_carrier (String) (defaults to: :unset)
  • from_country_code (String) (defaults to: :unset)
  • to_country_code (String) (defaults to: :unset)
  • branded (Boolean) (defaults to: :unset)
  • verified_caller (Boolean) (defaults to: :unset)
  • has_tag (Boolean) (defaults to: :unset)
  • start_time (String) (defaults to: :unset)
  • end_time (String) (defaults to: :unset)
  • call_type (String) (defaults to: :unset)
  • call_state (String) (defaults to: :unset)
  • direction (String) (defaults to: :unset)
  • processing_state (ProcessingStateRequest) (defaults to: :unset)
  • sort_by (SortBy) (defaults to: :unset)
  • subaccount (String) (defaults to: :unset)
  • abnormal_session (Boolean) (defaults to: :unset)
  • answered_by (AnsweredBy) (defaults to: :unset)
  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 63

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, answered_by: :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,
        answered_by: answered_by,
        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, answered_by: :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.

Parameters:

  • from (String) (defaults to: :unset)
  • to (String) (defaults to: :unset)
  • from_carrier (String) (defaults to: :unset)
  • to_carrier (String) (defaults to: :unset)
  • from_country_code (String) (defaults to: :unset)
  • to_country_code (String) (defaults to: :unset)
  • branded (Boolean) (defaults to: :unset)
  • verified_caller (Boolean) (defaults to: :unset)
  • has_tag (Boolean) (defaults to: :unset)
  • start_time (String) (defaults to: :unset)
  • end_time (String) (defaults to: :unset)
  • call_type (String) (defaults to: :unset)
  • call_state (String) (defaults to: :unset)
  • direction (String) (defaults to: :unset)
  • processing_state (ProcessingStateRequest) (defaults to: :unset)
  • sort_by (SortBy) (defaults to: :unset)
  • subaccount (String) (defaults to: :unset)
  • abnormal_session (Boolean) (defaults to: :unset)
  • answered_by (AnsweredBy) (defaults to: :unset)
  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of CallSummariesInstance



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 187

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, answered_by: :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,
        
        'AnsweredBy' => answered_by,
        
        '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, answered_by: :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.

Parameters:

  • from (String) (defaults to: :unset)
  • to (String) (defaults to: :unset)
  • from_carrier (String) (defaults to: :unset)
  • to_carrier (String) (defaults to: :unset)
  • from_country_code (String) (defaults to: :unset)
  • to_country_code (String) (defaults to: :unset)
  • branded (Boolean) (defaults to: :unset)
  • verified_caller (Boolean) (defaults to: :unset)
  • has_tag (Boolean) (defaults to: :unset)
  • start_time (String) (defaults to: :unset)
  • end_time (String) (defaults to: :unset)
  • call_type (String) (defaults to: :unset)
  • call_state (String) (defaults to: :unset)
  • direction (String) (defaults to: :unset)
  • processing_state (ProcessingStateRequest) (defaults to: :unset)
  • sort_by (SortBy) (defaults to: :unset)
  • subaccount (String) (defaults to: :unset)
  • abnormal_session (Boolean) (defaults to: :unset)
  • answered_by (AnsweredBy) (defaults to: :unset)
  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 119

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, answered_by: :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,
        answered_by: answered_by,
        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



254
255
256
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 254

def to_s
    '#<Twilio.Insights.V1.CallSummariesList>'
end