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

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.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, service_sid: nil, map_sid: nil) ⇒ SyncMapItemList

Initialize the SyncMapItemList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 22

def initialize(version, service_sid: nil, map_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, map_sid: map_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Items"
end

Instance Method Details

#create(key: nil, data: nil) ⇒ SyncMapItemInstance

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 36

def create(key: nil, data: nil)
  data = Twilio::Values.of({'Key' => key, 'Data' => Twilio.serialize_object(data)})

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  SyncMapItemInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      map_sid: @solution[:map_sid],
  )
end

#each ⇒ Object

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



97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 97

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



139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 139

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

#list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) ⇒ Array

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



67
68
69
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 67

def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
  self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
end

#page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 117

def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Order' => order,
      'From' => from,
      'Bounds' => bounds,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  SyncMapItemPage.new(@version, response, @solution)
end

#stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 85

def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(order: order, from: from, bounds: bounds, 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



149
150
151
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 149

def to_s
  '#<Twilio.Preview.Sync.SyncMapItemList>'
end