class Twilio::REST::Verify::V2::VerificationTemplateList
Public Class Methods
Initialize the VerificationTemplateList
@param [Version] version Version
that contains the resource @return [VerificationTemplateList] VerificationTemplateList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/verify/v2/verification_template.rb 18 def initialize(version) 19 super(version) 20 21 # Path Solution 22 @solution = {} 23 @uri = "/Templates" 24 end
Public Instance Methods
When passed a block, yields VerificationTemplateInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/verify/v2/verification_template.rb 68 def each 69 limits = @version.read_limits 70 71 page = self.page(page_size: limits[:page_size], ) 72 73 @version.stream(page, 74 limit: limits[:limit], 75 page_limit: limits[:page_limit]).each {|x| yield x} 76 end
Retrieve a single page of VerificationTemplateInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of VerificationTemplateInstance
# File lib/twilio-ruby/rest/verify/v2/verification_template.rb 105 def get_page(target_url) 106 response = @version.domain.request( 107 'GET', 108 target_url 109 ) 110 VerificationTemplatePage.new(@version, response, @solution) 111 end
Lists VerificationTemplateInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [String] friendly_name String filter used to query templates with a given
friendly name
@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/verify/v2/verification_template.rb 39 def list(friendly_name: :unset, limit: nil, page_size: nil) 40 self.stream(friendly_name: friendly_name, limit: limit, page_size: page_size).entries 41 end
Retrieve a single page of VerificationTemplateInstance
records from the API. Request
is executed immediately. @param [String] friendly_name String filter used to query templates with a given
friendly name
@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 VerificationTemplateInstance
# File lib/twilio-ruby/rest/verify/v2/verification_template.rb 87 def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) 88 params = Twilio::Values.of({ 89 'FriendlyName' => friendly_name, 90 'PageToken' => page_token, 91 'Page' => page_number, 92 'PageSize' => page_size, 93 }) 94 95 response = @version.page('GET', @uri, params: params) 96 97 VerificationTemplatePage.new(@version, response, @solution) 98 end
Streams VerificationTemplateInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [String] friendly_name String filter used to query templates with a given
friendly name
@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/verify/v2/verification_template.rb 56 def stream(friendly_name: :unset, limit: nil, page_size: nil) 57 limits = @version.read_limits(limit, page_size) 58 59 page = self.page(friendly_name: friendly_name, page_size: limits[:page_size], ) 60 61 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 62 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/verify/v2/verification_template.rb 115 def to_s 116 '#<Twilio.Verify.V2.VerificationTemplateList>' 117 end