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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/task/sample.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, task_sid, sid) ⇒ SampleContext

Initialize the SampleContext



203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 203

def initialize(version, assistant_sid, task_sid, sid)
  super(version)

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

Instance Method Details

#delete ⇒ Boolean

Deletes the SampleInstance



266
267
268
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 266

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ SampleInstance

Fetch a SampleInstance



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 214

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



279
280
281
282
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 279

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.Understand.SampleContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



272
273
274
275
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 272

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.Understand.SampleContext #{context}>"
end

#update(language: :unset, tagged_text: :unset, source_channel: :unset) ⇒ SampleInstance

Update the SampleInstance



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 241

def update(language: :unset, tagged_text: :unset, source_channel: :unset)
  data = Twilio::Values.of({
      'Language' => language,
      'TaggedText' => tagged_text,
      'SourceChannel' => source_channel,
  })

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

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