Class: Twilio::REST::Preview::Sync::ServiceContext::SyncMapList

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

Initialize the SyncMapList



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

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

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

Instance Method Details

#create(unique_name: :unset) ⇒ SyncMapInstance

Create the SyncMapInstance



34
35
36
37
38
39
40
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 34

def create(unique_name: :unset)
  data = Twilio::Values.of({'UniqueName' => unique_name, })

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

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

#each ⇒ Object

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



80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 80

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



114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 114

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

#list(limit: nil, page_size: nil) ⇒ Array

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



53
54
55
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 53

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

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

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



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

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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



68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 68

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

  page = self.page(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



124
125
126
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 124

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