Class: WhopSDK::Models::AuthorizedUserCreateParams::Elevation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/authorized_user_create_params.rb,
sig/whop_sdk/models/authorized_user_create_params.rbs

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(authenticator_data: nil, client_data_json: nil, credential_id: nil, email_code: nil, signature: nil, totp_code: nil, use_finance_session: nil) ⇒ Object

Re-authentication proof required to perform this sensitive action.

Parameters:

  • authenticator_data (String, nil) (defaults to: nil) —

    The WebAuthn authenticator data (base64).

  • client_data_json (String, nil) (defaults to: nil) —

    The WebAuthn client data JSON (base64).

  • credential_id (String, nil) (defaults to: nil) —

    The WebAuthn credential ID (base64).

  • email_code (String, nil) (defaults to: nil) —

    The 6-digit code emailed to the user.

  • signature (String, nil) (defaults to: nil) —

    The WebAuthn signature (base64).

  • totp_code (String, nil) (defaults to: nil) —

    The 6-digit code from the authenticator app or SMS.

  • use_finance_session (Boolean, nil) (defaults to: nil) —

    Reuse an existing elevated session (for SMS/email 2FA users).



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 57

class Elevation < WhopSDK::Internal::Type::BaseModel
  # @!attribute authenticator_data
  #   The WebAuthn authenticator data (base64).
  #
  #   @return [String, nil]
  optional :authenticator_data, String, nil?: true

  # @!attribute client_data_json
  #   The WebAuthn client data JSON (base64).
  #
  #   @return [String, nil]
  optional :client_data_json, String, nil?: true

  # @!attribute credential_id
  #   The WebAuthn credential ID (base64).
  #
  #   @return [String, nil]
  optional :credential_id, String, nil?: true

  # @!attribute email_code
  #   The 6-digit code emailed to the user.
  #
  #   @return [String, nil]
  optional :email_code, String, nil?: true

  # @!attribute signature
  #   The WebAuthn signature (base64).
  #
  #   @return [String, nil]
  optional :signature, String, nil?: true

  # @!attribute totp_code
  #   The 6-digit code from the authenticator app or SMS.
  #
  #   @return [String, nil]
  optional :totp_code, String, nil?: true

  # @!attribute use_finance_session
  #   Reuse an existing elevated session (for SMS/email 2FA users).
  #
  #   @return [Boolean, nil]
  optional :use_finance_session, WhopSDK::Internal::Type::Boolean, nil?: true

  # @!method initialize(authenticator_data: nil, client_data_json: nil, credential_id: nil, email_code: nil, signature: nil, totp_code: nil, use_finance_session: nil)
  #   Re-authentication proof required to perform this sensitive action.
  #
  #   @param authenticator_data [String, nil] The WebAuthn authenticator data (base64).
  #
  #   @param client_data_json [String, nil] The WebAuthn client data JSON (base64).
  #
  #   @param credential_id [String, nil] The WebAuthn credential ID (base64).
  #
  #   @param email_code [String, nil] The 6-digit code emailed to the user.
  #
  #   @param signature [String, nil] The WebAuthn signature (base64).
  #
  #   @param totp_code [String, nil] The 6-digit code from the authenticator app or SMS.
  #
  #   @param use_finance_session [Boolean, nil] Reuse an existing elevated session (for SMS/email 2FA users).
end

Instance Attribute Details

#authenticator_data ⇒ String?

The WebAuthn authenticator data (base64).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


62
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 62

optional :authenticator_data, String, nil?: true

#client_data_json ⇒ String?

The WebAuthn client data JSON (base64).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


68
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 68

optional :client_data_json, String, nil?: true

#credential_id ⇒ String?

The WebAuthn credential ID (base64).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


74
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 74

optional :credential_id, String, nil?: true

#email_code ⇒ String?

The 6-digit code emailed to the user.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


80
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 80

optional :email_code, String, nil?: true

#signature ⇒ String?

The WebAuthn signature (base64).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


86
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 86

optional :signature, String, nil?: true

#totp_code ⇒ String?

The 6-digit code from the authenticator app or SMS.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


92
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 92

optional :totp_code, String, nil?: true

#use_finance_session ⇒ Boolean?

Reuse an existing elevated session (for SMS/email 2FA users).

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


98
 
# File 'lib/whop_sdk/models/authorized_user_create_params.rb', line 98

optional :use_finance_session, WhopSDK::Internal::Type::Boolean, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


81
 
# File 'sig/whop_sdk/models/authorized_user_create_params.rbs', line 81

def to_hash: -> {