Class: Twilio::REST::Verify::V2::ServiceContext::EntityList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Verify::V2::ServiceContext::EntityList
- Defined in:
- lib/twilio-ruby/rest/verify/v2/service/entity.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#create(identity: nil) ⇒ EntityInstance
Create the EntityInstance.
-
#each ⇒ Object
When passed a block, yields EntityInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of EntityInstance records from the API.
-
#initialize(version, service_sid: nil) ⇒ EntityList
constructor
Initialize the EntityList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists EntityInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of EntityInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams EntityInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil) ⇒ EntityList
Initialize the EntityList
22 23 24 25 26 27 28 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 22 def initialize(version, service_sid: nil) super(version) # Path Solution @solution = {service_sid: service_sid} @uri = "/Services/#{@solution[:service_sid]}/Entities" end |
Instance Method Details
#create(identity: nil) ⇒ EntityInstance
Create the EntityInstance
37 38 39 40 41 42 43 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 37 def create(identity: nil) data = Twilio::Values.of({'Identity' => identity, }) payload = @version.create('POST', @uri, data: data) EntityInstance.new(@version, payload, service_sid: @solution[:service_sid], ) end |
#each ⇒ Object
When passed a block, yields EntityInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
83 84 85 86 87 88 89 90 91 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 83 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 EntityInstance records from the API. Request is executed immediately.
117 118 119 120 121 122 123 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 117 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) EntityPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists EntityInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
56 57 58 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 56 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 EntityInstance records from the API. Request is executed immediately.
100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 100 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) EntityPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams EntityInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
71 72 73 74 75 76 77 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 71 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
127 128 129 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 127 def to_s '#<Twilio.Verify.V2.EntityList>' end |