ListsClient

​

Sous-modules

• Module xdk.lists.client
  • ListsClient
    • ListsClient.__init__()
    • ListsClient.add_member()
    • ListsClient.create()
    • ListsClient.delete()
    • ListsClient.get_by_id()
    • ListsClient.get_followers()
    • ListsClient.get_members()
    • ListsClient.get_posts()
    • ListsClient.remove_member_by_user_id()
    • ListsClient.update()
• module xdk.lists.models
  • AddMemberRequest
    • AddMemberRequest.model_config
  • AddMemberResponse
    • AddMemberResponse.model_config
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • GetByIdResponse
    • GetByIdResponse.model_config
  • GetFollowersResponse
    • GetFollowersResponse.model_config
  • GetMembersResponse
    • GetMembersResponse.model_config
  • GetPostsResponse
    • GetPostsResponse.model_config
  • RemoveMemberByUserIdResponse
    • RemoveMemberByUserIdResponse.model_config
  • UpdateRequest
    • UpdateRequest.model_config
  • UpdateResponse
    • UpdateResponse.model_config

​

Contenu du module

Ce module donne accès aux endpoints de la X API relatifs aux Listes et constitue le point d’entrée principal pour l’ensemble des fonctionnalités liées aux Listes.

​

class xdk.lists.ListsClient

Client pour les opérations sur les listes

​

Paramètres

path.client · Client

​

__init__

​

Paramètres

path.client · Client

​

add_member

Ajouter un membre à une Liste Ajoute un utilisateur à une Liste spécifique en utilisant son id.

​

Paramètres

path.id · Any

L’identifiant de la Liste à laquelle ajouter un membre.

body.body · AddMemberRequest

Corps de la requête

​

create

Créer une liste Crée une nouvelle liste pour l’utilisateur authentifié. body: Corps de la requête :returns: Données de la réponse :rtype: CreateResponse

​

Paramètres

body.body · CreateRequest

​

delete

Supprimer une Liste Supprime une Liste spécifique appartenant à l’utilisateur authentifié, identifiée par son id.

​

Paramètres

path.id · Any

L’identifiant de la liste à supprimer.

​

Renvoie

DeleteResponse - Données de réponse

​

get_by_id

Récupérer une liste par identifiant Récupère les détails d’une liste spécifique à partir de son identifiant.

​

Paramètres

path.id · Any

L’ID de la Liste.

path.list_fields · List or None · défaut: "None"

Une liste de champs de Liste, séparés par des virgules, à afficher.

path.expansions · List or None · défaut: "None"

Une liste de champs, séparés par des virgules, à développer.

path.user_fields · List or None · défaut: "None"

Une liste de champs d’utilisateur, séparés par des virgules, à afficher.

​

Renvoie

GetByIdResponse - données de la réponse

​

get_followers

Obtenir les abonnés d’une Liste Récupère les utilisateurs qui suivent une Liste spécifique, identifiée par son identifiant.

​

Paramètres

path.id · Any

L’ID de la Liste.

path.max_results · int or None · défaut: "None"

Le nombre maximal de résultats.

path.pagination_token · Any or None · défaut: "None"

Ce paramètre est utilisé pour obtenir une « page » spécifique de résultats.

path.user_fields · List or None · défaut: "None"

Une liste de champs d’utilisateur, séparés par des virgules, à afficher.

path.expansions · List or None · défaut: "None"

Une liste de champs, séparés par des virgules, à étendre.

path.tweet_fields · List or None · défaut: "None"

Une liste de champs de Tweet, séparés par des virgules, à afficher.

​

Retourne

IteratorGetFollowersResponse

​

get_members

Obtenir les membres d’une Liste Récupère la liste des utilisateurs membres d’une Liste spécifique identifiée par son id.

​

Paramètres

path.id · Any

L’identifiant de la Liste.

path.max_results · int or None · défaut: "None"

Le nombre maximal de résultats.

path.pagination_token · Any or None · défaut: "None"

Ce paramètre est utilisé pour récupérer une « page » spécifique de résultats.

path.user_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs User à afficher.

path.expansions · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs à étendre.

path.tweet_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs Tweet à afficher.

​

Retourne

IteratorGetMembersResponse

​

get_posts

Obtenir les Publications d’une Liste Récupère les publications associées à une Liste spécifique à partir de son identifiant.

​

Paramètres

path.id · Any

L’ID de la Liste.

path.max_results · int or None · défaut: "None"

Le nombre maximal de résultats.

path.pagination_token · Any or None · défaut: "None"

Ce paramètre permet d’obtenir la « page » de résultats suivante.

path.tweet_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs de Tweet à afficher.

path.expansions · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs à étendre.

path.media_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs Media à afficher.

path.poll_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs de Poll à afficher.

path.user_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs User à afficher.

path.place_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, de champs Place à afficher.

​

Renvoie

IteratorGetPostsResponse

​

remove_member_by_user_id

Supprimer un membre de Liste Supprime un utilisateur d’une Liste spécifique à partir de l’id de la Liste et de l’id de l’utilisateur.

​

Paramètres

path.id · Any

L’identifiant de la Liste à partir de laquelle supprimer un membre.

path.user_id · Any

L’identifiant de l’utilisateur à supprimer de la Liste.

​

Renvoie

RemoveMemberByUserIdResponse - Données de la réponse

​

update

Mettre à jour une Liste Met à jour les détails d’une liste spécifique appartenant à l’utilisateur authentifié, via son id.

​

Paramètres

path.id · Any

L’identifiant de la Liste à modifier.

body.body · UpdateRequest

Corps de la requête