Class: OCI::IdentityDomains::Models::UserEmails

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

Overview

A complex attribute representing emails

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_WORK = 'work'.freeze,
  TYPE_HOME = 'home'.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 = {}) ⇒ UserEmails

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

  • :type (String) —

    The value to assign to the #type property

  • :primary (BOOLEAN) —

    The value to assign to the #primary property

  • :secondary (BOOLEAN) —

    The value to assign to the #secondary property

  • :verified (BOOLEAN) —

    The value to assign to the #verified property

  • :pending_verification_data (String) —

    The value to assign to the #pending_verification_data property



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 147

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.type = attributes[:'type'] if attributes[:'type']

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

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

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

  self.pending_verification_data = attributes[:'pendingVerificationData'] if attributes[:'pendingVerificationData']

  raise 'You cannot provide both :pendingVerificationData and :pending_verification_data' if attributes.key?(:'pendingVerificationData') && attributes.key?(:'pending_verification_data')

  self.pending_verification_data = attributes[:'pending_verification_data'] if attributes[:'pending_verification_data']
end

Instance Attribute Details

#pending_verification_data ⇒ String

Pending e-mail address verification

Added In: 19.1.4

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

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 105

def pending_verification_data
  @pending_verification_data
end

#primary ⇒ BOOLEAN

A Boolean value that indicates whether the email address is the primary email address. 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) 


60
61
62
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 60

def primary
  @primary
end

#secondary ⇒ BOOLEAN

A Boolean value that indicates whether the email address is the secondary email address. The secondary attribute value 'true' MUST appear no more than once.

Added In: 18.2.6

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

Returns:

  • (BOOLEAN) 


76
77
78
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 76

def secondary
  @secondary
end

#type ⇒ String

[Required] Type of email address

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 46

def type
  @type
end

#value ⇒ String

[Required] Email address

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 32

def value
  @value
end

#verified ⇒ BOOLEAN

A Boolean value that indicates whether or not the e-mail address is verified

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

Returns:

  • (BOOLEAN) 


90
91
92
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 90

def verified
  @verified
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'type': :'String',
    'primary': :'BOOLEAN',
    'secondary': :'BOOLEAN',
    'verified': :'BOOLEAN',
    'pending_verification_data': :'String'
    # 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



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 190

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

  self.class == other.class &&
    value == other.value &&
    type == other.type &&
    primary == other.primary &&
    secondary == other.secondary &&
    verified == other.verified &&
    pending_verification_data == other.pending_verification_data
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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 225

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


205
206
207
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 205

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



214
215
216
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 214

def hash
  [value, type, primary, secondary, verified, pending_verification_data].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 258

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



252
253
254
 
# File 'lib/oci/identity_domains/models/user_emails.rb', line 252

def to_s
  to_hash.to_s
end