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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::X::DmRetrieveHistoryParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/x_twitter_scraper/models/x/dm_retrieve_history_params.rb

Overview

See Also:

• Resources::X::Dm#retrieve_history

Instance Attribute Summary

• #cursor ⇒ String^?

  Pagination cursor for DM history.

• #max_id ⇒ String^?

  Legacy pagination cursor (backward compat).

• #user_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(user_id:, cursor: nil, max_id: nil, request_options: {}) ⇒ Object constructor

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

Parameters:

• user_id (String)
• 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 28

Instance Attribute Details

#cursor ⇒ String^?

Pagination cursor for DM history

Returns:

• (String, nil)

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

optional :cursor, String

#max_id ⇒ String^?

Legacy pagination cursor (backward compat)

Returns:

• (String, nil)

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

optional :max_id, String

#user_id ⇒ String

Returns:

• (String)

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

required :user_id, String