class Twilio::REST::Preview::Understand::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

new(version) click to toggle source

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

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

Public Instance Methods

create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset, style_sheet: :unset) click to toggle source

Create the AssistantInstance @param [String] friendly_name A text description for the Assistant. It is

non-unique and can up to 255 characters long.

@param [Boolean] log_queries A boolean that specifies whether queries should be

logged for 30 days further training. If false, no queries will be stored, if
true, queries will be stored for 30 days and deleted thereafter. Defaults to
true if no value is provided.

@param [String] unique_name A user-provided string that uniquely identifies this

resource as an alternative to the sid. Unique up to 64 characters long.

@param [String] callback_url A user-provided URL to send event callbacks to. @param [String] callback_events Space-separated list of callback events that

will trigger callbacks.

@param [Hash] fallback_actions The JSON actions to be executed when the user's

input is not recognized as matching any Task.

@param [Hash] initiation_actions The JSON actions to be executed on inbound

phone calls when the Assistant has to say something first.

@param [Hash] style_sheet The JSON object that holds the style sheet for the

assistant

@return [AssistantInstance] Created AssistantInstance

    # File lib/twilio-ruby/rest/preview/understand/assistant.rb
128 def create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset, style_sheet: :unset)
129   data = Twilio::Values.of({
130       'FriendlyName' => friendly_name,
131       'LogQueries' => log_queries,
132       'UniqueName' => unique_name,
133       'CallbackUrl' => callback_url,
134       'CallbackEvents' => callback_events,
135       'FallbackActions' => Twilio.serialize_object(fallback_actions),
136       'InitiationActions' => Twilio.serialize_object(initiation_actions),
137       'StyleSheet' => Twilio.serialize_object(style_sheet),
138   })
139 
140   payload = @version.create('POST', @uri, data: data)
141 
142   AssistantInstance.new(@version, payload, )
143 end
each() { |x| ... } click to toggle source

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/preview/understand/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
get_page(target_url) click to toggle source

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/preview/understand/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
list(limit: nil, page_size: nil) click to toggle source

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/preview/understand/assistant.rb
39 def list(limit: nil, page_size: nil)
40   self.stream(limit: limit, page_size: page_size).entries
41 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

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/preview/understand/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
stream(limit: nil, page_size: nil) click to toggle source

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/preview/understand/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
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/understand/assistant.rb
147 def to_s
148   '#<Twilio.Preview.Understand.AssistantList>'
149 end