Class: Twilio::REST::Preview::Understand::AssistantContext::FieldTypeContext::FieldValueInstance

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

Initialize the FieldValueInstance

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.

  • field_type_sid (String) (defaults to: nil)

    The unique ID of the Field Type associated with this Field Value.

  • sid (String) (defaults to: nil)

    The sid


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 251

def initialize(version, payload, assistant_sid: nil, field_type_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_sid' => payload['field_type_sid'],
      'language' => payload['language'],
      'assistant_sid' => payload['assistant_sid'],
      'sid' => payload['sid'],
      'value' => payload['value'],
      'url' => payload['url'],
      'synonym_of' => payload['synonym_of'],
  }

  # Context
  @instance_context = nil
  @params = {
      'assistant_sid' => assistant_sid,
      'field_type_sid' => field_type_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sidString

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

Returns:

  • (String)

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


295
296
297
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 295

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The unique ID of the Assistant.

Returns:

  • (String)

    The unique ID of the Assistant.


325
326
327
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 325

def assistant_sid
  @properties['assistant_sid']
end

#contextFieldValueContext

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

Returns:


281
282
283
284
285
286
287
288
289
290
291
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 281

def context
  unless @instance_context
    @instance_context = FieldValueContext.new(
        @version,
        @params['assistant_sid'],
        @params['field_type_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


301
302
303
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 301

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


307
308
309
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 307

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FieldValueInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


363
364
365
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 363

def delete
  context.delete
end

#fetchFieldValueInstance

Fetch the FieldValueInstance

Returns:


356
357
358
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 356

def fetch
  context.fetch
end

#field_type_sidString

Returns The unique ID of the Field Type associated with this Field Value.

Returns:

  • (String)

    The unique ID of the Field Type associated with this Field Value.


313
314
315
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 313

def field_type_sid
  @properties['field_type_sid']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#languageString

Returns An ISO language-country string of the value.

Returns:

  • (String)

    An ISO language-country string of the value.


319
320
321
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 319

def language
  @properties['language']
end

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.


331
332
333
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 331

def sid
  @properties['sid']
end

#synonym_ofString

Returns A value that indicates this field value is a synonym of. Empty if the value is not a synonym.

Returns:

  • (String)

    A value that indicates this field value is a synonym of. Empty if the value is not a synonym.


349
350
351
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 349

def synonym_of
  @properties['synonym_of']
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The url.

Returns:

  • (String)

    The url


343
344
345
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 343

def url
  @properties['url']
end

#valueString

Returns The Field Value itself.

Returns:

  • (String)

    The Field Value itself.


337
338
339
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb', line 337

def value
  @properties['value']
end