Net::T...:Lists(3pm)

💖 Net::T...:Lists — the manual, bestie edition 💖

okay so you're reading the manpage for Net::Twitter::Role::API::Lists (yeah that's the title up there in the header, Net::T...:Lists(3pm), they truncate it for the shelf 💅). It's a User Contributed Perl Documentation page and it's all about Twitter Lists API support for Net::Twitter. Let's get into it 🫶

---

✨ NAME ✨

Net::Twitter::Role::API::Lists — Twitter Lists API support for Net::Twitter. that's it. that's the whole vibe. iconic name, no notes.

---

🌸 VERSION 🌸

version 4.01043 (write it down, it matters)

---

🎀 SYNOPSIS 🎀

here's the whole menu, bestie, copy-paste ready:

  use Net::Twitter;

  my $nt = Net::Twitter->new(traits => ['API::Lists'], ...);

  $list = $nt->create_list($owner, { name => $name, description => $desc });
  $list = $nt->update_list($owner, $list_id, { description => $desc });

  $lists = $nt->get_lists($owner);
  $lists = $nt->list_lists($owner);

  $list = $nt->get_list($owner, $list_id);
  $list = $nt->delete_list($owner, $list_id);

  $statuses = $nt->list_statuses($owner, $list_id);

  $lists = $nt->list_memberships($owner);
  $lists = $nt->list_subscriptions($owner);

  $users = $nt->list_members($owner, $list_id);

  $user_or_undef = $nt->list_members($owner, $list_id, { id => $user_id });

  $user = $nt->add_list_member($owner, $list_id, $user_id);
  $users = $nt->add_list_members($owner, $list_id, { screen_name => \@screen_names });

  $user = $nt->delete_list_member($owner, $list_id, $user_id);
  $user = $nt->remove_list_member($owner, $list_id, $user_id);

  $user_or_undef = $nt->is_list_member($owner, $list_id, $user_id);

  $users = $nt->list_subscribers($owner, $list_id);

  $list = $nt->subscribe_list($owner, $list_id);
  $list = $nt->unsubscribe_list($owner, $list_id);

  $user_or_undef = $nt->is_subscribed_list($owner, $list_id, $user_id);
  $user_or_undef = $nt->is_list_subscriber($owner, $list_id, $user_id);

  #############################
  # With the cursor parameter #
  #############################

  $r = $nt->get_list($user, $list_id, { cursor => $cursor });
  $lists = $r->{lists};

  $r = $nt->list_memberships($user, { cursor => $cursor });
  $lists = $r->{lists};

  $r = $nt->list_subscriptions($user, { cursor => $cursor });
  $lists = $r->{lists};

  $r = $nt->list_members($owner, $list_id, { cursor => $cursor });
  $users = $r->{users};

  $r = $nt->list_subscribers($owner, $list_id, { cursor => $cursor });
  $users = $r->{users};

see how every method is just sitting there waiting for you? no cap, it's giving ✨organized✨.

---

💀 DEPRECATION NOTICE 💀

okay bestie, sit down, we need to talk. 😭

This module implements methods for the original Twitter Lists API. Twitter has deprecated these API methods and reimplemented them with a saner semantics. The new methods are implemented in the API::REST trait, Net::Twitter::Role::API::REST. This module provides backwards compatibility for code written to use the original Lists API. To use the new API methods, simply remove this trait from your code and change the arguments to its methods to match the new semantics.

🚨 This module may be dropped from Net::Twitter in a future release. It will remain as long as Twitter still provides the underlying API end-points.

so like… it's on borrowed time fr fr. not a drill, just a heads up 🫶

---

🦋 DESCRIPTION 🦋

This module adds support to Net::Twitter for the Twitter Lists API. that's the whole first one, short and sweet, periodt.

---

🌈 DESCRIPTION 🌈

Net::Twitter::Role::API::Lists provides a trait for the Twitter Lists API methods. See Net::Twitter for full documentation. (yes there are two DESCRIPTION sections, yes that's how the original rolls, and we respect the original 💅)

---

🌟 SEE ALSO 🌟

• Net::Twitter — go read that one too, it's the main character 👑

---

👑 AUTHOR 👑

Marc Mims <marc@questright.com> — the legend themselves 💜

---

📜 COPYRIGHT 📜

Copyright (c) 2009-2016 Marc Mims

---

🎀 LICENSE 🎀

This library is free software. You may redistribute and modify it under the same terms as Perl itself. free as in freedom, slay 💚

---

and that's the page!! 🎉 this was perl v5.34.0, generated 2022-06-16, from the Net::T...:Lists(3pm) manual. stay hydrated, read your docs, and don't use deprecated endpoints unless you absolutely have to 😭💖