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

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/insights_segments.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) ⇒ InsightsSegmentsList

Initialize the InsightsSegmentsList

Parameters:

  • version (Version) —

    Version that contains the resource



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 20

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.



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

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



113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 113

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

#list(reservation_id: :unset, token: :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:

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

    The list of reservation Ids

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

    The Token HTTP request header

  • 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



41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 41

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

#page(reservation_id: :unset, token: :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:

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

    The list of reservation Ids

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

    The Token HTTP request header

  • 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



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 94

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

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

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

#stream(reservation_id: :unset, token: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The list of reservation Ids

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

    The Token HTTP request header

  • 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



63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 63

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

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



123
124
125
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 123

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