class Twilio::REST::Autopilot::V1::AssistantContext::WebhookList
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
Public Class Methods
Initialize the WebhookList
@param [Version] version Version
that contains the resource @param [String] assistant_sid The SID of the
{Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the parent of the resource.
@return [WebhookList] WebhookList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb 24 def initialize(version, assistant_sid: nil) 25 super(version) 26 27 # Path Solution 28 @solution = {assistant_sid: assistant_sid} 29 @uri = "/Assistants/#{@solution[:assistant_sid]}/Webhooks" 30 end
Public Instance Methods
Create the WebhookInstance
@param [String] unique_name An application-defined string that uniquely
identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length.
@param [String] events The list of space-separated events that this Webhook will
subscribe to.
@param [String] webhook_url The URL associated with this Webhook. @param [String] webhook_method The method to be used when calling the webhook's
URL.
@return [WebhookInstance] Created WebhookInstance
# File lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb 124 def create(unique_name: nil, events: nil, webhook_url: nil, webhook_method: :unset) 125 data = Twilio::Values.of({ 126 'UniqueName' => unique_name, 127 'Events' => events, 128 'WebhookUrl' => webhook_url, 129 'WebhookMethod' => webhook_method, 130 }) 131 132 payload = @version.create('POST', @uri, data: data) 133 134 WebhookInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], ) 135 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/autopilot/v1/assistant/webhook.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
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/autopilot/v1/assistant/webhook.rb 104 def get_page(target_url) 105 response = @version.domain.request( 106 'GET', 107 target_url 108 ) 109 WebhookPage.new(@version, response, @solution) 110 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/autopilot/v1/assistant/webhook.rb 43 def list(limit: nil, page_size: nil) 44 self.stream(limit: limit, page_size: page_size).entries 45 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/autopilot/v1/assistant/webhook.rb 87 def page(page_token: :unset, page_number: :unset, page_size: :unset) 88 params = Twilio::Values.of({ 89 'PageToken' => page_token, 90 'Page' => page_number, 91 'PageSize' => page_size, 92 }) 93 94 response = @version.page('GET', @uri, params: params) 95 96 WebhookPage.new(@version, response, @solution) 97 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/autopilot/v1/assistant/webhook.rb 58 def stream(limit: nil, page_size: nil) 59 limits = @version.read_limits(limit, page_size) 60 61 page = self.page(page_size: limits[:page_size], ) 62 63 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 64 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb 139 def to_s 140 '#<Twilio.Autopilot.V1.WebhookList>' 141 end