Class: Twilio::REST::Verify::V2::ServiceContext::EntityInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/entity.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, identity: nil) ⇒ EntityInstance

Initialize the EntityInstance

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 Entity resource.

  • sid (String) —

    The SID of the Call resource to fetch.



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 312

def initialize(version, payload , service_sid: nil, identity: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'identity' => payload['identity'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'identity' => identity  || @properties['identity']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



357
358
359
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 357

def 
    @properties['account_sid']
end

#challenges ⇒ challenges

Access the challenges

Returns:



424
425
426
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 424

def challenges
    context.challenges
end

#context ⇒ EntityContext

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

Returns:



336
337
338
339
340
341
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 336

def context
    unless @instance_context
        @instance_context = EntityContext.new(@version , @params['service_sid'], @params['identity'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date that this Entity was created, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



369
370
371
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 369

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Entity was updated, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



375
376
377
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 375

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the EntityInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



394
395
396
397
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 394

def delete

    context.delete
end

#factors ⇒ factors

Access the factors

Returns:



417
418
419
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 417

def factors
    context.factors
end

#fetch ⇒ EntityInstance

Fetch the EntityInstance

Returns:



402
403
404
405
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 402

def fetch

    context.fetch
end

#identity ⇒ String

Returns The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.

Returns:

  • (String) —

    The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.



351
352
353
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 351

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



437
438
439
440
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 437

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

#links ⇒ Hash

Returns Contains a dictionary of URL links to nested resources of this Entity.

Returns:

  • (Hash) —

    Contains a dictionary of URL links to nested resources of this Entity.



387
388
389
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 387

def links
    @properties['links']
end

#new_factors ⇒ new_factors

Access the new_factors

Returns:



410
411
412
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 410

def new_factors
    context.new_factors
end

#service_sid ⇒ String

Returns The unique SID identifier of the Service.

Returns:

  • (String) —

    The unique SID identifier of the Service.



363
364
365
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 363

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Entity.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Entity.



345
346
347
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 345

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



430
431
432
433
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 430

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



381
382
383
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 381

def url
    @properties['url']
end