Class: Twilio::REST::Verify::V2::ServiceInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The Twilio-provided string that uniquely identifies the Verification Service resource to fetch.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 359

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'code_length' => payload['code_length'].to_i,
      'lookup_enabled' => payload['lookup_enabled'],
      'psd2_enabled' => payload['psd2_enabled'],
      'skip_sms_to_landlines' => payload['skip_sms_to_landlines'],
      'dtmf_input_required' => payload['dtmf_input_required'],
      'tts_name' => payload['tts_name'],
      'do_not_share_warning_enabled' => payload['do_not_share_warning_enabled'],
      '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 = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#code_length ⇒ String

Returns The length of the verification code.

Returns:

  • (String) —

    The length of the verification code



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

def code_length
  @properties['code_length']
end

#context ⇒ ServiceContext

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

Returns:



389
390
391
392
393
394
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 389

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



458
459
460
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 458

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



464
465
466
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 464

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



490
491
492
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 490

def delete
  context.delete
end

#do_not_share_warning_enabled ⇒ Boolean

Returns Whether to add a privacy warning at the end of an SMS.

Returns:

  • (Boolean) —

    Whether to add a privacy warning at the end of an SMS.



452
453
454
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 452

def do_not_share_warning_enabled
  @properties['do_not_share_warning_enabled']
end

#dtmf_input_required ⇒ Boolean

Returns Whether to ask the user to press a number before delivering the verify code in a phone call.

Returns:

  • (Boolean) —

    Whether to ask the user to press a number before delivering the verify code in a phone call



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

def dtmf_input_required
  @properties['dtmf_input_required']
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



483
484
485
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 483

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the verification service.

Returns:

  • (String) —

    The string that you assigned to describe the verification service



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



564
565
566
567
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 564

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



476
477
478
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 476

def links
  @properties['links']
end

#lookup_enabled ⇒ Boolean

Returns Whether to perform a lookup with each verification.

Returns:

  • (Boolean) —

    Whether to perform a lookup with each verification



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

def lookup_enabled
  @properties['lookup_enabled']
end

#messaging_configurations ⇒ messaging_configurations

Access the messaging_configurations

Returns:



551
552
553
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 551

def messaging_configurations
  context.messaging_configurations
end

#psd2_enabled ⇒ Boolean

Returns Whether to pass PSD2 transaction parameters when starting a verification.

Returns:

  • (Boolean) —

    Whether to pass PSD2 transaction parameters when starting a verification



428
429
430
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 428

def psd2_enabled
  @properties['psd2_enabled']
end

#rate_limits ⇒ rate_limits

Access the rate_limits

Returns:



544
545
546
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 544

def rate_limits
  context.rate_limits
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



398
399
400
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 398

def sid
  @properties['sid']
end

#skip_sms_to_landlines ⇒ Boolean

Returns Whether to skip sending SMS verifications to landlines.

Returns:

  • (Boolean) —

    Whether to skip sending SMS verifications to landlines



434
435
436
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 434

def skip_sms_to_landlines
  @properties['skip_sms_to_landlines']
end

#to_s ⇒ Object

Provide a user friendly representation



557
558
559
560
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 557

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

#tts_name ⇒ String

Returns The name of an alternative text-to-speech service to use in phone calls.

Returns:

  • (String) —

    The name of an alternative text-to-speech service to use in phone calls



446
447
448
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 446

def tts_name
  @properties['tts_name']
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) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    A descriptive string that you create to describe the verification service. It can be up to 64 characters long. **This value should not contain PII.**

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

    The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.

  • lookup_enabled (Boolean) (defaults to: :unset) —

    Whether to perform a lookup with each verification started and return info about the phone number.

  • skip_sms_to_landlines (Boolean) (defaults to: :unset) —

    Whether to skip sending SMS verifications to landlines. Requires lookup_enabled.

  • dtmf_input_required (Boolean) (defaults to: :unset) —

    Whether to ask the user to press a number before delivering the verify code in a phone call.

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

    The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.

  • psd2_enabled (Boolean) (defaults to: :unset) —

    Whether to pass PSD2 transaction parameters when starting a verification.

  • do_not_share_warning_enabled (Boolean) (defaults to: :unset) —

    Whether to add a privacy warning at the end of an SMS. **Disabled by default and applies only for SMS.**

Returns:



514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 514

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)
  context.update(
      friendly_name: friendly_name,
      code_length: code_length,
      lookup_enabled: lookup_enabled,
      skip_sms_to_landlines: skip_sms_to_landlines,
      dtmf_input_required: dtmf_input_required,
      tts_name: tts_name,
      psd2_enabled: psd2_enabled,
      do_not_share_warning_enabled: do_not_share_warning_enabled,
  )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



470
471
472
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 470

def url
  @properties['url']
end

#verification_checks ⇒ verification_checks

Access the verification_checks

Returns:



537
538
539
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 537

def verification_checks
  context.verification_checks
end

#verifications ⇒ verifications

Access the verifications

Returns:



530
531
532
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 530

def verifications
  context.verifications
end