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

Parameters:

  • version (Version) —

    Version that contains the resource



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

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.



87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 87

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of InsightsSegmentsInstance



128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 128

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.

Parameters:

  • authorization (String) (defaults to: :unset) —

    The Authorization HTTP request header

  • segment_id (String) (defaults to: :unset) —

    To unique id of the segment

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

    The list of reservation Ids

  • 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



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

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

#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.

Parameters:

  • authorization (String) (defaults to: :unset) —

    The Authorization HTTP request header

  • segment_id (String) (defaults to: :unset) —

    To unique id of the segment

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

    The list of reservation Ids

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 107

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,
    })

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

    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.

Parameters:

  • authorization (String) (defaults to: :unset) —

    The Authorization HTTP request header

  • segment_id (String) (defaults to: :unset) —

    To unique id of the segment

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

    The list of reservation Ids

  • 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



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

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



139
140
141
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 139

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