Class: Twilio::REST::Preview::Sync::ServiceContext::SyncListList

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

Initialize the SyncListList



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

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

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

Instance Method Details

#create(unique_name: :unset) ⇒ SyncListInstance

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 35

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

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

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

#each ⇒ Object

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



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

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



121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 121

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

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

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



58
59
60
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 58

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



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 102

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
  )
  SyncListPage.new(@version, response, @solution)
end

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

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



73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 73

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



131
132
133
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 131

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