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.


245
246
247
248
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 245

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_sidString

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

Returns:

  • (String)

    The unique ID of the Account that created this Field.


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

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The unique ID of the parent Assistant.

Returns:

  • (String)

    The unique ID of the parent Assistant.


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

def assistant_sid
  @properties['assistant_sid']
end

#contextFieldContext

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
280
281
282
283
284
# 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_createdTime

Returns The date that this resource was created.

Returns:

  • (Time)

    The date that this resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date that this resource was last updated.

Returns:

  • (Time)

    The date that this resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FieldInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchFieldInstance

Fetch the FieldInstance

Returns:


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

def fetch
  context.fetch
end

#field_typeString

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.


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

def field_type
  @properties['field_type']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.


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

def sid
  @properties['sid']
end

#task_sidString

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

Returns:

  • (String)

    The unique ID of the Task associated with this Field.


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

def task_sid
  @properties['task_sid']
end

#to_sObject

Provide a user friendly representation


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

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

#unique_nameString

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.


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

def unique_name
  @properties['unique_name']
end

#urlString

Returns The url.

Returns:

  • (String)

    The url


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

def url
  @properties['url']
end