Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
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.
• new CommunitiesClient(client): CommunitiesClient
Crea una nueva instancia de CommunitiesClient
| Nombre | Type | Descripción |
|---|
client | Client | La instancia principal de Client de la X API |
CommunitiesClient
communities/client.ts:102
▸ search(query, options): Promise<Response>
Buscar comunidades
Recupera una lista de comunidades que coinciden con la consulta de búsqueda especificada.
| Nombre | type | Descripción |
|---|
query | string | Consulta para buscar comunidades. |
options | SearchOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o un Response sin procesar si requestOptions.raw es true
communities/client.ts:147
▸ search(query, options?): Promise<Get2CommunitiesSearchResponse>
| Nombre | Tipo |
|---|
query | string |
options? | SearchOptions |
Promise<Get2CommunitiesSearchResponse>
communities/client.ts:160
▸ getById(id, options): Promise<Response>
Obtener una Community por identificador
Recupera los detalles de una Community específica por su identificador.
| Nombre | Tipo | Descripción |
|---|
id | string | El ID de la Comunidad. |
options | GetByIdOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
communities/client.ts:352
▸ getById(id, options?): Promise<Get2CommunitiesIdResponse>
| Nombre | Tipo |
|---|
id | string |
options? | GetByIdOptions |
Promise<Get2CommunitiesIdResponse>
communities/client.ts:365
