Class: Onlyfans::Models::MediaUploadParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/onlyfans/models/media_upload_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(account:, async: nil, file: nil, file_url: nil, type: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Onlyfans::Models::MediaUploadParams for more details.

Parameters:

  • account (String)
  • async (Boolean) (defaults to: nil) —

    Set to ‘true` to process uploads in the background. Returns a `polling_url` to c

  • file (Pathname, StringIO, IO, String, Onlyfans::FilePart) (defaults to: nil) —

    The file to upload. Required if ‘file_url` is not provided. Maximum file size: 1

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

    A URL to download the file from. Required if ‘file` is not provided. Maximum fil

  • type (Symbol, Onlyfans::Models::MediaUploadParams::Type) (defaults to: nil) —

    Set to ‘avatar` if this file will be used as a profile picture, `header` for a p

  • request_options (Onlyfans::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



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

Instance Attribute Details

#account ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/onlyfans/models/media_upload_params.rb', line 13

required :account, String

#async ⇒ Boolean?

Set to ‘true` to process uploads in the background. Returns a `polling_url` to check status. Recommended for large files.

Returns:

  • (Boolean, nil) 


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

optional :async, Onlyfans::Internal::Type::Boolean

#file ⇒ Pathname, ...

The file to upload. Required if ‘file_url` is not provided. Maximum file size: 100 MB (limited by Cloudflare).

Returns:



27
 
# File 'lib/onlyfans/models/media_upload_params.rb', line 27

optional :file, Onlyfans::Internal::Type::FileInput

#file_url ⇒ String?

A URL to download the file from. Required if ‘file` is not provided. Maximum file size depends on the subscription configuration.

Returns:

  • (String, nil) 


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

optional :file_url, String

#type ⇒ Symbol, ...

Set to ‘avatar` if this file will be used as a profile picture, `header` for a profile banner, or keep empty if this file will be for anything else.

Returns:



41
 
# File 'lib/onlyfans/models/media_upload_params.rb', line 41

optional :type, enum: -> { Onlyfans::MediaUploadParams::Type }