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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, call_sid: nil) ⇒ MetricList

Initialize the MetricList



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 27

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

#each ⇒ Object

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



85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 85

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.



126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 126

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.



48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 48

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.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 104

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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



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

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_s ⇒ Object

Provide a user friendly representation



137
138
139
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 137

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