Class: Privy::Models::SiwsAuthenticateRequestBody

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/privy/models/siws_authenticate_request_body.rb

Defined Under Namespace

Modules: MessageType

Instance Attribute Summary

• #connector_type ⇒ String^?
• #message ⇒ String
• #message_type ⇒ Symbol, ...
• #mode ⇒ Symbol, ...

  Whether to allow sign-up during authentication.

• #signature ⇒ String
• #wallet_client_type ⇒ String^?

Instance Method Summary

• #initialize(message:, signature:, connector_type: nil, message_type: nil, mode: nil, wallet_client_type: nil) ⇒ Object constructor

  The request body for authenticating a SIWS ceremony.

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(message:, signature:, connector_type: nil, message_type: nil, mode: nil, wallet_client_type: nil) ⇒ Object

The request body for authenticating a SIWS ceremony.

Parameters:

• message (String)
• signature (String)
• connector_type (String, nil) (defaults to: nil)
• message_type (Symbol, Privy::Models::SiwsAuthenticateRequestBody::MessageType) (defaults to: nil)
• mode (Symbol, Privy::Models::AuthenticateModeOption) (defaults to: nil) —

  Whether to allow sign-up during authentication.

• wallet_client_type (String, nil) (defaults to: nil)

# File 'lib/privy/models/siws_authenticate_request_body.rb', line 37

Instance Attribute Details

#connector_type ⇒ String^?

Returns:

• (String, nil)

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

optional :connector_type, String, api_name: :connectorType, nil?: true

#message ⇒ String

Returns:

• (String)

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

required :message, String

#message_type ⇒ Symbol, ...

Returns:

• (Symbol, Privy::Models::SiwsAuthenticateRequestBody::MessageType, nil)

# File 'lib/privy/models/siws_authenticate_request_body.rb', line 24

optional :message_type, enum: -> { Privy::SiwsAuthenticateRequestBody::MessageType }

#mode ⇒ Symbol, ...

Whether to allow sign-up during authentication.

Returns:

• (Symbol, Privy::Models::AuthenticateModeOption, nil)

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

optional :mode, enum: -> { Privy::AuthenticateModeOption }

#signature ⇒ String

Returns:

• (String)

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

required :signature, String

#wallet_client_type ⇒ String^?

Returns:

• (String, nil)

# File 'lib/privy/models/siws_authenticate_request_body.rb', line 35

optional :wallet_client_type, String, api_name: :walletClientType, nil?: true