Class: Twilio::REST::Verify::V2::ServiceContext::EntityContext::FactorInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/entity/factor.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, sid: nil) ⇒ FactorInstance

Initialize the FactorInstance

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, and generated by your external system, such as your user’s UUID, GUID, or SID.

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

    A 34 character string that uniquely identifies this Factor.



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 299

def initialize(version, payload, service_sid: nil, identity: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'entity_sid' => payload['entity_sid'],
      'identity' => payload['identity'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'status' => payload['status'],
      'factor_type' => payload['factor_type'],
      'config' => payload['config'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



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

def 
  @properties['account_sid']
end

#config ⇒ Hash

Returns Configurations for a ‘factor_type`.

Returns:

  • (Hash) —

    Configurations for a ‘factor_type`.



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

def config
  @properties['config']
end

#context ⇒ FactorContext

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

Returns:



327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 327

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

#date_created ⇒ Time

Returns The date this Factor was created.

Returns:

  • (Time) —

    The date this Factor was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Factor was updated.

Returns:

  • (Time) —

    The date this Factor was updated



377
378
379
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 377

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FactorInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#entity_sid ⇒ String

Returns Entity Sid.

Returns:

  • (String) —

    Entity Sid.



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

def entity_sid
  @properties['entity_sid']
end

#factor_type ⇒ factor.FactorTypes

Returns The Type of this Factor.

Returns:

  • (factor.FactorTypes) —

    The Type of this Factor



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

def factor_type
  @properties['factor_type']
end

#fetch ⇒ FactorInstance

Fetch the FactorInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource.



383
384
385
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 383

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String

Returns Unique external identifier of the Entity.

Returns:

  • (String) —

    Unique external identifier of the Entity



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



454
455
456
457
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 454

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

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Factor.

Returns:

  • (String) —

    A string that uniquely identifies this Factor.



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

def sid
  @properties['sid']
end

#status ⇒ factor.FactorStatuses

Returns The Status of this Factor.

Returns:

  • (factor.FactorStatuses) —

    The Status of this Factor



389
390
391
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 389

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



447
448
449
450
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 447

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

#update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset) ⇒ FactorInstance

Update the FactorInstance

Parameters:

  • auth_payload (String) (defaults to: :unset) —

    The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.

  • friendly_name (String) (defaults to: :unset) —

    The new friendly name of this Factor

  • config_notification_token (String) (defaults to: :unset) —

    For APN, the device token. For FCM the registration token. It used to send the push notifications. Required when ‘factor_type` is `push`

  • config_sdk_version (String) (defaults to: :unset) —

    The Verify Push SDK version used to configure the factor

Returns:



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

def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset)
  context.update(
      auth_payload: auth_payload,
      friendly_name: friendly_name,
      config_notification_token: config_notification_token,
      config_sdk_version: config_sdk_version,
  )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end