Class: XTwitterScraper::Models::X::DmSendParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/x/dm_send_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(user_id:, account:, text:, media_ids: nil, reply_to_message_id: nil, request_options: {}) ⇒ Object

Parameters:

  • user_id (String)
  • account (String)

    X account (@username or ID) sending the DM

  • text (String)
  • media_ids (Array<String>) (defaults to: nil)
  • reply_to_message_id (String) (defaults to: nil)
  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/x_twitter_scraper/models/x/dm_send_params.rb', line 37

Instance Attribute Details

#accountString

X account (@username or ID) sending the DM

Returns:

  • (String)


20
# File 'lib/x_twitter_scraper/models/x/dm_send_params.rb', line 20

required :account, String

#media_idsArray<String>?

Returns:

  • (Array<String>, nil)


30
# File 'lib/x_twitter_scraper/models/x/dm_send_params.rb', line 30

optional :media_ids, XTwitterScraper::Internal::Type::ArrayOf[String]

#reply_to_message_idString?

Returns:

  • (String, nil)


35
# File 'lib/x_twitter_scraper/models/x/dm_send_params.rb', line 35

optional :reply_to_message_id, String

#textString

Returns:

  • (String)


25
# File 'lib/x_twitter_scraper/models/x/dm_send_params.rb', line 25

required :text, String

#user_idString

Returns:

  • (String)


14
# File 'lib/x_twitter_scraper/models/x/dm_send_params.rb', line 14

required :user_id, String