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

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

Parameters:

  • version (Version) —

    Version that contains the resource

  • assistant_sid (String) —

    The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource to fetch.

  • task_sid (String) —

    The SID of the [Task](www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Sample resource to fetch.



209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 209

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

Delete the SampleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



264
265
266
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 264

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

#fetch ⇒ SampleInstance

Fetch the SampleInstance

Returns:



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 220

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

  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



277
278
279
280
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 277

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

#to_s ⇒ Object

Provide a user friendly representation



270
271
272
273
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb', line 270

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

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

Update the SampleInstance

Parameters:

  • language (String) (defaults to: :unset) —

    The [ISO language-country](docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: ‘en-US`.

  • tagged_text (String) (defaults to: :unset) —

    The text example of how end users might express the task. The sample can contain [Field tag blocks](www.twilio.com/docs/autopilot/api/task-sample#field-tagging).

  • source_channel (String) (defaults to: :unset) —

    The communication channel from which the sample was captured. Can be: ‘voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.

Returns:



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

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