Class: Twilio::REST::Autopilot::V1::AssistantContext::TaskContext::FieldList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/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



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 28

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



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 126

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.



74
75
76
77
78
79
80
81
82
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 74

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.



108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 108

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.



47
48
49
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 47

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.



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 91

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.



62
63
64
65
66
67
68
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 62

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



141
142
143
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb', line 141

def to_s
  '#<Twilio.Autopilot.V1.FieldList>'
end