> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<div id="constructors">
  ## Constructores
</div>

<div id="constructor">
  ### constructor
</div>

• **new CommunitiesClient**(`client`): [`CommunitiesClient`](/es/xdks/typescript/reference/classes/CommunitiesClient)

Crea una nueva instancia de CommunitiesClient

<div id="parameters">
  #### Parámetros
</div>

| Nombre   | Type                                                     | Descripción                                    |
| :------- | :------------------------------------------------------- | :--------------------------------------------- |
| `client` | [`Client`](/es/xdks/typescript/reference/classes/Client) | La instancia principal de `Client` de la X API |

<div id="returns">
  #### Devuelve
</div>

[`CommunitiesClient`](/es/xdks/typescript/reference/classes/CommunitiesClient)

<div id="defined-in">
  #### Definido en
</div>

[communities/client.ts:102](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L102)

<div id="methods">
  ## Métodos
</div>

<div id="search">
  ### search
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[communities/client.ts:147](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L147)

▸ **search**(`query`, `options?`): `Promise`\<[`Get2CommunitiesSearchResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesSearchResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo            |
| :--------- | :-------------- |
| `query`    | `string`        |
| `options?` | `SearchOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2CommunitiesSearchResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesSearchResponse)>

<div id="defined-in">
  #### Definido en
</div>

[communities/client.ts:160](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L160)

***

<div id="getbyid">
  ### getById
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[communities/client.ts:352](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L352)

▸ **getById**(`id`, `options?`): `Promise`\<[`Get2CommunitiesIdResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesIdResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo             |
| :--------- | :--------------- |
| `id`       | `string`         |
| `options?` | `GetByIdOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2CommunitiesIdResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesIdResponse)>

<div id="defined-in">
  #### Definido en
</div>

[communities/client.ts:365](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L365)