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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 280

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'],
      'metadata' => payload['metadata'],
      '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 



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

def 
  @properties['account_sid']
end

#config ⇒ Hash 



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

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



309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 309

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FactorInstance



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

def delete
  context.delete
end

#entity_sid ⇒ String 



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

def entity_sid
  @properties['entity_sid']
end

#factor_type ⇒ factor.FactorTypes 



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

def factor_type
  @properties['factor_type']
end

#fetch ⇒ FactorInstance

Fetch the FactorInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String 



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



462
463
464
465
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 462

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

#metadata ⇒ Hash 



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

def metadata
  @properties['metadata']
end

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#status ⇒ factor.FactorStatuses 



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, config_notification_platform: :unset) ⇒ FactorInstance

Update the FactorInstance



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 439

def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, config_notification_platform: :unset)
  context.update(
      auth_payload: auth_payload,
      friendly_name: friendly_name,
      config_notification_token: config_notification_token,
      config_sdk_version: config_sdk_version,
      config_time_step: config_time_step,
      config_skew: config_skew,
      config_code_length: config_code_length,
      config_alg: config_alg,
      config_notification_platform: config_notification_platform,
  )
end

#url ⇒ String 



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

def url
  @properties['url']
end