Class: Onlyfans::Models::SearchProfilesParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/onlyfans/models/search_profiles_params.rb

Overview

See Also:

• Resources::Search#profiles

Defined Under Namespace

Modules: Sort, SortDirection Classes: Filter

Instance Attribute Summary

• #cursor ⇒ String^?

  Cursor for pagination.

• #filter ⇒ Onlyfans::Models::SearchProfilesParams::Filter^?
• #instagram ⇒ String^?

  Filter by Instagram username.

• #limit ⇒ Integer^?

  The number of profiles to return.

• #location ⇒ String^?

  Filter by location.

• #max_subscribe_price ⇒ Float^?

  Filter by maximum subscribe price.

• #min_subscribe_price ⇒ Float^?

  Filter by minimum subscribe price.

• #query ⇒ String^?

  Query for full text search in username, display name, bio.

• #sort ⇒ Symbol, ...

  Field to sort by.

• #sort_direction ⇒ Symbol, ...

  Direction for sorting.

• #tiktok ⇒ String^?

  Filter by TikTok username.

• #website ⇒ String^?

  Filter by website.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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, #initialize, 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

This class inherits a constructor from Onlyfans::Internal::Type::BaseModel

Instance Attribute Details

#cursor ⇒ String^?

Cursor for pagination. Use the ‘next_cursor` from the previous response to get the next page of results.

Returns:

• (String, nil)

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

optional :cursor, String, nil?: true

#filter ⇒ Onlyfans::Models::SearchProfilesParams::Filter^?

Returns:

• (Onlyfans::Models::SearchProfilesParams::Filter, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 20

optional :filter, -> { Onlyfans::SearchProfilesParams::Filter }

#instagram ⇒ String^?

Filter by Instagram username.

Returns:

• (String, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 26

optional :instagram, String

#limit ⇒ Integer^?

The number of profiles to return. For each returned profile we charge your account 1 credit. Default: ‘10`. Must be at least 1. Must not be greater than 100.

Returns:

• (Integer, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 34

optional :limit, Integer

#location ⇒ String^?

Filter by location.

Returns:

• (String, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 40

optional :location, String

#max_subscribe_price ⇒ Float^?

Filter by maximum subscribe price. Must be at least 0.00.

Returns:

• (Float, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 46

optional :max_subscribe_price, Float

#min_subscribe_price ⇒ Float^?

Filter by minimum subscribe price. Must be at least 0.00.

Returns:

• (Float, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 52

optional :min_subscribe_price, Float

#query ⇒ String^?

Query for full text search in username, display name, bio. Must be at least 3 characters.

Returns:

• (String, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 59

optional :query, String

#sort ⇒ Symbol, ...

Field to sort by. ⭐️ Only available on the Pro and Enterprise plan.

Returns:

• (Symbol, Onlyfans::Models::SearchProfilesParams::Sort, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 65

optional :sort, enum: -> { Onlyfans::SearchProfilesParams::Sort }

#sort_direction ⇒ Symbol, ...

Direction for sorting. ‘desc` - highest value first. `asc` - lowest value first.

Returns:

• (Symbol, Onlyfans::Models::SearchProfilesParams::SortDirection, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 71

optional :sort_direction, enum: -> { Onlyfans::SearchProfilesParams::SortDirection }

#tiktok ⇒ String^?

Filter by TikTok username.

Returns:

• (String, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 77

optional :tiktok, String

#website ⇒ String^?

Filter by website.

Returns:

• (String, nil)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 83

optional :website, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/onlyfans/models/search_profiles_params.rb', line 145