Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_map.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ SyncMapList

Initialize the SyncMapList



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

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, ttl: :unset) ⇒ SyncMapInstance

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 38

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

  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.



88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 88

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.



124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 124

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.



61
62
63
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 61

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.



105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 105

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
  )
  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.



76
77
78
79
80
81
82
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 76

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



134
135
136
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 134

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