class Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::WebhookList

Public Class Methods

new(version, service_sid: nil, channel_sid: nil) click to toggle source

Initialize the WebhookList @param [Version] version Version that contains the resource @param [String] service_sid The service_sid @param [String] channel_sid The channel_sid @return [WebhookList] WebhookList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb
22 def initialize(version, service_sid: nil, channel_sid: nil)
23   super(version)
24 
25   # Path Solution
26   @solution = {service_sid: service_sid, channel_sid: channel_sid}
27   @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks"
28 end

Public Instance Methods

create(type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset) click to toggle source

Create the WebhookInstance @param [webhook.Type] type The type @param [String] configuration_url The configuration.url @param [webhook.Method] configuration_method The configuration.method @param [Array] configuration_filters The configuration.filters @param [Array] configuration_triggers The configuration.triggers @param [String] configuration_flow_sid The configuration.flow_sid @param [String] configuration_retry_count The configuration.retry_count @return [WebhookInstance] Created WebhookInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb
120 def create(type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
121   data = Twilio::Values.of({
122       'Type' => type,
123       'Configuration.Url' => configuration_url,
124       'Configuration.Method' => configuration_method,
125       'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
126       'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
127       'Configuration.FlowSid' => configuration_flow_sid,
128       'Configuration.RetryCount' => configuration_retry_count,
129   })
130 
131   payload = @version.create('POST', @uri, data: data)
132 
133   WebhookInstance.new(
134       @version,
135       payload,
136       service_sid: @solution[:service_sid],
137       channel_sid: @solution[:channel_sid],
138   )
139 end
each() { |x| ... } click to toggle source

When passed a block, yields WebhookInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.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
get_page(target_url) click to toggle source

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

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb
102 def get_page(target_url)
103   response = @version.domain.request(
104       'GET',
105       target_url
106   )
107   WebhookPage.new(@version, response, @solution)
108 end
list(limit: nil, page_size: nil) click to toggle source

Lists WebhookInstance 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/ip_messaging/v2/service/channel/webhook.rb
41 def list(limit: nil, page_size: nil)
42   self.stream(limit: limit, page_size: page_size).entries
43 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of WebhookInstance 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 WebhookInstance

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.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   WebhookPage.new(@version, response, @solution)
95 end
stream(limit: nil, page_size: nil) click to toggle source

Streams WebhookInstance 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/ip_messaging/v2/service/channel/webhook.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
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb
143 def to_s
144   '#<Twilio.IpMessaging.V2.WebhookList>'
145 end