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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/intent/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, intent_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.

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

    The unique ID of the Intent associated with this Field.

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

    The sid



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 248

def initialize(version, payload, assistant_sid: nil, intent_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'],
      'intent_sid' => payload['intent_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,
      'intent_sid' => intent_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:

  • (String) —

    The unique ID of the Account that created this Field.



291
292
293
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 291

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The unique ID of the parent Assistant.

Returns:

  • (String) —

    The unique ID of the parent Assistant.



321
322
323
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 321

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

Returns:



277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 277

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



297
298
299
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 297

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



303
304
305
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 303

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the FieldInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ FieldInstance

Fetch a FieldInstance

Returns:



346
347
348
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 346

def fetch
  context.fetch
end

#field_type ⇒ String

Returns The Field Type of this field. Can be the Field Type unique_name or the Field Type sid.

Returns:

  • (String) —

    The Field Type of this field. Can be the Field Type unique_name or the Field Type sid.



309
310
311
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 309

def field_type
  @properties['field_type']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



366
367
368
369
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 366

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

#intent_sid ⇒ String

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

Returns:

  • (String) —

    The unique ID of the Intent associated with this Field.



315
316
317
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 315

def intent_sid
  @properties['intent_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



327
328
329
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 327

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

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.



333
334
335
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 333

def unique_name
  @properties['unique_name']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



339
340
341
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb', line 339

def url
  @properties['url']
end