Class: Twilio::REST::FlexApi::V1::InsightsSegmentsList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ InsightsSegmentsList

Initialize the InsightsSegmentsList



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Insights/Segments"
    
end

Instance Method Details

#each ⇒ Object

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



118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 118

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



162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 162

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

#list(authorization: :unset, segment_id: :unset, reservation_id: :unset, limit: nil, page_size: nil) ⇒ Array

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



49
50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 49

def list(authorization: :unset, segment_id: :unset, reservation_id: :unset, limit: nil, page_size: nil)
    self.stream(
        authorization: authorization,
        segment_id: segment_id,
        reservation_id: reservation_id,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(authorization: :unset, segment_id: :unset, reservation_id: :unset, limit: nil, page_size: nil) ⇒ Array 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 97

def list_with_metadata(authorization: :unset, segment_id: :unset, reservation_id: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Authorization' => authorization,
        'SegmentId' => segment_id,
        
        'ReservationId' =>  Twilio.serialize_list(reservation_id) { |e| e },
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    InsightsSegmentsPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(authorization: :unset, segment_id: :unset, reservation_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 138

def page(authorization: :unset, segment_id: :unset, reservation_id: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'Authorization' => authorization,
        'SegmentId' => segment_id,
        
        'ReservationId' =>  Twilio.serialize_list(reservation_id) { |e| e },
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(authorization: :unset, segment_id: :unset, reservation_id: :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.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 73

def stream(authorization: :unset, segment_id: :unset, reservation_id: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        authorization: authorization,
        segment_id: segment_id,
        reservation_id: reservation_id,
        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



173
174
175
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 173

def to_s
    '#<Twilio.FlexApi.V1.InsightsSegmentsList>'
end