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

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

Initialize the SyncListItemList



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

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



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

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.



93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 93

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.



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

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.



63
64
65
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 63

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.



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

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 SyncListItemInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 81

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



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

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