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.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 421

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

#access_tokens ⇒ access_tokens

Access the access_tokens

Returns:



661
662
663
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 661

def access_tokens
  context.access_tokens
end

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#code_length ⇒ String

Returns The length of the verification code.

Returns:

  • (String) —

    The length of the verification code



480
481
482
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 480

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:



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

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

#custom_code_enabled ⇒ Boolean

Returns Whether to allow sending verifications with a custom code.

Returns:

  • (Boolean) —

    Whether to allow sending verifications with a custom code.



522
523
524
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 522

def custom_code_enabled
  @properties['custom_code_enabled']
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



534
535
536
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 534

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



540
541
542
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 540

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#do_not_share_warning_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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



516
517
518
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 516

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



504
505
506
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 504

def dtmf_input_required
  @properties['dtmf_input_required']
end

#entities ⇒ entities

Access the entities

Returns:



647
648
649
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 647

def entities
  context.entities
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



674
675
676
677
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 674

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



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

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



486
487
488
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 486

def lookup_enabled
  @properties['lookup_enabled']
end

#messaging_configurations ⇒ messaging_configurations

Access the messaging_configurations

Returns:



640
641
642
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 640

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



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

def psd2_enabled
  @properties['psd2_enabled']
end

#push ⇒ Hash

Returns The service level configuration of factor push type.

Returns:

  • (Hash) —

    The service level configuration of factor push type.



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

def push
  @properties['push']
end

#rate_limits ⇒ rate_limits

Access the rate_limits

Returns:



633
634
635
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 633

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



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

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



498
499
500
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 498

def skip_sms_to_landlines
  @properties['skip_sms_to_landlines']
end

#to_s ⇒ Object

Provide a user friendly representation



667
668
669
670
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 667

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



510
511
512
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 510

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, custom_code_enabled: :unset, push: :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.**

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

    Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers.

  • push (Hash) (defaults to: :unset) —

    Configurations for the Push factors (channel) created under this Service. If present, it must be a json string with the following format: “ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”, “include_date”: true. If ‘include_date` is set to `true`, which is the default, that means that the push challenge’s response will include the date created value. If `include_date` is set to `false`, then the date created value will not be included. See [Challenge](www.twilio.com/docs/verify/api/challenge) resource’s details parameter for more info

Returns:



601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 601

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: :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,
      custom_code_enabled: custom_code_enabled,
      push: push,
  )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

def url
  @properties['url']
end

#verification_checks ⇒ verification_checks

Access the verification_checks

Returns:



626
627
628
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 626

def verification_checks
  context.verification_checks
end

#verifications ⇒ verifications

Access the verifications

Returns:



619
620
621
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 619

def verifications
  context.verifications
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



654
655
656
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 654

def webhooks
  context.webhooks
end