class Twilio::REST::Events::V1::SubscriptionList

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

Public Class Methods

new(version) click to toggle source

Initialize the SubscriptionList @param [Version] version Version that contains the resource @return [SubscriptionList] SubscriptionList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/events/v1/subscription.rb
20 def initialize(version)
21   super(version)
22 
23   # Path Solution
24   @solution = {}
25   @uri = "/Subscriptions"
26 end

Public Instance Methods

create(description: nil, sink_sid: nil, types: nil) click to toggle source

Create the SubscriptionInstance @param [String] description A human readable description for the Subscription

**This value should not contain PII.**

@param [String] sink_sid The SID of the sink that events selected by this

subscription should be sent to. Sink must be active for the subscription to be
created.

@param [Array] types An array of objects containing the subscribed Event

Types

@return [SubscriptionInstance] Created SubscriptionInstance

    # File lib/twilio-ruby/rest/events/v1/subscription.rb
125 def create(description: nil, sink_sid: nil, types: nil)
126   data = Twilio::Values.of({
127       'Description' => description,
128       'SinkSid' => sink_sid,
129       'Types' => Twilio.serialize_list(types) { |e| Twilio.serialize_object(e) },
130   })
131 
132   payload = @version.create('POST', @uri, data: data)
133 
134   SubscriptionInstance.new(@version, payload, )
135 end
each() { |x| ... } click to toggle source

When passed a block, yields SubscriptionInstance 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.rb
70 def each
71   limits = @version.read_limits
72 
73   page = self.page(page_size: limits[:page_size], )
74 
75   @version.stream(page,
76                   limit: limits[:limit],
77                   page_limit: limits[:page_limit]).each {|x| yield x}
78 end
get_page(target_url) click to toggle source

Retrieve a single page of SubscriptionInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of SubscriptionInstance

    # File lib/twilio-ruby/rest/events/v1/subscription.rb
107 def get_page(target_url)
108   response = @version.domain.request(
109       'GET',
110       target_url
111   )
112   SubscriptionPage.new(@version, response, @solution)
113 end
list(sink_sid: :unset, limit: nil, page_size: nil) click to toggle source

Lists SubscriptionInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [String] sink_sid The SID of the sink that the list of Subscriptions

should be filtered by.

@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.rb
41 def list(sink_sid: :unset, limit: nil, page_size: nil)
42   self.stream(sink_sid: sink_sid, limit: limit, page_size: page_size).entries
43 end
page(sink_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of SubscriptionInstance records from the API. Request is executed immediately. @param [String] sink_sid The SID of the sink that the list of Subscriptions

should be filtered by.

@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 SubscriptionInstance

    # File lib/twilio-ruby/rest/events/v1/subscription.rb
 89 def page(sink_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
 90   params = Twilio::Values.of({
 91       'SinkSid' => sink_sid,
 92       'PageToken' => page_token,
 93       'Page' => page_number,
 94       'PageSize' => page_size,
 95   })
 96 
 97   response = @version.page('GET', @uri, params: params)
 98 
 99   SubscriptionPage.new(@version, response, @solution)
100 end
stream(sink_sid: :unset, limit: nil, page_size: nil) click to toggle source

Streams SubscriptionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [String] sink_sid The SID of the sink that the list of Subscriptions

should be filtered by.

@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.rb
58 def stream(sink_sid: :unset, limit: nil, page_size: nil)
59   limits = @version.read_limits(limit, page_size)
60 
61   page = self.page(sink_sid: sink_sid, page_size: limits[:page_size], )
62 
63   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
64 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/events/v1/subscription.rb
139 def to_s
140   '#<Twilio.Events.V1.SubscriptionList>'
141 end