Class: Privy::Models::AuthenticatedUser

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::AuthenticatedUser

Defined in:

lib/privy/models/authenticated_user.rb

Defined Under Namespace

Modules: SessionUpdateAction

Instance Attribute Summary

• #identity_token ⇒ String^?
• #is_new_user ⇒ Boolean^?
• #oauth_tokens ⇒ Privy::Models::OAuthTokens^?

  OAuth tokens associated with the user.

• #privy_access_token ⇒ String^?
• #refresh_token ⇒ String^?
• #session_update_action ⇒ Symbol, Privy::Models::AuthenticatedUser::SessionUpdateAction

  Instructs the client on how to handle tokens received.

• #token ⇒ String^?
• #user ⇒ Privy::Models::User

  A Privy user object.

Instance Method Summary

• #initialize(token:, privy_access_token:, refresh_token:, session_update_action:, user:, identity_token: nil, is_new_user: nil, oauth_tokens: nil) ⇒ Object constructor

  The authenticated user.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(token:, privy_access_token:, refresh_token:, session_update_action:, user:, identity_token: nil, is_new_user: nil, oauth_tokens: nil) ⇒ Object

The authenticated user.

Parameters:

• token (String, nil)
• privy_access_token (String, nil)
• refresh_token (String, nil)
• session_update_action (Symbol, Privy::Models::AuthenticatedUser::SessionUpdateAction) —

  Instructs the client on how to handle tokens received

• user (Privy::Models::User) —

  A Privy user object.

• identity_token (String) (defaults to: nil)
• is_new_user (Boolean) (defaults to: nil)
• oauth_tokens (Privy::Models::OAuthTokens) (defaults to: nil) —

  OAuth tokens associated with the user.

# File 'lib/privy/models/authenticated_user.rb', line 49

Instance Attribute Details

#identity_token ⇒ String^?

Returns:

• (String, nil)

# File 'lib/privy/models/authenticated_user.rb', line 36

optional :identity_token, String

#is_new_user ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/privy/models/authenticated_user.rb', line 41

optional :is_new_user, Privy::Internal::Type::Boolean

#oauth_tokens ⇒ Privy::Models::OAuthTokens^?

OAuth tokens associated with the user.

Returns:

• (Privy::Models::OAuthTokens, nil)

# File 'lib/privy/models/authenticated_user.rb', line 47

optional :oauth_tokens, -> { Privy::OAuthTokens }

#privy_access_token ⇒ String^?

Returns:

• (String, nil)

# File 'lib/privy/models/authenticated_user.rb', line 14

required :privy_access_token, String, nil?: true

#refresh_token ⇒ String^?

Returns:

• (String, nil)

# File 'lib/privy/models/authenticated_user.rb', line 19

required :refresh_token, String, nil?: true

#session_update_action ⇒ Symbol, Privy::Models::AuthenticatedUser::SessionUpdateAction

Instructs the client on how to handle tokens received

Returns:

• (Symbol, Privy::Models::AuthenticatedUser::SessionUpdateAction)

# File 'lib/privy/models/authenticated_user.rb', line 25

required :session_update_action, enum: -> { Privy::AuthenticatedUser::SessionUpdateAction }

#token ⇒ String^?

Returns:

• (String, nil)

# File 'lib/privy/models/authenticated_user.rb', line 9

required :token, String, nil?: true

#user ⇒ Privy::Models::User

A Privy user object.

Returns:

• (Privy::Models::User)

# File 'lib/privy/models/authenticated_user.rb', line 31

required :user, -> { Privy::User }