Class: Onlyfans::Models::AuthenticateStartParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Onlyfans::Models::AuthenticateStartParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/onlyfans/models/authenticate_start_params.rb,
sig/onlyfans/models/authenticate_start_params.rbs

Overview

See Also:

• Onlyfans::Resources::Authenticate#start

Defined Under Namespace

Modules: AuthType, ProxyCountry Classes: CustomProxy

Instance Attribute Summary

• #auth_id ⇒ String^?

  The auth_id from OnlyFans session cookies.

• #auth_type ⇒ Symbol, ...

  The authentication method to use.

• #cookies ⇒ String^?

  The full cookie string (semicolon-separated).

• #custom_proxy ⇒ Onlyfans::Models::AuthenticateStartParams::CustomProxy^?

  Custom proxy configuration.

• #email ⇒ String^?

  The email address of the OnlyFans account.

• #force_connect ⇒ Boolean^?

  Set to true to connect the account even if it already exists.

• #name ⇒ String^?

  A display name for the account.

• #password ⇒ String^?

  The password of the OnlyFans account.

• #proxy_country ⇒ Symbol, ...

  The country of the managed proxy server you want to use.

• #user_agent ⇒ String^?

  The browser User-Agent string.

• #xbc ⇒ String^?

  The X-BC token from request headers.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(host: nil, password: nil, port: nil, username: nil) ⇒ Object constructor

  Custom proxy configuration.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(host: nil, password: nil, port: nil, username: nil) ⇒ Object

Custom proxy configuration. Cannot be used together with proxyCountry.

Parameters:

• host (String) (defaults to: nil) —

  The hostname or IP address of your custom proxy server

• password (String) (defaults to: nil) —

  The password for proxy authentication (optional)

• port (Integer) (defaults to: nil) —

  The port number of your custom proxy server (1-65535)

• username (String) (defaults to: nil) —

  The username for proxy authentication (optional)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 86

Instance Attribute Details

#auth_id ⇒ String^?

The auth_id from OnlyFans session cookies. Required when auth_type is raw_data.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 15

optional :auth_id, String

#auth_type ⇒ Symbol, ...

The authentication method to use. Defaults to email_password if omitted. Use mobile_app to authenticate via the FansAPI Auth+ mobile app (no credential fields required).

Returns:

• (Symbol, Onlyfans::Models::AuthenticateStartParams::AuthType, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 23

optional :auth_type, enum: -> { Onlyfans::AuthenticateStartParams::AuthType }

#cookies ⇒ String^?

The full cookie string (semicolon-separated). Required when auth_type is raw_data.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 30

optional :cookies, String

#custom_proxy ⇒ Onlyfans::Models::AuthenticateStartParams::CustomProxy^?

Custom proxy configuration. Cannot be used together with proxyCountry.

Returns:

• (Onlyfans::Models::AuthenticateStartParams::CustomProxy, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 36

optional :custom_proxy, -> { Onlyfans::AuthenticateStartParams::CustomProxy }, api_name: :customProxy

#email ⇒ String^?

The email address of the OnlyFans account. Required when auth_type is email_password.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 43

optional :email, String

#force_connect ⇒ Boolean^?

Set to true to connect the account even if it already exists

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 49

optional :force_connect, Onlyfans::Internal::Type::Boolean

#name ⇒ String^?

A display name for the account. If omitted, defaults to the email address or auth_id.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 56

optional :name, String

#password ⇒ String^?

The password of the OnlyFans account. Required when auth_type is email_password.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 63

optional :password, String

#proxy_country ⇒ Symbol, ...

The country of the managed proxy server you want to use. Eg. "us" for United States. Cannot be used together with customProxy.

Returns:

• (Symbol, Onlyfans::Models::AuthenticateStartParams::ProxyCountry, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 70

optional :proxy_country,
enum: -> { Onlyfans::AuthenticateStartParams::ProxyCountry },
api_name: :proxyCountry

#user_agent ⇒ String^?

The browser User-Agent string. Required when auth_type is raw_data.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 78

optional :user_agent, String

#xbc ⇒ String^?

The X-BC token from request headers. Required when auth_type is raw_data.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 84

optional :xbc, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/onlyfans/models/authenticate_start_params.rb', line 124

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/onlyfans/models/authenticate_start_params.rbs', line 88

def to_hash: -> {