Class: Twilio::REST::Preview::Understand::AssistantContext::FieldTypeContext::FieldValueList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Preview::Understand::AssistantContext::FieldTypeContext::FieldValueList
- Defined in:
- lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb
Instance Method Summary collapse
-
#create(language: nil, value: nil, synonym_of: :unset) ⇒ FieldValueInstance
Create the FieldValueInstance.
-
#each ⇒ Object
When passed a block, yields FieldValueInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of FieldValueInstance records from the API.
-
#initialize(version, assistant_sid: nil, field_type_sid: nil) ⇒ FieldValueList
constructor
Initialize the FieldValueList.
-
#list(language: :unset, limit: nil, page_size: nil) ⇒ Array
Lists FieldValueInstance records from the API as a list.
-
#page(language: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of FieldValueInstance records from the API.
-
#stream(language: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, assistant_sid: nil, field_type_sid: nil) ⇒ FieldValueList
Initialize the FieldValueList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 28 def initialize(version, assistant_sid: nil, field_type_sid: nil) super(version) # Path Solution @solution = { assistant_sid: assistant_sid, field_type_sid: field_type_sid } @uri = "/Assistants/#{@solution[:assistant_sid]}/FieldTypes/#{@solution[:field_type_sid]}/FieldValues" end |
Instance Method Details
#create(language: nil, value: nil, synonym_of: :unset) ⇒ FieldValueInstance
Create the FieldValueInstance
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 41 def create( language: nil, value: nil, synonym_of: :unset ) data = Twilio::Values.of({ 'Language' => language, 'Value' => value, 'SynonymOf' => synonym_of, }) payload = @version.create('POST', @uri, data: data) FieldValueInstance.new( @version, payload, assistant_sid: @solution[:assistant_sid], field_type_sid: @solution[:field_type_sid], ) end |
#each ⇒ Object
When passed a block, yields FieldValueInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
109 110 111 112 113 114 115 116 117 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 109 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 FieldValueInstance records from the API. Request is executed immediately.
145 146 147 148 149 150 151 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 145 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) FieldValuePage.new(@version, response, @solution) end |
#list(language: :unset, limit: nil, page_size: nil) ⇒ Array
Lists FieldValueInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
75 76 77 78 79 80 81 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 75 def list(language: :unset, limit: nil, page_size: nil) self.stream( language: language, limit: limit, page_size: page_size ).entries end |
#page(language: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of FieldValueInstance records from the API. Request is executed immediately.
127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 127 def page(language: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Language' => language, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) FieldValuePage.new(@version, response, @solution) end |
#stream(language: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
95 96 97 98 99 100 101 102 103 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 95 def stream(language: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( language: language, 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
156 157 158 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 156 def to_s '#<Twilio.Preview.Understand.FieldValueList>' end |