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

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, 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

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

    The unique ID of the parent Assistant.

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

    The unique ID of the Task associated with this Field.

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

    A 34 character string that uniquely identifies this resource.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 258

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,
      'task_sid' => 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.



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

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.



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

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:



287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 287

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the FieldInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



363
364
365
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 363

def delete
  context.delete
end

#fetch ⇒ FieldInstance

Fetch a FieldInstance

Returns:



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

def fetch
  context.fetch
end

#field_type ⇒ String

Returns The Field Type of this field. It can be any Built-in Field Type or unique_name or the Field Type sid of a custom Field Type.

Returns:

  • (String) —

    The Field Type of this field. It can be any Built-in Field Type or unique_name or the Field Type sid of a custom Field Type.



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

def field_type
  @properties['field_type']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



376
377
378
379
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 376

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.



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

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.



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

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



369
370
371
372
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 369

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.



343
344
345
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 343

def unique_name
  @properties['unique_name']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



349
350
351
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 349

def url
  @properties['url']
end