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


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

#eachObject

When passed a block, yields CallSummariesInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


139
140
141
142
143
144
145
146
147
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 139

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


208
209
210
211
212
213
214
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 208

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, 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 (Array[String]) (defaults to: :unset)

    The from

  • to (Array[String]) (defaults to: :unset)

    The to

  • from_carrier (Array[String]) (defaults to: :unset)

    The from_carrier

  • to_carrier (Array[String]) (defaults to: :unset)

    The to_carrier

  • from_country_code (Array[String]) (defaults to: :unset)

    The from_country_code

  • to_country_code (Array[String]) (defaults to: :unset)

    The to_country_code

  • branded (Boolean) (defaults to: :unset)

    The branded

  • verified_caller (Boolean) (defaults to: :unset)

    The verified_caller

  • has_tag (Boolean) (defaults to: :unset)

    The has_tag

  • start_time (String) (defaults to: :unset)

    The start_time

  • end_time (String) (defaults to: :unset)

    The end_time

  • call_type (Array[String]) (defaults to: :unset)

    The call_type

  • call_state (Array[String]) (defaults to: :unset)

    The call_state

  • direction (call_summaries.CallDirection) (defaults to: :unset)

    The direction

  • processing_state (call_summaries.ProcessingStateRequest) (defaults to: :unset)

    The processing_state

  • sort_by (call_summaries.SortBy) (defaults to: :unset)

    The sort_by

  • subaccount (String) (defaults to: :unset)

    The subaccount

  • 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


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 55

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, 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,
      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, 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 (Array[String]) (defaults to: :unset)

    The from

  • to (Array[String]) (defaults to: :unset)

    The to

  • from_carrier (Array[String]) (defaults to: :unset)

    The from_carrier

  • to_carrier (Array[String]) (defaults to: :unset)

    The to_carrier

  • from_country_code (Array[String]) (defaults to: :unset)

    The from_country_code

  • to_country_code (Array[String]) (defaults to: :unset)

    The to_country_code

  • branded (Boolean) (defaults to: :unset)

    The branded

  • verified_caller (Boolean) (defaults to: :unset)

    The verified_caller

  • has_tag (Boolean) (defaults to: :unset)

    The has_tag

  • start_time (String) (defaults to: :unset)

    The start_time

  • end_time (String) (defaults to: :unset)

    The end_time

  • call_type (Array[String]) (defaults to: :unset)

    The call_type

  • call_state (Array[String]) (defaults to: :unset)

    The call_state

  • direction (call_summaries.CallDirection) (defaults to: :unset)

    The direction

  • processing_state (call_summaries.ProcessingStateRequest) (defaults to: :unset)

    The processing_state

  • sort_by (call_summaries.SortBy) (defaults to: :unset)

    The sort_by

  • subaccount (String) (defaults to: :unset)

    The subaccount

  • 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


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
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 174

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, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'From' => Twilio.serialize_list(from) { |e| e },
      'To' => Twilio.serialize_list(to) { |e| e },
      'FromCarrier' => Twilio.serialize_list(from_carrier) { |e| e },
      'ToCarrier' => Twilio.serialize_list(to_carrier) { |e| e },
      'FromCountryCode' => Twilio.serialize_list(from_country_code) { |e| e },
      'ToCountryCode' => Twilio.serialize_list(to_country_code) { |e| e },
      'Branded' => branded,
      'VerifiedCaller' => verified_caller,
      'HasTag' => has_tag,
      'StartTime' => start_time,
      'EndTime' => end_time,
      'CallType' => Twilio.serialize_list(call_type) { |e| e },
      'CallState' => Twilio.serialize_list(call_state) { |e| e },
      'Direction' => direction,
      'ProcessingState' => processing_state,
      'SortBy' => sort_by,
      'Subaccount' => subaccount,
      '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, 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.

Parameters:

  • from (Array[String]) (defaults to: :unset)

    The from

  • to (Array[String]) (defaults to: :unset)

    The to

  • from_carrier (Array[String]) (defaults to: :unset)

    The from_carrier

  • to_carrier (Array[String]) (defaults to: :unset)

    The to_carrier

  • from_country_code (Array[String]) (defaults to: :unset)

    The from_country_code

  • to_country_code (Array[String]) (defaults to: :unset)

    The to_country_code

  • branded (Boolean) (defaults to: :unset)

    The branded

  • verified_caller (Boolean) (defaults to: :unset)

    The verified_caller

  • has_tag (Boolean) (defaults to: :unset)

    The has_tag

  • start_time (String) (defaults to: :unset)

    The start_time

  • end_time (String) (defaults to: :unset)

    The end_time

  • call_type (Array[String]) (defaults to: :unset)

    The call_type

  • call_state (Array[String]) (defaults to: :unset)

    The call_state

  • direction (call_summaries.CallDirection) (defaults to: :unset)

    The direction

  • processing_state (call_summaries.ProcessingStateRequest) (defaults to: :unset)

    The processing_state

  • sort_by (call_summaries.SortBy) (defaults to: :unset)

    The sort_by

  • subaccount (String) (defaults to: :unset)

    The subaccount

  • 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


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 108

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, 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,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


218
219
220
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 218

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