Class: Twilio::REST::Autopilot::V1::AssistantContext::FieldTypeInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb

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

  • account_sid (String) —

    The SID of the Account that created this FieldType resource.

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

    The SID of the Call resource to fetch.



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 289

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  || @properties['assistant_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the FieldType resource.

Returns:



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

def 
    @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource.

Returns:



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

def assistant_sid
    @properties['assistant_sid']
end

#context ⇒ FieldTypeContext

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

Returns:



314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 314

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FieldTypeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



378
379
380
381
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 378

def delete

    context.delete
end

#fetch ⇒ FieldTypeInstance

Fetch the FieldTypeInstance

Returns:



386
387
388
389
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 386

def fetch

    context.fetch
end

#field_values ⇒ field_values

Access the field_values

Returns:



410
411
412
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 410

def field_values
    context.field_values
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long.

Returns:

  • (String) —

    The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



423
424
425
426
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 423

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

#links ⇒ Hash

Returns A list of the URLs of related resources.

Returns:

  • (Hash) —

    A list of the URLs of related resources.



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

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that we created to identify the FieldType resource.

Returns:

  • (String) —

    The unique string that we created to identify the FieldType resource.



359
360
361
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 359

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



416
417
418
419
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 416

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.



365
366
367
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 365

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 descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

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

    An application-defined string that uniquely identifies the resource. It can be used as an alternative to the ‘sid` in the URL path to address the resource. The first 64 characters must be unique.

Returns:



396
397
398
399
400
401
402
403
404
405
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 396

def update(
    friendly_name: :unset, 
    unique_name: :unset
)

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

#url ⇒ String

Returns The absolute URL of the FieldType resource.

Returns:

  • (String) —

    The absolute URL of the FieldType resource.



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

def url
    @properties['url']
end