class Twilio::REST::Chat::V2::ServiceContext::ChannelContext::WebhookList
Public Class Methods
Initialize the WebhookList
@param [Version] version Version
that contains the resource @param [String] service_sid The SID of the
{Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel Webhook resource is associated with.
@param [String] channel_sid The SID of the
{Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook resource belongs to.
@return [WebhookList] WebhookList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb 26 def initialize(version, service_sid: nil, channel_sid: nil) 27 super(version) 28 29 # Path Solution 30 @solution = {service_sid: service_sid, channel_sid: channel_sid} 31 @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks" 32 end
Public Instance Methods
Create the WebhookInstance
@param [webhook.Type] type The type of webhook. Can be: `webhook`, `studio`, or
`trigger`.
@param [String] configuration_url The URL of the webhook to call using the
`configuration.method`.
@param [webhook.Method] configuration_method The HTTP
method used to call
`configuration.url`. Can be: `GET` or `POST` and the default is `POST`.
@param [Array] configuration_filters The events that cause us to call
the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see {Webhook Event Triggers}[https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger].
@param [Array] configuration_triggers A string that will cause us to
call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
@param [String] configuration_flow_sid The SID of the Studio
{Flow}[https://www.twilio.com/docs/studio/rest-api/flow] to call when an event in `configuration.filters` occurs. Used only when `type` is `studio`.
@param [String] configuration_retry_count The number of times to retry the
webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
@return [WebhookInstance] Created WebhookInstance
# File lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb 139 def create(type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset) 140 data = Twilio::Values.of({ 141 'Type' => type, 142 'Configuration.Url' => configuration_url, 143 'Configuration.Method' => configuration_method, 144 'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e }, 145 'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e }, 146 'Configuration.FlowSid' => configuration_flow_sid, 147 'Configuration.RetryCount' => configuration_retry_count, 148 }) 149 150 payload = @version.create('POST', @uri, data: data) 151 152 WebhookInstance.new( 153 @version, 154 payload, 155 service_sid: @solution[:service_sid], 156 channel_sid: @solution[:channel_sid], 157 ) 158 end
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/chat/v2/service/channel/webhook.rb 72 def each 73 limits = @version.read_limits 74 75 page = self.page(page_size: limits[:page_size], ) 76 77 @version.stream(page, 78 limit: limits[:limit], 79 page_limit: limits[:page_limit]).each {|x| yield x} 80 end
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/chat/v2/service/channel/webhook.rb 106 def get_page(target_url) 107 response = @version.domain.request( 108 'GET', 109 target_url 110 ) 111 WebhookPage.new(@version, response, @solution) 112 end
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/chat/v2/service/channel/webhook.rb 45 def list(limit: nil, page_size: nil) 46 self.stream(limit: limit, page_size: page_size).entries 47 end
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/chat/v2/service/channel/webhook.rb 89 def page(page_token: :unset, page_number: :unset, page_size: :unset) 90 params = Twilio::Values.of({ 91 'PageToken' => page_token, 92 'Page' => page_number, 93 'PageSize' => page_size, 94 }) 95 96 response = @version.page('GET', @uri, params: params) 97 98 WebhookPage.new(@version, response, @solution) 99 end
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/chat/v2/service/channel/webhook.rb 60 def stream(limit: nil, page_size: nil) 61 limits = @version.read_limits(limit, page_size) 62 63 page = self.page(page_size: limits[:page_size], ) 64 65 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 66 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb 162 def to_s 163 '#<Twilio.Chat.V2.WebhookList>' 164 end