class Twilio::REST::Preview::Sync::ServiceContext::SyncListList
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 help@twilio.com.
Public Class Methods
Initialize the SyncListList
@param [Version] version Version
that contains the resource @param [String] service_sid The service_sid @return [SyncListList] SyncListList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 22 def initialize(version, service_sid: nil) 23 super(version) 24 25 # Path Solution 26 @solution = {service_sid: service_sid} 27 @uri = "/Services/#{@solution[:service_sid]}/Lists" 28 end
Public Instance Methods
Create the SyncListInstance
@param [String] unique_name The unique_name @return [SyncListInstance] Created SyncListInstance
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 34 def create(unique_name: :unset) 35 data = Twilio::Values.of({'UniqueName' => unique_name, }) 36 37 payload = @version.create('POST', @uri, data: data) 38 39 SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], ) 40 end
When passed a block, yields SyncListInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 80 def each 81 limits = @version.read_limits 82 83 page = self.page(page_size: limits[:page_size], ) 84 85 @version.stream(page, 86 limit: limits[:limit], 87 page_limit: limits[:page_limit]).each {|x| yield x} 88 end
Retrieve a single page of SyncListInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of SyncListInstance
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 114 def get_page(target_url) 115 response = @version.domain.request( 116 'GET', 117 target_url 118 ) 119 SyncListPage.new(@version, response, @solution) 120 end
Lists SyncListInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size 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)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 53 def list(limit: nil, page_size: nil) 54 self.stream(limit: limit, page_size: page_size).entries 55 end
Retrieve a single page of SyncListInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of SyncListInstance
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 97 def page(page_token: :unset, page_number: :unset, page_size: :unset) 98 params = Twilio::Values.of({ 99 'PageToken' => page_token, 100 'Page' => page_number, 101 'PageSize' => page_size, 102 }) 103 104 response = @version.page('GET', @uri, params: params) 105 106 SyncListPage.new(@version, response, @solution) 107 end
Streams SyncListInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size 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)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 68 def stream(limit: nil, page_size: nil) 69 limits = @version.read_limits(limit, page_size) 70 71 page = self.page(page_size: limits[:page_size], ) 72 73 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 74 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/sync/service/sync_list.rb 124 def to_s 125 '#<Twilio.Preview.Sync.SyncListList>' 126 end