Class: Twilio::REST::Events::V1::EventTypeList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Events::V1::EventTypeList
- Defined in:
- lib/twilio-ruby/rest/events/v1/event_type.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields EventTypeInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of EventTypeInstance records from the API.
-
#initialize(version) ⇒ EventTypeList
constructor
Initialize the EventTypeList.
-
#list(schema_id: :unset, limit: nil, page_size: nil) ⇒ Array
Lists EventTypeInstance records from the API as a list.
-
#page(schema_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of EventTypeInstance records from the API.
-
#stream(schema_id: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams EventTypeInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ EventTypeList
Initialize the EventTypeList
20 21 22 23 24 25 26 |
# File 'lib/twilio-ruby/rest/events/v1/event_type.rb', line 20 def initialize(version) super(version) # Path Solution @solution = {} @uri = "/Types" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields EventTypeInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
70 71 72 73 74 75 76 77 78 |
# File 'lib/twilio-ruby/rest/events/v1/event_type.rb', line 70 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 EventTypeInstance records from the API. Request is executed immediately.
107 108 109 110 111 112 113 |
# File 'lib/twilio-ruby/rest/events/v1/event_type.rb', line 107 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) EventTypePage.new(@version, response, @solution) end |
#list(schema_id: :unset, limit: nil, page_size: nil) ⇒ Array
Lists EventTypeInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
41 42 43 |
# File 'lib/twilio-ruby/rest/events/v1/event_type.rb', line 41 def list(schema_id: :unset, limit: nil, page_size: nil) self.stream(schema_id: schema_id, limit: limit, page_size: page_size).entries end |
#page(schema_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of EventTypeInstance records from the API. Request is executed immediately.
89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/twilio-ruby/rest/events/v1/event_type.rb', line 89 def page(schema_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'SchemaId' => schema_id, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) EventTypePage.new(@version, response, @solution) end |
#stream(schema_id: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams EventTypeInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
58 59 60 61 62 63 64 |
# File 'lib/twilio-ruby/rest/events/v1/event_type.rb', line 58 def stream(schema_id: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(schema_id: schema_id, 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/events/v1/event_type.rb', line 117 def to_s '#<Twilio.Events.V1.EventTypeList>' end |