CommunityNotesClient

Cliente para operaciones de notas de la comunidad

Este cliente proporciona métodos para interactuar con los endpoints de notas de la comunidad de la X API. Se encarga de la autenticación, el formato de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con las notas de la comunidad.

​

Constructores

​

constructor

• new CommunityNotesClient(client): CommunityNotesClient

Crea una nueva instancia de CommunityNotesClient

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal del cliente de X API

​

Devuelve

CommunityNotesClient

​

Definido en

community_notes/client.ts:186

​

Métodos

​

searchEligiblePosts

▸ searchEligiblePosts(testMode, options): Promise<Response>

Buscar publicaciones aptas para Community Notes
Devuelve todas las publicaciones que cumplen los requisitos para Community Notes.

​

Parámetros

Nombre	Type	Descripción
testMode	boolean	Si es true, devuelve una lista de Publicaciones que son para la prueba. Si es false, devuelve una lista de Publicaciones sobre las que los bots pueden escribir notas propuestas acerca del producto.
options	SearchEligiblePostsOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

community_notes/client.ts:231

▸ searchEligiblePosts(testMode, options?): Promise<Get2NotesSearchPostsEligibleForNotesResponse>

​

Parámetros

Nombre	Tipo
testMode	boolean
options?	SearchEligiblePostsOptions

​

Devuelve

Promise<Get2NotesSearchPostsEligibleForNotesResponse>

​

Definido en

community_notes/client.ts:244

---

​

evaluate

▸ evaluate(options): Promise<Response>

Evaluar una nota de la comunidad Endpoint para evaluar una nota de la comunidad.

​

Parámetros

Nombre	type
options	EvaluateOptions & { requestOptions: { raw: true } }

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

community_notes/client.ts:535

▸ evaluate(options?): Promise<EvaluateNoteResponse>

​

Parámetros

Nombre	type
options?	EvaluateOptions

​

Devuelve

Promise<EvaluateNoteResponse>

​

Definido en

community_notes/client.ts:544

---

​

searchWritten

▸ searchWritten(testMode, options): Promise<Response>

Buscar Community Notes escritas
Devuelve todas las Community Notes que ha escrito el usuario.

​

Parámetros

Nombre	type	Descripción
testMode	boolean	Si es true, devuelve las notas que quien realiza la llamada escribió para la prueba. Si es false, devuelve las notas que quien realiza la llamada escribió en el producto.
options	SearchWrittenOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response en bruto si requestOptions.raw es true

​

Definido en

community_notes/client.ts:640

▸ searchWritten(testMode, options?): Promise<Get2NotesSearchNotesWrittenResponse>

​

Parámetros

Nombre	type
testMode	boolean
options?	SearchWrittenOptions

​

Devuelve

Promise<Get2NotesSearchNotesWrittenResponse>

​

Definido en

community_notes/client.ts:653

---

​

delete

▸ delete(id, options): Promise<Response>

Eliminar una Nota de la comunidad Elimina una Nota de la comunidad.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la Community Note que se va a eliminar.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Returns

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

community_notes/client.ts:826

▸ delete(id): Promise<DeleteNoteResponse>

​

Parámetros

Nombre	Tipo
id	string

​

Devuelve

Promise<DeleteNoteResponse>

​

Definido en

community_notes/client.ts:839

---

​

create

▸ create(options): Promise<Response>

Crear una nota de la comunidad Crea un endpoint de nota de la comunidad para el caso de uso de LLM.

​

Parámetros

Nombre	type
options	CreateOptions & { requestOptions: { raw: true } }

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

community_notes/client.ts:926

▸ create(options?): Promise<CreateNoteResponse>

​

Parámetros

Nombre	type
options?	CreateOptions

​

Devuelve

Promise<CreateNoteResponse>

​

Definido en

community_notes/client.ts:935