class Twilio::REST::Preview::Sync::ServiceContext::SyncMapContext::SyncMapItemList

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

new(version, service_sid: nil, map_sid: nil) click to toggle source

Initialize the SyncMapItemList @param [Version] version Version that contains the resource @param [String] service_sid The service_sid @param [String] map_sid The map_sid @return [SyncMapItemList] SyncMapItemList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb
24 def initialize(version, service_sid: nil, map_sid: nil)
25   super(version)
26 
27   # Path Solution
28   @solution = {service_sid: service_sid, map_sid: map_sid}
29   @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Items"
30 end

Public Instance Methods

create(key: nil, data: nil) click to toggle source

Create the SyncMapItemInstance @param [String] key The key @param [Hash] data The data @return [SyncMapItemInstance] Created SyncMapItemInstance

   # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb
37 def create(key: nil, data: nil)
38   data = Twilio::Values.of({'Key' => key, 'Data' => Twilio.serialize_object(data), })
39 
40   payload = @version.create('POST', @uri, data: data)
41 
42   SyncMapItemInstance.new(
43       @version,
44       payload,
45       service_sid: @solution[:service_sid],
46       map_sid: @solution[:map_sid],
47   )
48 end
each() { |x| ... } click to toggle source

When passed a block, yields SyncMapItemInstance 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_map/sync_map_item.rb
 94 def each
 95   limits = @version.read_limits
 96 
 97   page = self.page(page_size: limits[:page_size], )
 98 
 99   @version.stream(page,
100                   limit: limits[:limit],
101                   page_limit: limits[:page_limit]).each {|x| yield x}
102 end
get_page(target_url) click to toggle source

Retrieve a single page of SyncMapItemInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of SyncMapItemInstance

    # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb
134 def get_page(target_url)
135   response = @version.domain.request(
136       'GET',
137       target_url
138   )
139   SyncMapItemPage.new(@version, response, @solution)
140 end
list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) click to toggle source

Lists SyncMapItemInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [sync_map_item.QueryResultOrder] order The order @param [String] from The from @param [sync_map_item.QueryFromBoundType] bounds The bounds @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_map/sync_map_item.rb
64 def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
65   self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
66 end
page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of SyncMapItemInstance records from the API. Request is executed immediately. @param [sync_map_item.QueryResultOrder] order The order @param [String] from The from @param [sync_map_item.QueryFromBoundType] bounds The bounds @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 SyncMapItemInstance

    # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb
114 def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
115   params = Twilio::Values.of({
116       'Order' => order,
117       'From' => from,
118       'Bounds' => bounds,
119       'PageToken' => page_token,
120       'Page' => page_number,
121       'PageSize' => page_size,
122   })
123 
124   response = @version.page('GET', @uri, params: params)
125 
126   SyncMapItemPage.new(@version, response, @solution)
127 end
stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) click to toggle source

Streams SyncMapItemInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [sync_map_item.QueryResultOrder] order The order @param [String] from The from @param [sync_map_item.QueryFromBoundType] bounds The bounds @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_map/sync_map_item.rb
82 def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
83   limits = @version.read_limits(limit, page_size)
84 
85   page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
86 
87   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
88 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb
144 def to_s
145   '#<Twilio.Preview.Sync.SyncMapItemList>'
146 end