Class: Twilio::REST::Verify::V2::ServiceContext::EntityContext::FactorList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Verify::V2::ServiceContext::EntityContext::FactorList
- Defined in:
- lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields FactorInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of FactorInstance records from the API.
-
#initialize(version, service_sid: nil, identity: nil) ⇒ FactorList
constructor
Initialize the FactorList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists FactorInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of FactorInstance records from the API.
-
#stream(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, identity: nil) ⇒ FactorList
Initialize the FactorList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 28 def initialize(version, service_sid: nil, identity: nil) super(version) # Path Solution @solution = { service_sid: service_sid, identity: identity } @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields FactorInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
78 79 80 81 82 83 84 85 86 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 78 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 FactorInstance records from the API. Request is executed immediately.
112 113 114 115 116 117 118 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 112 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) FactorPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists FactorInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
47 48 49 50 51 52 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 47 def list(limit: nil, page_size: nil) self.stream( limit: limit, page_size: page_size ).entries end |
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of FactorInstance records from the API. Request is executed immediately.
95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 95 def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) FactorPage.new(@version, response, @solution) end |
#stream(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 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 65 def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( 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
123 124 125 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 123 def to_s '#<Twilio.Verify.V2.FactorList>' end |