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

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

  • account_sid (String) —

    The SID of the Account that created this FieldValue resource.

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

    The SID of the Call resource to fetch.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb', line 260

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  || @properties['assistant_sid']  ,'field_type_sid' => field_type_sid  || @properties['field_type_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the FieldValue resource.

Returns:



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

def 
    @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resource.

Returns:



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

def assistant_sid
    @properties['assistant_sid']
end

#context ⇒ FieldValueContext

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

Returns:



286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb', line 286

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FieldValueInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ FieldValueInstance

Fetch the FieldValueInstance

Returns:



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

def fetch

    context.fetch
end

#field_type_sid ⇒ String

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.



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

def field_type_sid
    @properties['field_type_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb', line 378

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

#language ⇒ String

Returns The [ISO language-country](docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: ‘en-US`.

Returns:



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

def language
    @properties['language']
end

#sid ⇒ String

Returns The unique string that we created to identify the FieldValue resource.

Returns:

  • (String) —

    The unique string that we created to identify the FieldValue resource.



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

def sid
    @properties['sid']
end

#synonym_of ⇒ String

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.



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

def synonym_of
    @properties['synonym_of']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL of the FieldValue resource.

Returns:

  • (String) —

    The absolute URL of the FieldValue resource.



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

def url
    @properties['url']
end

#value ⇒ String

Returns The Field Value data.

Returns:

  • (String) —

    The Field Value data.



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

def value
    @properties['value']
end