Class: Twilio::REST::Sync::V1::ServiceContext::SyncListContext::SyncListItemList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, list_sid: nil) ⇒ SyncListItemList

Initialize the SyncListItemList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 29

def initialize(version, service_sid: nil, list_sid: nil)
    super(version)
    # Path Solution
    @solution = { service_sid: service_sid, list_sid: list_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Items"
    
end

Instance Method Details

#create(data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset) ⇒ SyncListItemInstance

Create the SyncListItemInstance



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 43

def create(
    data: nil, 
    ttl: :unset, 
    item_ttl: :unset, 
    collection_ttl: :unset
)

    data = Twilio::Values.of({
        'Data' => Twilio.serialize_object(data),
        'Ttl' => ttl,
        'ItemTtl' => item_ttl,
        'CollectionTtl' => collection_ttl,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    SyncListItemInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        list_sid: @solution[:list_sid],
    )
end

#each ⇒ Object

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



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

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



163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 163

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

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

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



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

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 143

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: params)

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

#stream(order: :unset, from: :unset, bounds: :unset, 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.



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

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



174
175
176
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 174

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