Class: Twilio::REST::Verify::V2::TemplateList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Verify::V2::TemplateList
- Defined in:
- lib/twilio-ruby/rest/verify/v2/template.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields TemplateInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of TemplateInstance records from the API.
-
#initialize(version) ⇒ TemplateList
constructor
Initialize the TemplateList.
-
#list(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TemplateInstance records from the API as a list.
-
#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TemplateInstance records from the API.
-
#stream(friendly_name: :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) ⇒ TemplateList
Initialize the TemplateList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/verify/v2/template.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Templates" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields TemplateInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
79 80 81 82 83 84 85 86 87 |
# File 'lib/twilio-ruby/rest/verify/v2/template.rb', line 79 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 TemplateInstance records from the API. Request is executed immediately.
115 116 117 118 119 120 121 |
# File 'lib/twilio-ruby/rest/verify/v2/template.rb', line 115 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) TemplatePage.new(@version, response, @solution) end |
#list(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TemplateInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
45 46 47 48 49 50 51 |
# File 'lib/twilio-ruby/rest/verify/v2/template.rb', line 45 def list(friendly_name: :unset, limit: nil, page_size: nil) self.stream( friendly_name: friendly_name, limit: limit, page_size: page_size ).entries end |
#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TemplateInstance records from the API. Request is executed immediately.
97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/twilio-ruby/rest/verify/v2/template.rb', line 97 def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) TemplatePage.new(@version, response, @solution) end |
#stream(friendly_name: :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.
65 66 67 68 69 70 71 72 73 |
# File 'lib/twilio-ruby/rest/verify/v2/template.rb', line 65 def stream(friendly_name: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( friendly_name: friendly_name, 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
126 127 128 |
# File 'lib/twilio-ruby/rest/verify/v2/template.rb', line 126 def to_s '#<Twilio.Verify.V2.TemplateList>' end |