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.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 477

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'],
      'totp' => payload['totp'],
      'default_template_sid' => payload['default_template_sid'],
      '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:



759
760
761
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 759

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



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

def 
  @properties['account_sid']
end

#code_length ⇒ String

Returns The length of the verification code.

Returns:

  • (String) —

    The length of the verification code



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

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:



511
512
513
514
515
516
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 511

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.



580
581
582
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 580

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



604
605
606
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 604

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



610
611
612
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 610

def date_updated
  @properties['date_updated']
end

#default_template_sid ⇒ String

Returns The default_template_sid.

Returns:

  • (String) —

    The default_template_sid



598
599
600
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 598

def default_template_sid
  @properties['default_template_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



636
637
638
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 636

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.



574
575
576
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 574

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



562
563
564
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 562

def dtmf_input_required
  @properties['dtmf_input_required']
end

#entities ⇒ entities

Access the entities

Returns:



745
746
747
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 745

def entities
  context.entities
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



629
630
631
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 629

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



772
773
774
775
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 772

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



622
623
624
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 622

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



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

def lookup_enabled
  @properties['lookup_enabled']
end

#messaging_configurations ⇒ messaging_configurations

Access the messaging_configurations

Returns:



738
739
740
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 738

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



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

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.



586
587
588
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 586

def push
  @properties['push']
end

#rate_limits ⇒ rate_limits

Access the rate_limits

Returns:



731
732
733
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 731

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



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

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



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

def skip_sms_to_landlines
  @properties['skip_sms_to_landlines']
end

#to_s ⇒ Object

Provide a user friendly representation



765
766
767
768
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 765

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

#totp ⇒ Hash

Returns The service level configuration of factor TOTP type.

Returns:

  • (Hash) —

    The service level configuration of factor TOTP type.



592
593
594
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 592

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



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

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_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, default_template_sid: :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 30 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_include_date (Boolean) (defaults to: :unset) —

    Optional configuration for the Push factors. If true, include the date in the Challenge’s reponse. Otherwise, the date is omitted from the response. See Challenge resource’s details parameter for more info. Default: true

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

    Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See Credential Resource

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

    Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See Credential Resource

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

    Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI.

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

    Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds

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

    Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6

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

    Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1

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

    The default message template. Will be used for all SMS verifications unless explicitly overriden. SMS channel only.

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 692

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, default_template_sid: :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_include_date: push_include_date,
      push_apn_credential_sid: push_apn_credential_sid,
      push_fcm_credential_sid: push_fcm_credential_sid,
      totp_issuer: totp_issuer,
      totp_time_step: totp_time_step,
      totp_code_length: totp_code_length,
      totp_skew: totp_skew,
      default_template_sid: default_template_sid,
  )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



616
617
618
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 616

def url
  @properties['url']
end

#verification_checks ⇒ verification_checks

Access the verification_checks

Returns:



724
725
726
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 724

def verification_checks
  context.verification_checks
end

#verifications ⇒ verifications

Access the verifications

Returns:



717
718
719
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 717

def verifications
  context.verifications
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



752
753
754
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 752

def webhooks
  context.webhooks
end