Class: XTwitterScraper::Models::X::CommunityCreateParams

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

Overview

See Also:

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

Parameters:

  • account (String) —

    X account (@username or ID) creating the community

  • name (String) —

    Community name

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

    Community description

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



# File 'lib/x_twitter_scraper/models/x/community_create_params.rb', line 29

Instance Attribute Details

#account ⇒ String

X account (@username or ID) creating the community

Returns:

  • (String) 


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

required :account, String

#description ⇒ String?

Community description

Returns:

  • (String, nil) 


27
 
# File 'lib/x_twitter_scraper/models/x/community_create_params.rb', line 27

optional :description, String

#name ⇒ String

Community name

Returns:

  • (String) 


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

required :name, String