Class: Zitadel::Client::Models::OIDCServiceAuthRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/zitadel/client/models/o_i_d_c_service_auth_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OIDCServiceAuthRequest

Initializes the object



98
99
100
101
102
103
104
105
106
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
155
156
157
158
159
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    # MODIFIED: Updated class name in error message
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zitadel::Client::Models::OIDCServiceAuthRequest` 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))
      # MODIFIED: Updated class name in error message
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zitadel::Client::Models::OIDCServiceAuthRequest`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

  if attributes.key?(:'scope')
    if (value = attributes[:'scope']).is_a?(Array)
      self.scope = value
    end
  end

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

  if attributes.key?(:'prompt')
    if (value = attributes[:'prompt']).is_a?(Array)
      self.prompt = value
    end
  end

  if attributes.key?(:'ui_locales')
    if (value = attributes[:'ui_locales']).is_a?(Array)
      self.ui_locales = value
    end
  end

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

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

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

Instance Attribute Details

#client_id ⇒ Object

OIDC client ID of the application that created the auth request



25
26
27
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 25

def client_id
  @client_id
end

#creation_date ⇒ Object

Time when the auth request was created



22
23
24
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 22

def creation_date
  @creation_date
end

#hint_user_id ⇒ Object

User ID taken from a ID Token Hint if it was present and valid.



46
47
48
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 46

def hint_user_id
  @hint_user_id
end

#id ⇒ Object

ID of the authorization request



19
20
21
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 19

def id
  @id
end

#login_hint ⇒ Object

Login hint can be set by the application with a user identifier such as an email or phone number.



40
41
42
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 40

def 
  @login_hint
end

#max_age ⇒ Object

Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated. If the elapsed time is greater than this value, or the field is present with 0 duration, the user must be re-authenticated.



43
44
45
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 43

def max_age
  @max_age
end

#prompt ⇒ Object

Prompts that must be displayed to the user



34
35
36
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 34

def prompt
  @prompt
end

#redirect_uri ⇒ Object

Base URI that points back to the application



31
32
33
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 31

def redirect_uri
  @redirect_uri
end

#scope ⇒ Object

Requested scopes by the application, which the user must consent to.



28
29
30
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 28

def scope
  @scope
end

#ui_locales ⇒ Object

End-User’s preferred languages and scripts for the user interface, represented as a list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value [fr-CA, fr, en] represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported.



37
38
39
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 37

def ui_locales
  @ui_locales
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 232

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf/anyOf constructs that resolve to a model name
    # MODIFIED: Ensure model is looked up in the Models namespace
    # 'type' here is expected to be the simple class name (e.g., "User", "OrderDetails")
    klass = Zitadel::Client::Models.const_get(type)
    # The `klass.build` method is for oneOf/anyOf types (defined in partial_oneof_module.mustache / partial_anyof_module.mustache)
    # The `klass.build_from_hash` is for regular model types (defined in this base_object.mustache itself)
    if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_allOf)
      klass.build(value) # For oneOf/anyOf/allOf, delegate to their specific build method
    else
      klass.build_from_hash(value) # For regular models
    end
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



65
66
67
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 70

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 49

def self.attribute_map
  {
    :'id' => :'id',
    :'creation_date' => :'creationDate',
    :'client_id' => :'clientId',
    :'scope' => :'scope',
    :'redirect_uri' => :'redirectUri',
    :'prompt' => :'prompt',
    :'ui_locales' => :'uiLocales',
    :'login_hint' => :'loginHint',
    :'max_age' => :'maxAge',
    :'hint_user_id' => :'hintUserId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 208

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) # `new` will call the initialize method of the specific model class.
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 91

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 75

def self.openapi_types
  {
    :'id' => :'String',
    :'creation_date' => :'Time',
    :'client_id' => :'String',
    :'scope' => :'Array<String>',
    :'redirect_uri' => :'String',
    :'prompt' => :'Array<OIDCServicePrompt>',
    :'ui_locales' => :'Array<String>',
    :'login_hint' => :'String',
    :'max_age' => :'String',
    :'hint_user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      creation_date == o.creation_date &&
      client_id == o.client_id &&
      scope == o.scope &&
      redirect_uri == o.redirect_uri &&
      prompt == o.prompt &&
      ui_locales == o.ui_locales &&
       == o. &&
      max_age == o.max_age &&
      hint_user_id == o.hint_user_id
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 311

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


195
196
197
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



201
202
203
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 201

def hash
  [id, creation_date, client_id, scope, redirect_uri, prompt, ui_locales, , max_age, hint_user_id].hash
end

#list_invalid_properties ⇒ Object

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



163
164
165
166
167
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 163

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



287
288
289
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 287

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 293

def to_hash
  hash = {} # Calls super.to_hash if parent exists
  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

#to_s ⇒ String

Returns the string representation of the object



281
282
283
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 281

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



171
172
173
174
 
# File 'lib/zitadel/client/models/o_i_d_c_service_auth_request.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end