class Twilio::REST::Events::V1::SubscriptionContext::SubscribedEventList
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Public Class Methods
Initialize the SubscribedEventList
@param [Version] version Version
that contains the resource @param [String] subscription_sid The unique SID identifier of the Subscription. @return [SubscribedEventList] SubscribedEventList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 22 def initialize(version, subscription_sid: nil) 23 super(version) 24 25 # Path Solution 26 @solution = {subscription_sid: subscription_sid} 27 @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents" 28 end
Public Instance Methods
Create the SubscribedEventInstance
@param [String] type Type of event being subscribed to. @param [String] schema_version The schema version that the subscription should
use.
@return [SubscribedEventInstance] Created SubscribedEventInstance
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 116 def create(type: nil, schema_version: :unset) 117 data = Twilio::Values.of({'Type' => type, 'SchemaVersion' => schema_version, }) 118 119 payload = @version.create('POST', @uri, data: data) 120 121 SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], ) 122 end
When passed a block, yields SubscribedEventInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 68 def each 69 limits = @version.read_limits 70 71 page = self.page(page_size: limits[:page_size], ) 72 73 @version.stream(page, 74 limit: limits[:limit], 75 page_limit: limits[:page_limit]).each {|x| yield x} 76 end
Retrieve a single page of SubscribedEventInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of SubscribedEventInstance
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 102 def get_page(target_url) 103 response = @version.domain.request( 104 'GET', 105 target_url 106 ) 107 SubscribedEventPage.new(@version, response, @solution) 108 end
Lists SubscribedEventInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 41 def list(limit: nil, page_size: nil) 42 self.stream(limit: limit, page_size: page_size).entries 43 end
Retrieve a single page of SubscribedEventInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of SubscribedEventInstance
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 85 def page(page_token: :unset, page_number: :unset, page_size: :unset) 86 params = Twilio::Values.of({ 87 'PageToken' => page_token, 88 'Page' => page_number, 89 'PageSize' => page_size, 90 }) 91 92 response = @version.page('GET', @uri, params: params) 93 94 SubscribedEventPage.new(@version, response, @solution) 95 end
Streams SubscribedEventInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 56 def stream(limit: nil, page_size: nil) 57 limits = @version.read_limits(limit, page_size) 58 59 page = self.page(page_size: limits[:page_size], ) 60 61 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 62 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb 126 def to_s 127 '#<Twilio.Events.V1.SubscribedEventList>' 128 end