CommunitiesClient

Cliente para operaciones con comunidades

Este cliente proporciona métodos para interactuar con los endpoints de comunidades 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 comunidades.

Constructores

constructor

• new CommunitiesClient(client): CommunitiesClient

Crea una nueva instancia de CommunitiesClient

Parámetros

Nombre	Type	Descripción
client	Client	La instancia principal de Client de la X API

Devuelve

CommunitiesClient

Definido en

communities/client.ts:102

Métodos

search

▸ search(query, options): Promise<Response>

Buscar comunidades Recupera una lista de comunidades que coinciden con la consulta de búsqueda especificada.

Parámetros

Nombre	type	Descripción
query	string	Consulta para buscar comunidades.
options	SearchOptions & { requestOptions: { raw: true } }	-

Devuelve

Promise<Response>

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

Definido en

communities/client.ts:147

▸ search(query, options?): Promise<Get2CommunitiesSearchResponse>

Parámetros

Nombre	Tipo
query	string
options?	SearchOptions

Devuelve

Promise<Get2CommunitiesSearchResponse>

Definido en

communities/client.ts:160

---

getById

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

Obtener una Community por identificador
Recupera los detalles de una Community específica por su identificador.

Parámetros

Nombre	Tipo	Descripción
id	string	El ID de la Comunidad.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

Devuelve

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

communities/client.ts:352

▸ getById(id, options?): Promise<Get2CommunitiesIdResponse>

Parámetros

Nombre	Tipo
id	string
options?	GetByIdOptions

Devuelve

Promise<Get2CommunitiesIdResponse>

Definido en

communities/client.ts:365