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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ SyncListList

Initialize the SyncListList



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 27

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

Create the SyncListInstance



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

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.



97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.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 SyncListInstance records from the API. Request is executed immediately.



132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 132

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.



66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 66

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.



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 114

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)

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

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

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



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

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



143
144
145
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 143

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