Class: Twilio::REST::Sync::V1::ServiceContext::SyncListContext::SyncListItemList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Sync::V1::ServiceContext::SyncListContext::SyncListItemList
- Defined in:
- lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb
Instance Method Summary collapse
-
#create(data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset) ⇒ SyncListItemInstance
Create the SyncListItemInstance.
-
#each ⇒ Object
When passed a block, yields SyncListItemInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of SyncListItemInstance records from the API.
-
#initialize(version, service_sid: nil, list_sid: nil) ⇒ SyncListItemList
constructor
Initialize the SyncListItemList.
-
#list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) ⇒ Array
Lists SyncListItemInstance records from the API as a list.
-
#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.
-
#stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil, list_sid: nil) ⇒ SyncListItemList
Initialize the SyncListItemList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 28 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
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 42 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, }) payload = @version.create('POST', @uri, data: data) 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.
120 121 122 123 124 125 126 127 128 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 120 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.
160 161 162 163 164 165 166 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 160 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.
80 81 82 83 84 85 86 87 88 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 80 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.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 140 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.
104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 104 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
171 172 173 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 171 def to_s '#<Twilio.Sync.V1.SyncListItemList>' end |