Class: OryClient::UpdateIdentityBody

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/update_identity_body.rb

Overview

Update Identity Body

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateIdentityBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ory-client/models/update_identity_body.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::UpdateIdentityBody` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::UpdateIdentityBody`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'credentials')
    self.credentials = attributes[:'credentials']
  end

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

  if attributes.key?(:'metadata_admin')
    self.metadata_admin = attributes[:'metadata_admin']
  end

  if attributes.key?(:'metadata_public')
    self.metadata_public = attributes[:'metadata_public']
  end

  if attributes.key?(:'schema_id')
    self.schema_id = attributes[:'schema_id']
  else
    self.schema_id = nil
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = nil
  end

  if attributes.key?(:'traits')
    self.traits = attributes[:'traits']
  else
    self.traits = nil
  end
end

Instance Attribute Details

#credentials ⇒ Object

Returns the value of attribute credentials.



19
20
21
 
# File 'lib/ory-client/models/update_identity_body.rb', line 19

def credentials
  @credentials
end

#external_id ⇒ Object

ExternalID is an optional external ID of the identity. This is used to link the identity to an external system. If set, the external ID must be unique across all identities.



22
23
24
 
# File 'lib/ory-client/models/update_identity_body.rb', line 22

def external_id
  @external_id
end

#metadata_admin ⇒ Object

Store metadata about the user which is only accessible through admin APIs such as ‘GET /admin/identities/<id>`.



25
26
27
 
# File 'lib/ory-client/models/update_identity_body.rb', line 25

def metadata_admin
  @metadata_admin
end

#metadata_public ⇒ Object

Store metadata about the identity which the identity itself can see when calling for example the session endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field.



28
29
30
 
# File 'lib/ory-client/models/update_identity_body.rb', line 28

def metadata_public
  @metadata_public
end

#schema_id ⇒ Object

SchemaID is the ID of the JSON Schema to be used for validating the identity’s traits. If set will update the Identity’s SchemaID.



31
32
33
 
# File 'lib/ory-client/models/update_identity_body.rb', line 31

def schema_id
  @schema_id
end

#state ⇒ Object

State is the identity’s state. active StateActive inactive StateInactive



34
35
36
 
# File 'lib/ory-client/models/update_identity_body.rb', line 34

def state
  @state
end

#traits ⇒ Object

Traits represent an identity’s traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in schema_id.



37
38
39
 
# File 'lib/ory-client/models/update_identity_body.rb', line 37

def traits
  @traits
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



75
76
77
 
# File 'lib/ory-client/models/update_identity_body.rb', line 75

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/ory-client/models/update_identity_body.rb', line 80

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ory-client/models/update_identity_body.rb', line 62

def self.attribute_map
  {
    :'credentials' => :'credentials',
    :'external_id' => :'external_id',
    :'metadata_admin' => :'metadata_admin',
    :'metadata_public' => :'metadata_public',
    :'schema_id' => :'schema_id',
    :'state' => :'state',
    :'traits' => :'traits'
  }
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/ory-client/models/update_identity_body.rb', line 247

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
102
103
 
# File 'lib/ory-client/models/update_identity_body.rb', line 98

def self.openapi_nullable
  Set.new([
    :'metadata_admin',
    :'metadata_public',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ory-client/models/update_identity_body.rb', line 85

def self.openapi_types
  {
    :'credentials' => :'IdentityWithCredentials',
    :'external_id' => :'String',
    :'metadata_admin' => :'Object',
    :'metadata_public' => :'Object',
    :'schema_id' => :'String',
    :'state' => :'String',
    :'traits' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ory-client/models/update_identity_body.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      credentials == o.credentials &&
      external_id == o.external_id &&
      metadata_admin == o.metadata_admin &&
      metadata_public == o.metadata_public &&
      schema_id == o.schema_id &&
      state == o.state &&
      traits == o.traits
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
 
# File 'lib/ory-client/models/update_identity_body.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/ory-client/models/update_identity_body.rb', line 240

def hash
  [credentials, external_id, metadata_admin, metadata_public, schema_id, state, traits].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/ory-client/models/update_identity_body.rb', line 158

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @schema_id.nil?
    invalid_properties.push('invalid value for "schema_id", schema_id cannot be nil.')
  end

  if @state.nil?
    invalid_properties.push('invalid value for "state", state cannot be nil.')
  end

  if @traits.nil?
    invalid_properties.push('invalid value for "traits", traits cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/ory-client/models/update_identity_body.rb', line 269

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



178
179
180
181
182
183
184
185
186
 
# File 'lib/ory-client/models/update_identity_body.rb', line 178

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @schema_id.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["active", "inactive"])
  return false unless state_validator.valid?(@state)
  return false if @traits.nil?
  true
end