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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/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 SID of the Assistant that is the parent of the resource.

  • sid (String) (defaults to: nil)

    The Twilio-provided string that uniquely identifies the FieldType resource to fetch.


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 281

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 SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The SID of the Assistant that is the parent of the resource.

Returns:

  • (String)

    The SID of the Assistant that is the parent of the resource


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

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:


306
307
308
309
310
311
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 306

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

#date_createdTime

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FieldTypeInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


389
390
391
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 389

def delete
  context.delete
end

#fetchFieldTypeInstance

Fetch the FieldTypeInstance

Returns:


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

def fetch
  context.fetch
end

#field_valuesfield_values

Access the field_values

Returns:


396
397
398
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 396

def field_values
  context.field_values
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns A list of the URLs of related resources.

Returns:

  • (String)

    A list of the URLs of related resources


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

def links
  @properties['links']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


402
403
404
405
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 402

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

#unique_nameString

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String)

    An application-defined string that uniquely identifies the resource


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

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:


382
383
384
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb', line 382

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

#urlString

Returns The absolute URL of the FieldType resource.

Returns:

  • (String)

    The absolute URL of the FieldType resource


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

def url
  @properties['url']
end