Class: GetStream::Generated::Models::SIPPinProtectionConfigsRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/sip_pin_protection_configs_request.rb

Overview

Configuration for PIN protection settings

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ SIPPinProtectionConfigsRequest

Initialize with attributes



26
27
28
29
30
31
32
 
# File 'lib/getstream_ruby/generated/models/sip_pin_protection_configs_request.rb', line 26

def initialize(attributes = {})
  super(attributes)
  @default_pin = attributes[:default_pin] || attributes['default_pin'] || nil
  @enabled = attributes[:enabled] || attributes['enabled'] || nil
  @max_attempts = attributes[:max_attempts] || attributes['max_attempts'] || nil
  @required_pin_digits = attributes[:required_pin_digits] || attributes['required_pin_digits'] || nil
end

Instance Attribute Details

#default_pin ⇒ String

Returns Default PIN to use if there is no PIN set on the call object.

Returns:

  • (String) —

    Default PIN to use if there is no PIN set on the call object



14
15
16
 
# File 'lib/getstream_ruby/generated/models/sip_pin_protection_configs_request.rb', line 14

def default_pin
  @default_pin
end

#enabled ⇒ Boolean

Returns Whether PIN protection is enabled.

Returns:

  • (Boolean) —

    Whether PIN protection is enabled



17
18
19
 
# File 'lib/getstream_ruby/generated/models/sip_pin_protection_configs_request.rb', line 17

def enabled
  @enabled
end

#max_attempts ⇒ Integer

Returns Maximum number of PIN attempts allowed.

Returns:

  • (Integer) —

    Maximum number of PIN attempts allowed



20
21
22
 
# File 'lib/getstream_ruby/generated/models/sip_pin_protection_configs_request.rb', line 20

def max_attempts
  @max_attempts
end

#required_pin_digits ⇒ Integer

Returns Number of digits required for the PIN.

Returns:

  • (Integer) —

    Number of digits required for the PIN



23
24
25
 
# File 'lib/getstream_ruby/generated/models/sip_pin_protection_configs_request.rb', line 23

def required_pin_digits
  @required_pin_digits
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



35
36
37
38
39
40
41
42
 
# File 'lib/getstream_ruby/generated/models/sip_pin_protection_configs_request.rb', line 35

def self.json_field_mappings
  {
    default_pin: 'default_pin',
    enabled: 'enabled',
    max_attempts: 'max_attempts',
    required_pin_digits: 'required_pin_digits'
  }
end