Class: XTwitterScraper::Resources::X::Bookmarks

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/x/bookmarks.rb

Overview

X data lookups (subscription required)

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Bookmarks

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Bookmarks.

Parameters:



54
55
56
 
# File 'lib/x_twitter_scraper/resources/x/bookmarks.rb', line 54

def initialize(client:)
  @client = client
end

Instance Method Details

#list(cursor: nil, folder_id: nil, request_options: {}) ⇒ XTwitterScraper::Models::PaginatedTweets

Get bookmarked tweets

Parameters:

  • cursor (String) —

    Pagination cursor for bookmarks

  • folder_id (String) —

    Optional bookmark folder ID

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

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/x_twitter_scraper/resources/x/bookmarks.rb', line 21

def list(params = {})
  parsed, options = XTwitterScraper::X::BookmarkListParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "x/bookmarks",
    query: query.transform_keys(folder_id: "folderId"),
    model: XTwitterScraper::PaginatedTweets,
    options: options
  )
end

#retrieve_folders(request_options: {}) ⇒ XTwitterScraper::Models::X::BookmarkRetrieveFoldersResponse

Get bookmark folders

Parameters:

Returns:

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/x_twitter_scraper/resources/x/bookmarks.rb', line 42

def retrieve_folders(params = {})
  @client.request(
    method: :get,
    path: "x/bookmarks/folders",
    model: XTwitterScraper::Models::X::BookmarkRetrieveFoldersResponse,
    options: params[:request_options]
  )
end