Class: Twilio::REST::Preview::Sync::ServiceContext::SyncListContext::SyncListItemList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Preview::Sync::ServiceContext::SyncListContext::SyncListItemList
- Defined in:
- lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb
Instance Method Summary collapse
-
#create(data: nil) ⇒ 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/preview/sync/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) ⇒ SyncListItemInstance
Create the SyncListItemInstance
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 39 def create( data: nil ) data = Twilio::Values.of({ 'Data' => Twilio.serialize_object(data), }) 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.
111 112 113 114 115 116 117 118 119 |
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 111 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.
151 152 153 154 155 156 157 |
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 151 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.
71 72 73 74 75 76 77 78 79 |
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 71 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.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 131 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.
95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 95 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
162 163 164 |
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 162 def to_s '#<Twilio.Preview.Sync.SyncListItemList>' end |