Class: Twilio::REST::Preview::Understand::AssistantList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant.rb

Overview

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 [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AssistantList

Initialize the AssistantList

Parameters:

  • version (Version)

    Version that contains the resource


20
21
22
23
24
25
26
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Assistants"
end

Instance Method Details

#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) ⇒ AssistantInstance

Create the AssistantInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    A text description for the Assistant. It is non-unique and can up to 255 characters long.

  • log_queries (Boolean) (defaults to: :unset)

    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.

  • unique_name (String) (defaults to: :unset)

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

  • callback_url (String) (defaults to: :unset)

    A user-provided URL to send event callbacks to.

  • callback_events (String) (defaults to: :unset)

    Space-separated list of callback events that will trigger callbacks.

  • fallback_actions (Hash) (defaults to: :unset)

    The JSON actions to be executed when the user's input is not recognized as matching any Task.

  • initiation_actions (Hash) (defaults to: :unset)

    The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.

  • style_sheet (Hash) (defaults to: :unset)

    The JSON object that holds the style sheet for the assistant

Returns:


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 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)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'LogQueries' => log_queries,
      'UniqueName' => unique_name,
      'CallbackUrl' => callback_url,
      'CallbackEvents' => callback_events,
      'FallbackActions' => Twilio.serialize_object(fallback_actions),
      'InitiationActions' => Twilio.serialize_object(initiation_actions),
      'StyleSheet' => Twilio.serialize_object(style_sheet),
  })

  payload = @version.create('POST', @uri, data: data)

  AssistantInstance.new(@version, payload, )
end

#eachObject

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


66
67
68
69
70
71
72
73
74
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 66

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of AssistantInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of AssistantInstance


100
101
102
103
104
105
106
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 100

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  AssistantPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists AssistantInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    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)

Returns:

  • (Array)

    Array of up to limit results


39
40
41
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 39

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of AssistantInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of AssistantInstance


83
84
85
86
87
88
89
90
91
92
93
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 83

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  AssistantPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams AssistantInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    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)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


54
55
56
57
58
59
60
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 54

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


147
148
149
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 147

def to_s
  '#<Twilio.Preview.Understand.AssistantList>'
end