Class: XTwitterScraper::Resources::X::Users::Follow

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/x/users/follow.rb,
sig/x_twitter_scraper/resources/x/users/follow.rbs

Overview

X write actions (tweets, likes, follows, DMs)

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Follow

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 Follow.

Parameters:



78
79
80
 
# File 'lib/x_twitter_scraper/resources/x/users/follow.rb', line 78

def initialize(client:)
  @client = client
end

Instance Method Details

#create(id, account:, idempotency_key:, request_options: {}) ⇒ XTwitterScraper::Models::X::Users::FollowCreateResponse

Some parameter documentations has been truncated, see Models::X::Users::FollowCreateParams for more details.

Follow user

Parameters:

  • id (String) —

    Path param: User ID to follow

  • account (String) —

    Body param: X account identifier (@username or account ID)

  • idempotency_key (String) —

    Header param: Generate one unique value for each intended write. Reuse it only w

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

Returns:

See Also:



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/x_twitter_scraper/resources/x/users/follow.rb', line 31

def create(id, params)
  parsed, options = XTwitterScraper::X::Users::FollowCreateParams.dump_request(params)
  header_params = {idempotency_key: "idempotency-key"}
  @client.request(
    method: :post,
    path: ["x/users/%1$s/follow", id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: XTwitterScraper::Models::X::Users::FollowCreateResponse,
    options: options
  )
end

#delete_all(id, account:, idempotency_key:, request_options: {}) ⇒ XTwitterScraper::Models::X::Users::FollowDeleteAllResponse

Some parameter documentations has been truncated, see Models::X::Users::FollowDeleteAllParams for more details.

Unfollow user

Parameters:

  • id (String) —

    Path param: User ID to unfollow

  • account (String) —

    Body param: X account identifier (@username or account ID)

  • idempotency_key (String) —

    Header param: Generate one unique value for each intended write. Reuse it only w

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

Returns:

See Also:



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/x_twitter_scraper/resources/x/users/follow.rb', line 62

def delete_all(id, params)
  parsed, options = XTwitterScraper::X::Users::FollowDeleteAllParams.dump_request(params)
  header_params = {idempotency_key: "idempotency-key"}
  @client.request(
    method: :delete,
    path: ["x/users/%1$s/follow", id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: XTwitterScraper::Models::X::Users::FollowDeleteAllResponse,
    options: options
  )
end