Class: OCI::IdentityDomains::Models::UserPhoneNumbers

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/user_phone_numbers.rb

Overview

Phone numbers

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_WORK = 'work'.freeze,
  TYPE_HOME = 'home'.freeze,
  TYPE_MOBILE = 'mobile'.freeze,
  TYPE_FAX = 'fax'.freeze,
  TYPE_PAGER = 'pager'.freeze,
  TYPE_OTHER = 'other'.freeze,
  TYPE_RECOVERY = 'recovery'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserPhoneNumbers

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :value (String) —

    The value to assign to the #value property

  • :display (String) —

    The value to assign to the #display property

  • :type (String) —

    The value to assign to the #type property

  • :primary (BOOLEAN) —

    The value to assign to the #primary property

  • :verified (BOOLEAN) —

    The value to assign to the #verified property



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 130

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.value = attributes[:'value'] if attributes[:'value']

  self.display = attributes[:'display'] if attributes[:'display']

  self.type = attributes[:'type'] if attributes[:'type']

  self.primary = attributes[:'primary'] unless attributes[:'primary'].nil?

  self.verified = attributes[:'verified'] unless attributes[:'verified'].nil?
end

Instance Attribute Details

#display ⇒ String

A human-readable name, primarily used for display purposes. READ ONLY

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 49

def display
  @display
end

#primary ⇒ BOOLEAN

A Boolean value that indicates the 'primary' or preferred attribute value for this attribute–for example, the preferred phone number or primary phone number. The primary attribute value 'true' MUST appear no more than once.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


77
78
79
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 77

def primary
  @primary
end

#type ⇒ String

[Required] A label that indicates the attribute's function- for example, 'work', 'home', or 'mobile'

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 63

def type
  @type
end

#value ⇒ String

[Required] User's phone number

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 35

def value
  @value
end

#verified ⇒ BOOLEAN

A Boolean value that indicates if the phone number is verified.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


91
92
93
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 91

def verified
  @verified
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 94

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'display': :'display',
    'type': :'type',
    'primary': :'primary',
    'verified': :'verified'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 107

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'display': :'String',
    'type': :'String',
    'primary': :'BOOLEAN',
    'verified': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 167

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    value == other.value &&
    display == other.display &&
    type == other.type &&
    primary == other.primary &&
    verified == other.verified
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 201

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 181

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 190

def hash
  [value, display, type, primary, verified].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 234

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



228
229
230
 
# File 'lib/oci/identity_domains/models/user_phone_numbers.rb', line 228

def to_s
  to_hash.to_s
end