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

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

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

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

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

Crea una nueva instancia de `CommunityNotesClient`

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

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

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

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

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

[community\_notes/client.ts:186](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L186)

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

<div id="searcheligibleposts">
  ### searchEligiblePosts
</div>

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

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

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

| 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

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

[community\_notes/client.ts:231](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L231)

▸ **searchEligiblePosts**(`testMode`, `options?`): `Promise`\<[`Get2NotesSearchPostsEligibleForNotesResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2NotesSearchPostsEligibleForNotesResponse)>

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

| Nombre     | Tipo                         |
| :--------- | :--------------------------- |
| `testMode` | `boolean`                    |
| `options?` | `SearchEligiblePostsOptions` |

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

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

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

[community\_notes/client.ts:244](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L244)

***

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

▸ **evaluate**(`options`): `Promise`\<`Response`>

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

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

| Nombre    | type                                                            |
| :-------- | :-------------------------------------------------------------- |
| `options` | `EvaluateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

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

`Promise`\<`Response`>

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

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

[community\_notes/client.ts:535](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L535)

▸ **evaluate**(`options?`): `Promise`\<[`EvaluateNoteResponse`](/es/xdks/typescript/reference/interfaces/Schemas.EvaluateNoteResponse)>

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

| Nombre     | type              |
| :--------- | :---------------- |
| `options?` | `EvaluateOptions` |

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

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

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

[community\_notes/client.ts:544](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L544)

***

<div id="searchwritten">
  ### searchWritten
</div>

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

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

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

| 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`  }  } | -                                                                                                                                                                          |

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

`Promise`\<`Response`>

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

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

[community\_notes/client.ts:640](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L640)

▸ **searchWritten**(`testMode`, `options?`): `Promise`\<[`Get2NotesSearchNotesWrittenResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2NotesSearchNotesWrittenResponse)>

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

| Nombre     | type                   |
| :--------- | :--------------------- |
| `testMode` | `boolean`              |
| `options?` | `SearchWrittenOptions` |

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

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

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

[community\_notes/client.ts:653](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L653)

***

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

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

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

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

| 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`

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

[community\_notes/client.ts:826](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L826)

▸ **delete**(`id`): `Promise`\<[`DeleteNoteResponse`](/es/xdks/typescript/reference/interfaces/Schemas.DeleteNoteResponse)>

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

| Nombre | Tipo     |
| :----- | :------- |
| `id`   | `string` |

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

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

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

[community\_notes/client.ts:839](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L839)

***

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

▸ **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.

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

| Nombre    | type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `CreateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

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

`Promise`\<`Response`>

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

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

[community\_notes/client.ts:926](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L926)

▸ **create**(`options?`): `Promise`\<[`CreateNoteResponse`](/es/xdks/typescript/reference/interfaces/Schemas.CreateNoteResponse)>

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

| Nombre     | type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

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

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

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

[community\_notes/client.ts:935](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L935)
