Class: XTwitterScraper::Models::X::DmRetrieveHistoryParams

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_retrieve_history_params.rb,
sig/x_twitter_scraper/models/x/dm_retrieve_history_params.rbs

Overview

See Also:

  • XTwitterScraper::Resources::X::Dm#retrieve_history

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

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

Some parameter documentations has been truncated, see XTwitterScraper::Models::X::DmRetrieveHistoryParams for more details.

Parameters:

  • user_id (String)
  • account (String) —

    X handle (without the @ prefix) of the connected X account used to read the co

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

    Pagination cursor for DM history

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

    Legacy pagination cursor (backward compat)

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



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

Instance Attribute Details

#account ⇒ String

X handle (without the @ prefix) of the connected X account used to read the conversation. The account must be a participant in the conversation.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :account, String

#cursor ⇒ String?

Pagination cursor for DM history

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :cursor, String

#max_id ⇒ String?

Legacy pagination cursor (backward compat)

Parameters:

  • (String)

Returns:

  • (String, nil) 


33
 
# File 'lib/x_twitter_scraper/models/x/dm_retrieve_history_params.rb', line 33

optional :max_id, String

#user_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


32
 
# File 'sig/x_twitter_scraper/models/x/dm_retrieve_history_params.rbs', line 32

def to_hash: -> {