Class: Twilio::REST::Verify::V2::ServiceContext::EntityContext::FactorList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, identity: nil) ⇒ FactorList

Initialize the FactorList



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 27

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.



73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 73

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.



107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 107

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.



46
47
48
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 46

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.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 90

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



61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 61

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



117
118
119
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 117

def to_s
  '#<Twilio.Verify.V2.FactorList>'
end