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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

  • service_sid (String) (defaults to: nil)

    The unique SID identifier of the Service.

  • identity (String) (defaults to: nil)

    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.


297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 297

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

Instance Method Details

#account_sidString

Returns Account Sid.

Returns:

  • (String)

    Account Sid.


342
343
344
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 342

def 
  @properties['account_sid']
end

#challengeschallenges

Access the challenges

Returns:


407
408
409
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 407

def challenges
  context.challenges
end

#contextEntityContext

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

Returns:


321
322
323
324
325
326
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 321

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

#date_createdTime

Returns The date this Entity was created.

Returns:

  • (Time)

    The date this Entity was created


354
355
356
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 354

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date this Entity was updated.

Returns:

  • (Time)

    The date this Entity was updated


360
361
362
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 360

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the EntityInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#factorsfactors

Access the factors

Returns:


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

def factors
  context.factors
end

#fetchEntityInstance

Fetch the EntityInstance

Returns:


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

def fetch
  context.fetch
end

#identityString

Returns Unique external identifier of the Entity.

Returns:

  • (String)

    Unique external identifier of the Entity


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

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation


420
421
422
423
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 420

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

Returns Nested resource URLs.

Returns:

  • (String)

    Nested resource URLs.


372
373
374
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 372

def links
  @properties['links']
end

#new_factorsnew_factors

Access the new_factors

Returns:


400
401
402
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 400

def new_factors
  context.new_factors
end

#service_sidString

Returns Service Sid.

Returns:

  • (String)

    Service Sid.


348
349
350
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 348

def service_sid
  @properties['service_sid']
end

#sidString

Returns A string that uniquely identifies this Entity.

Returns:

  • (String)

    A string that uniquely identifies this Entity.


330
331
332
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 330

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


413
414
415
416
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 413

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

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.


366
367
368
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 366

def url
  @properties['url']
end