Class: Twilio::REST::Autopilot::V1::AssistantContext::FieldTypeContext::FieldValueInstance

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

  • field_type_sid (String) (defaults to: nil)

    The SID of the Field Type associated with the Field Value.

  • sid (String) (defaults to: nil)

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


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb', line 264

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

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The SID of the Assistant that is the parent of the FieldType associated with the resource.

Returns:

  • (String)

    The SID of the Assistant that is the parent of the FieldType associated with the resource


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

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:


294
295
296
297
298
299
300
301
302
303
304
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb', line 294

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 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


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

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FieldValueInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


376
377
378
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb', line 376

def delete
  context.delete
end

#fetchFieldValueInstance

Fetch the FieldValueInstance

Returns:


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

def fetch
  context.fetch
end

#field_type_sidString

Returns The SID of the Field Type associated with the Field Value.

Returns:

  • (String)

    The SID of the Field Type associated with the Field Value


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

def field_type_sid
  @properties['field_type_sid']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#languageString

Returns The ISO language-country tag that identifies the language of the value.

Returns:

  • (String)

    The ISO language-country tag that identifies the language of the value


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

def language
  @properties['language']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#synonym_ofString

Returns The word for which the field value is a synonym of.

Returns:

  • (String)

    The word for which the field value is a synonym of


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

def synonym_of
  @properties['synonym_of']
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The absolute URL of the FieldValue resource.

Returns:

  • (String)

    The absolute URL of the FieldValue resource


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

def url
  @properties['url']
end

#valueString

Returns The Field Value data.

Returns:

  • (String)

    The Field Value data


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

def value
  @properties['value']
end