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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the FieldInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Field resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 249

def initialize(version, payload , assistant_sid: nil, task_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']),
        'field_type' => payload['field_type'],
        'task_sid' => payload['task_sid'],
        'assistant_sid' => payload['assistant_sid'],
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account that created this Field.

Returns:

  • (String) —

    The unique ID of the Account that created this Field.



283
284
285
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 283

def 
    @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The unique ID of the parent Assistant.

Returns:

  • (String) —

    The unique ID of the parent Assistant.



313
314
315
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 313

def assistant_sid
    @properties['assistant_sid']
end

#context ⇒ FieldContext

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

Returns:



274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 274

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



289
290
291
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 289

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



295
296
297
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 295

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FieldInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ FieldInstance

Fetch the FieldInstance

Returns:



346
347
348
349
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 346

def fetch

    context.fetch
end

#field_type ⇒ String

Returns The Field Type of this field. It can be any [Built-in Field Type](www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or sid of a custom Field Type.

Returns:



301
302
303
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 301

def field_type
    @properties['field_type']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



360
361
362
363
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 360

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

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



319
320
321
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 319

def sid
    @properties['sid']
end

#task_sid ⇒ String

Returns The unique ID of the Task associated with this Field.

Returns:

  • (String) —

    The unique ID of the Task associated with this Field.



307
308
309
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 307

def task_sid
    @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



353
354
355
356
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 353

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

#unique_name ⇒ String

Returns A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

Returns:

  • (String) —

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.



325
326
327
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 325

def unique_name
    @properties['unique_name']
end

#url ⇒ String

Returns:

  • (String) 


331
332
333
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 331

def url
    @properties['url']
end