Class: Twilio::REST::Preview::Understand::AssistantContext::FieldTypeInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/field_type.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, sid: nil) ⇒ FieldTypeInstance

Initialize the FieldTypeInstance

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 Assistant.

  • sid (String) (defaults to: nil)

    The sid


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 271

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']),
      'friendly_name' => payload['friendly_name'],
      'links' => payload['links'],
      '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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

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

Returns:

  • (String)

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


305
306
307
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 305

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The unique ID of the Assistant.

Returns:

  • (String)

    The unique ID of the Assistant.


335
336
337
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 335

def assistant_sid
  @properties['assistant_sid']
end

#contextFieldTypeContext

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

Returns:


296
297
298
299
300
301
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 296

def context
  unless @instance_context
    @instance_context = FieldTypeContext.new(@version, @params['assistant_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


311
312
313
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 311

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


317
318
319
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 317

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FieldTypeInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


378
379
380
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 378

def delete
  context.delete
end

#fetchFieldTypeInstance

Fetch the FieldTypeInstance

Returns:


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

def fetch
  context.fetch
end

#field_valuesfield_values

Access the field_values

Returns:


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

def field_values
  context.field_values
end

#friendly_nameString

Returns A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.

Returns:

  • (String)

    A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.


323
324
325
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 323

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The links.

Returns:

  • (String)

    The links


329
330
331
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 329

def links
  @properties['links']
end

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.


341
342
343
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 341

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Preview.Understand.FieldTypeInstance #{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.


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

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset) ⇒ FieldTypeInstance

Update the FieldTypeInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.

  • unique_name (String) (defaults to: :unset)

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

Returns:


371
372
373
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 371

def update(friendly_name: :unset, unique_name: :unset)
  context.update(friendly_name: friendly_name, unique_name: unique_name, )
end

#urlString

Returns The url.

Returns:

  • (String)

    The url


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

def url
  @properties['url']
end