class Twilio::REST::Autopilot::V1::AssistantList
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 AssistantList
@param [Version] version Version
that contains the resource @return [AssistantList] AssistantList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/autopilot/v1/assistant.rb 20 def initialize(version) 21 super(version) 22 23 # Path Solution 24 @solution = {} 25 @uri = "/Assistants" 26 end
Public Instance Methods
Create the AssistantInstance
@param [String] friendly_name A descriptive string that you create to describe
the new resource. It is not unique and can be up to 255 characters long.
@param [Boolean] log_queries Whether queries should be logged and kept after
training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.
@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. The first 64 characters must be unique.
@param [String] callback_url Reserved. @param [String] callback_events Reserved. @param [Hash] style_sheet The JSON string that defines the Assistant's {style
sheet}[https://www.twilio.com/docs/autopilot/api/assistant/stylesheet]
@param [Hash] defaults A JSON object that defines the Assistant's {default
tasks}[https://www.twilio.com/docs/autopilot/api/assistant/defaults] for various scenarios, including initiation actions and fallback tasks.
@return [AssistantInstance] Created AssistantInstance
# File lib/twilio-ruby/rest/autopilot/v1/assistant.rb 126 def create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, style_sheet: :unset, defaults: :unset) 127 data = Twilio::Values.of({ 128 'FriendlyName' => friendly_name, 129 'LogQueries' => log_queries, 130 'UniqueName' => unique_name, 131 'CallbackUrl' => callback_url, 132 'CallbackEvents' => callback_events, 133 'StyleSheet' => Twilio.serialize_object(style_sheet), 134 'Defaults' => Twilio.serialize_object(defaults), 135 }) 136 137 payload = @version.create('POST', @uri, data: data) 138 139 AssistantInstance.new(@version, payload, ) 140 end
When passed a block, yields AssistantInstance
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.rb 66 def each 67 limits = @version.read_limits 68 69 page = self.page(page_size: limits[:page_size], ) 70 71 @version.stream(page, 72 limit: limits[:limit], 73 page_limit: limits[:page_limit]).each {|x| yield x} 74 end
Retrieve a single page of AssistantInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of AssistantInstance
# File lib/twilio-ruby/rest/autopilot/v1/assistant.rb 100 def get_page(target_url) 101 response = @version.domain.request( 102 'GET', 103 target_url 104 ) 105 AssistantPage.new(@version, response, @solution) 106 end
Lists AssistantInstance
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.rb 39 def list(limit: nil, page_size: nil) 40 self.stream(limit: limit, page_size: page_size).entries 41 end
Retrieve a single page of AssistantInstance
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 AssistantInstance
# File lib/twilio-ruby/rest/autopilot/v1/assistant.rb 83 def page(page_token: :unset, page_number: :unset, page_size: :unset) 84 params = Twilio::Values.of({ 85 'PageToken' => page_token, 86 'Page' => page_number, 87 'PageSize' => page_size, 88 }) 89 90 response = @version.page('GET', @uri, params: params) 91 92 AssistantPage.new(@version, response, @solution) 93 end
Streams AssistantInstance
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.rb 54 def stream(limit: nil, page_size: nil) 55 limits = @version.read_limits(limit, page_size) 56 57 page = self.page(page_size: limits[:page_size], ) 58 59 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 60 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/autopilot/v1/assistant.rb 144 def to_s 145 '#<Twilio.Autopilot.V1.AssistantList>' 146 end