Class: XTwitterScraper::Models::X::ProfileUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/x/profile_update_params.rb

Overview

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:, description: nil, location: nil, name: nil, url: nil, request_options: {}) ⇒ Object

Parameters:

  • account (String)

    X account (@username or ID) to update profile

  • description (String) (defaults to: nil)

    Bio description

  • location (String) (defaults to: nil)
  • name (String) (defaults to: nil)

    Display name

  • url (String) (defaults to: nil)

    Website URL

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


# File 'lib/x_twitter_scraper/models/x/profile_update_params.rb', line 40

Instance Attribute Details

#accountString

X account (@username or ID) to update profile

Returns:

  • (String)


15
# File 'lib/x_twitter_scraper/models/x/profile_update_params.rb', line 15

required :account, String

#descriptionString?

Bio description

Returns:

  • (String, nil)


21
# File 'lib/x_twitter_scraper/models/x/profile_update_params.rb', line 21

optional :description, String

#locationString?

Returns:

  • (String, nil)


26
# File 'lib/x_twitter_scraper/models/x/profile_update_params.rb', line 26

optional :location, String

#nameString?

Display name

Returns:

  • (String, nil)


32
# File 'lib/x_twitter_scraper/models/x/profile_update_params.rb', line 32

optional :name, String

#urlString?

Website URL

Returns:

  • (String, nil)


38
# File 'lib/x_twitter_scraper/models/x/profile_update_params.rb', line 38

optional :url, String