Class: Twilio::REST::Preview::Understand::AssistantContext::TaskContext::FieldInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Preview::Understand::AssistantContext::TaskContext::FieldInstance

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 help@twilio.com.

Instance Method Summary

• #account_sid ⇒ String

  The unique ID of the Account that created this Field.

• #assistant_sid ⇒ String

  The unique ID of the parent Assistant.

• #context ⇒ FieldContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The date that this resource was created.

• #date_updated ⇒ Time

  The date that this resource was last updated.

• #delete ⇒ Boolean

  Delete the FieldInstance.

• #fetch ⇒ FieldInstance

  Fetch the FieldInstance.

• #field_type ⇒ String

  The Field Type of this field.

• #initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil) ⇒ FieldInstance constructor

  Initialize the FieldInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  A 34 character string that uniquely identifies this resource.

• #task_sid ⇒ String

  The unique ID of the Task associated with this Field.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #unique_name ⇒ String

  A user-provided string that uniquely identifies this resource as an alternative to the sid.

• #url ⇒ String

  The url.

Constructor Details

#initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil) ⇒ FieldInstance

Initialize the FieldInstance

# 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_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#assistant_sid ⇒ String

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

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

# 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_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FieldInstance

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

def delete
  context.delete
end

#fetch ⇒ FieldInstance

Fetch the FieldInstance

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

def fetch
  context.fetch
end

#field_type ⇒ String

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

def field_type
  @properties['field_type']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# 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

#sid ⇒ String

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

def sid
  @properties['sid']
end

#task_sid ⇒ String

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

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# 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_name ⇒ String

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

def unique_name
  @properties['unique_name']
end

#url ⇒ String

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

def url
  @properties['url']
end