Class: Twilio::REST::Preview::Understand::AssistantContext::IntentList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/intent.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, assistant_sid: nil) ⇒ IntentList

Initialize the IntentList



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

def initialize(version, assistant_sid: nil)
  super(version)

  # Path Solution
  @solution = {assistant_sid: assistant_sid}
  @uri = "/Assistants/#{@solution[:assistant_sid]}/Intents"
end

Instance Method Details

#create(unique_name: nil, friendly_name: :unset) ⇒ IntentInstance

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



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 120

def create(unique_name: nil, friendly_name: :unset)
  data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })

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

  IntentInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
end

#each ⇒ Object

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



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

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 IntentInstance records from the API. Request is executed immediately.



104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 104

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

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

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



41
42
43
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 41

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 IntentInstance records from the API. Request is executed immediately.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 85

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
  )
  IntentPage.new(@version, response, @solution)
end

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

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



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

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_s ⇒ Object

Provide a user friendly representation



134
135
136
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 134

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