Class: Twilio::REST::Insights::V1::CallContext::MetricList

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, call_sid: nil) ⇒ MetricList

Initialize the MetricList

Parameters:

  • version (Version)

    Version that contains the resource

  • call_sid (String) (defaults to: nil)

    The call_sid


22
23
24
25
26
27
28
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 22

def initialize(version, call_sid: nil)
  super(version)

  # Path Solution
  @solution = {call_sid: call_sid}
  @uri = "/Voice/#{@solution[:call_sid]}/Metrics"
end

Instance Method Details

#eachObject

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


72
73
74
75
76
77
78
79
80
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 72

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 MetricInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of MetricInstance


110
111
112
113
114
115
116
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 110

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  MetricPage.new(@version, response, @solution)
end

#list(edge: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Array

Lists MetricInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • edge (metric.TwilioEdge) (defaults to: :unset)

    The edge

  • direction (metric.StreamDirection) (defaults to: :unset)

    The direction

  • 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


43
44
45
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 43

def list(edge: :unset, direction: :unset, limit: nil, page_size: nil)
  self.stream(edge: edge, direction: direction, limit: limit, page_size: page_size).entries
end

#page(edge: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of MetricInstance records from the API. Request is executed immediately.

Parameters:

  • edge (metric.TwilioEdge) (defaults to: :unset)

    The edge

  • direction (metric.StreamDirection) (defaults to: :unset)

    The direction

  • 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 MetricInstance


91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 91

def page(edge: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Edge' => edge,
      'Direction' => direction,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  MetricPage.new(@version, response, @solution)
end

#stream(edge: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams MetricInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • edge (metric.TwilioEdge) (defaults to: :unset)

    The edge

  • direction (metric.StreamDirection) (defaults to: :unset)

    The direction

  • 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


60
61
62
63
64
65
66
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 60

def stream(edge: :unset, direction: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(edge: edge, direction: direction, page_size: limits[:page_size], )

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

#to_sObject

Provide a user friendly representation


120
121
122
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 120

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