Class: Privy::Models::OAuthInitRequestBody

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/privy/models/oauth_init_request_body.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(provider:, redirect_to:, token: nil, code_challenge: nil, state_code: nil) ⇒ Object

The request body for initiating an OAuth ceremony.

Parameters:

  • provider (Symbol, Privy::Models::ExternalOAuthProviderID, String) —

    The ID of an OAuth provider.

  • redirect_to (String)
  • token (String) (defaults to: nil)
  • code_challenge (String) (defaults to: nil)
  • state_code (String) (defaults to: nil) 



# File 'lib/privy/models/oauth_init_request_body.rb', line 32

Instance Attribute Details

#code_challenge ⇒ String?

Returns:

  • (String, nil) 


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

optional :code_challenge, String

#provider ⇒ Symbol, ...

The ID of an OAuth provider.

Returns:



10
 
# File 'lib/privy/models/oauth_init_request_body.rb', line 10

required :provider, union: -> { Privy::OAuthProviderID }

#redirect_to ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/privy/models/oauth_init_request_body.rb', line 15

required :redirect_to, String

#state_code ⇒ String?

Returns:

  • (String, nil) 


30
 
# File 'lib/privy/models/oauth_init_request_body.rb', line 30

optional :state_code, String

#token ⇒ String?

Returns:

  • (String, nil) 


20
 
# File 'lib/privy/models/oauth_init_request_body.rb', line 20

optional :token, String