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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service.rb,
lib/twilio-ruby/rest/verify/v2/service/entity.rb,
lib/twilio-ruby/rest/verify/v2/service/webhook.rb,
lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb,
lib/twilio-ruby/rest/verify/v2/service/access_token.rb,
lib/twilio-ruby/rest/verify/v2/service/verification.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb,
lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb,
lib/twilio-ruby/rest/verify/v2/service/verification_check.rb,
lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb

Defined Under Namespace

Classes: AccessTokenInstance, AccessTokenList, AccessTokenPage, EntityContext, EntityInstance, EntityList, EntityPage, MessagingConfigurationContext, MessagingConfigurationInstance, MessagingConfigurationList, MessagingConfigurationPage, RateLimitContext, RateLimitInstance, RateLimitList, RateLimitPage, VerificationCheckInstance, VerificationCheckList, VerificationCheckPage, VerificationContext, VerificationInstance, VerificationList, VerificationPage, WebhookContext, WebhookInstance, WebhookList, WebhookPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 225

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {sid: sid, }
  @uri = "/Services/#{@solution[:sid]}"

  # Dependents
  @verifications = nil
  @verification_checks = nil
  @rate_limits = nil
  @messaging_configurations = nil
  @entities = nil
  @webhooks = nil
  @access_tokens = nil
end

Instance Method Details

#access_tokens ⇒ AccessTokenList, AccessTokenContext

Access the access_tokens



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

def access_tokens
  unless @access_tokens
    @access_tokens = AccessTokenList.new(@version, service_sid: @solution[:sid], )
  end

  @access_tokens
end

#delete ⇒ Boolean

Delete the ServiceInstance



254
255
256
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 254

def delete
   @version.delete('DELETE', @uri)
end

#entities(identity = :unset) ⇒ EntityList, EntityContext

Access the entities

Raises:

  • (ArgumentError) 


402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 402

def entities(identity=:unset)
  raise ArgumentError, 'identity cannot be nil' if identity.nil?

  if identity != :unset
    return EntityContext.new(@version, @solution[:sid], identity, )
  end

  unless @entities
    @entities = EntityList.new(@version, service_sid: @solution[:sid], )
  end

  @entities
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance



245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 245

def fetch
  payload = @version.fetch('GET', @uri)

  ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Verify.V2.ServiceContext #{context}>"
end

#messaging_configurations(country = :unset) ⇒ MessagingConfigurationList, MessagingConfigurationContext

Access the messaging_configurations

Raises:

  • (ArgumentError) 


384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 384

def messaging_configurations(country=:unset)
  raise ArgumentError, 'country cannot be nil' if country.nil?

  if country != :unset
    return MessagingConfigurationContext.new(@version, @solution[:sid], country, )
  end

  unless @messaging_configurations
    @messaging_configurations = MessagingConfigurationList.new(@version, service_sid: @solution[:sid], )
  end

  @messaging_configurations
end

#rate_limits(sid = :unset) ⇒ RateLimitList, RateLimitContext

Access the rate_limits

Raises:

  • (ArgumentError) 


366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 366

def rate_limits(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return RateLimitContext.new(@version, @solution[:sid], sid, )
  end

  unless @rate_limits
    @rate_limits = RateLimitList.new(@version, service_sid: @solution[:sid], )
  end

  @rate_limits
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Verify.V2.ServiceContext #{context}>"
end

#update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset) ⇒ ServiceInstance

Update the ServiceInstance



307
308
309
310
311
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.rb', line 307

def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'CodeLength' => code_length,
      'LookupEnabled' => lookup_enabled,
      'SkipSmsToLandlines' => skip_sms_to_landlines,
      'DtmfInputRequired' => dtmf_input_required,
      'TtsName' => tts_name,
      'Psd2Enabled' => psd2_enabled,
      'DoNotShareWarningEnabled' => do_not_share_warning_enabled,
      'CustomCodeEnabled' => custom_code_enabled,
      'Push.IncludeDate' => push_include_date,
      'Push.ApnCredentialSid' => push_apn_credential_sid,
      'Push.FcmCredentialSid' => push_fcm_credential_sid,
      'Totp.Issuer' => totp_issuer,
      'Totp.TimeStep' => totp_time_step,
      'Totp.CodeLength' => totp_code_length,
      'Totp.Skew' => totp_skew,
  })

  payload = @version.update('POST', @uri, data: data)

  ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end

#verification_checks ⇒ VerificationCheckList, VerificationCheckContext

Access the verification_checks



354
355
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 354

def verification_checks
  unless @verification_checks
    @verification_checks = VerificationCheckList.new(@version, service_sid: @solution[:sid], )
  end

  @verification_checks
end

#verifications(sid = :unset) ⇒ VerificationList, VerificationContext

Access the verifications

Raises:

  • (ArgumentError) 


336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 336

def verifications(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return VerificationContext.new(@version, @solution[:sid], sid, )
  end

  unless @verifications
    @verifications = VerificationList.new(@version, service_sid: @solution[:sid], )
  end

  @verifications
end

#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext

Access the webhooks

Raises:

  • (ArgumentError) 


420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 420

def webhooks(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return WebhookContext.new(@version, @solution[:sid], sid, )
  end

  unless @webhooks
    @webhooks = WebhookList.new(@version, service_sid: @solution[:sid], )
  end

  @webhooks
end