Class: Twilio::REST::Preview::Understand::AssistantContext::QueryInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/query.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ QueryInstance

Initialize the QueryInstance



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 300

def initialize(version, payload , assistant_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'results' => payload['results'],
        'language' => payload['language'],
        'model_build_sid' => payload['model_build_sid'],
        'query' => payload['query'],
        'sample_sid' => payload['sample_sid'],
        'assistant_sid' => payload['assistant_sid'],
        'sid' => payload['sid'],
        'status' => payload['status'],
        'url' => payload['url'],
        'source_channel' => payload['source_channel'],
    }

    # Context
    @instance_context = nil
    @params = { 'assistant_sid' => assistant_sid  || @properties['assistant_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



338
339
340
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 338

def 
    @properties['account_sid']
end

#assistant_sid ⇒ String 



386
387
388
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 386

def assistant_sid
    @properties['assistant_sid']
end

#context ⇒ QueryContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 329

def context
    unless @instance_context
        @instance_context = QueryContext.new(@version , @params['assistant_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time 



344
345
346
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 344

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



350
351
352
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 350

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the QueryInstance



417
418
419
420
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 417

def delete

    context.delete
end

#fetch ⇒ QueryInstance

Fetch the QueryInstance



425
426
427
428
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 425

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



455
456
457
458
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 455

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Preview.Understand.QueryInstance #{values}>"
end

#language ⇒ String 



362
363
364
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 362

def language
    @properties['language']
end

#model_build_sid ⇒ String 



368
369
370
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 368

def model_build_sid
    @properties['model_build_sid']
end

#query ⇒ String 



374
375
376
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 374

def query
    @properties['query']
end

#results ⇒ Hash 



356
357
358
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 356

def results
    @properties['results']
end

#sample_sid ⇒ String 



380
381
382
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 380

def sample_sid
    @properties['sample_sid']
end

#sid ⇒ String 



392
393
394
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 392

def sid
    @properties['sid']
end

#source_channel ⇒ String 



410
411
412
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 410

def source_channel
    @properties['source_channel']
end

#status ⇒ String 



398
399
400
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 398

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



448
449
450
451
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 448

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Preview.Understand.QueryInstance #{values}>"
end

#update(sample_sid: :unset, status: :unset) ⇒ QueryInstance

Update the QueryInstance



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 435

def update(
    sample_sid: :unset, 
    status: :unset
)

    context.update(
        sample_sid: sample_sid, 
        status: status, 
    )
end

#url ⇒ String 



404
405
406
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 404

def url
    @properties['url']
end