Class: Twilio::REST::Preview::Understand::AssistantContext::TaskContext::FieldList

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

Initialize the FieldList



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 24

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

  # Path Solution
  @solution = {assistant_sid: assistant_sid, task_sid: task_sid}
  @uri = "/Assistants/#{@solution[:assistant_sid]}/Tasks/#{@solution[:task_sid]}/Fields"
end

Instance Method Details

#create(field_type: nil, unique_name: nil) ⇒ FieldInstance

Create the FieldInstance



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

def create(field_type: nil, unique_name: nil)
  data = Twilio::Values.of({'FieldType' => field_type, 'UniqueName' => unique_name, })

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

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

#each ⇒ Object

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



70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 70

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



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

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

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

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



43
44
45
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 43

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



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

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)

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

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

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



58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 58

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



136
137
138
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 136

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