Saltar al contenido principal

​
Submódulos

​
Contenido del módulo

Este módulo ofrece acceso a los endpoints de Listas de la X API y sirve como punto de entrada principal para toda la funcionalidad relacionada con Listas.

​
class xdk.lists.ListsClient

Cliente para operaciones con listas

​
Parámetros

​
path.client
Client

​
__init__

​
Parámetros

​
path.client
Client

​
add_member

Agregar miembro a la Lista Agrega un usuario a una Lista específica identificada por su id.

​
Parámetros

​
path.id
Any
El identificador de la Lista para la que se va a agregar un miembro.
​
body.body
AddMemberRequest
Cuerpo de la solicitud

​
create

Crear Lista Crea una nueva Lista para el usuario autenticado. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateResponse

​
Parámetros

​
body.body
CreateRequest

​
delete

Eliminar Lista Elimina una Lista específica que pertenece al usuario autenticado mediante su identificador.

​
Parámetros

​
path.id
Any
El id de la Lista que se va a eliminar.

​
Devuelve

DeleteResponse - Datos de respuesta

​
get_by_id

Obtener una Lista por id Obtiene los detalles de una Lista específica por su id.

​
Parámetros

​
path.id
Any
El identificador de la Lista.
​
path.list_fields
List or None
predeterminado:"None"
Una lista de campos de la Lista, separados por comas, para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista de campos a expandir, separados por comas.
​
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de usuario, separados por comas, para mostrar.

​
Devuelve

GetByIdResponse - Datos de la respuesta

​
get_followers

Obtener seguidores de una Lista Obtiene una lista de usuarios que siguen una Lista específica mediante su id.

​
Parámetros

​
path.id
Any
El ID de la Lista.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se utiliza para obtener una “página” específica de resultados.
​
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de usuario separados por comas que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista de campos separados por comas que se deben expandir.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista de campos de Tweet separados por comas que se mostrarán.

​
Devuelve

IteratorGetFollowersResponse

​
get_members

Obtener miembros de la Lista Obtiene una lista de usuarios que son miembros de una Lista específica por su identificador.

​
Parámetros

​
path.id
Any
El identificador de la Lista.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se utiliza para obtener una «página» específica de resultados.
​
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de usuario, separada por comas, que se van a mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista de campos, separada por comas, que se van a expandir.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista de campos de Tweet, separada por comas, que se van a mostrar.

​
Devuelve

IteratorGetMembersResponse

​
get_posts

Obtiene las Publicaciones de una Lista Recupera una lista de Publicaciones asociadas a una Lista específica identificada por su id.

​
Parámetros

​
path.id
Any
El ID de la Lista.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente página de resultados.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista de campos de Tweet separados por comas para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista de campos separados por comas para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista de campos de medios separados por comas para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista de campos de encuestas separados por comas para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de usuarios separados por comas para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista de campos de lugares separados por comas para mostrar.

​
Devuelve

IteratorGetPostsResponse

​
remove_member_by_user_id

Eliminar miembro de la Lista Elimina a un usuario de una Lista específica mediante su id y la id del usuario.

​
Parámetros

​
path.id
Any
El id de la Lista de la que se eliminará un miembro.
​
path.user_id
Any
El id del usuario que se eliminará de la Lista.

​
Devuelve

RemoveMemberByUserIdResponse - Datos de la respuesta

​
update

Actualizar Lista Actualiza los detalles de una Lista específica, perteneciente al usuario autenticado, mediante su id.

​
Parámetros

​
path.id
Any
El ID de la Lista que se va a modificar.
​
body.body
UpdateRequest
Cuerpo de la solicitud