class Twilio::REST::Preview::Sync::ServiceContext::DocumentList
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 help@twilio.com.
Public Class Methods
Initialize the DocumentList
@param [Version] version Version
that contains the resource @param [String] service_sid The service_sid @return [DocumentList] DocumentList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 22 def initialize(version, service_sid: nil) 23 super(version) 24 25 # Path Solution 26 @solution = {service_sid: service_sid} 27 @uri = "/Services/#{@solution[:service_sid]}/Documents" 28 end
Public Instance Methods
Create the DocumentInstance
@param [String] unique_name The unique_name @param [Hash] data The data @return [DocumentInstance] Created DocumentInstance
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 35 def create(unique_name: :unset, data: :unset) 36 data = Twilio::Values.of({'UniqueName' => unique_name, 'Data' => Twilio.serialize_object(data), }) 37 38 payload = @version.create('POST', @uri, data: data) 39 40 DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], ) 41 end
When passed a block, yields DocumentInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 81 def each 82 limits = @version.read_limits 83 84 page = self.page(page_size: limits[:page_size], ) 85 86 @version.stream(page, 87 limit: limits[:limit], 88 page_limit: limits[:page_limit]).each {|x| yield x} 89 end
Retrieve a single page of DocumentInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of DocumentInstance
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 115 def get_page(target_url) 116 response = @version.domain.request( 117 'GET', 118 target_url 119 ) 120 DocumentPage.new(@version, response, @solution) 121 end
Lists DocumentInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 54 def list(limit: nil, page_size: nil) 55 self.stream(limit: limit, page_size: page_size).entries 56 end
Retrieve a single page of DocumentInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of DocumentInstance
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 98 def page(page_token: :unset, page_number: :unset, page_size: :unset) 99 params = Twilio::Values.of({ 100 'PageToken' => page_token, 101 'Page' => page_number, 102 'PageSize' => page_size, 103 }) 104 105 response = @version.page('GET', @uri, params: params) 106 107 DocumentPage.new(@version, response, @solution) 108 end
Streams DocumentInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 69 def stream(limit: nil, page_size: nil) 70 limits = @version.read_limits(limit, page_size) 71 72 page = self.page(page_size: limits[:page_size], ) 73 74 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 75 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/sync/service/document.rb 125 def to_s 126 '#<Twilio.Preview.Sync.DocumentList>' 127 end