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

Client pour les opérations Community Notes

Ce client fournit des méthodes pour interagir avec les endpoints Community Notes
de la X API. Il gère l’authentification, le formatage des requêtes et l’analyse des réponses
pour toutes les opérations liées à Community Notes.

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

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

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

Crée une nouvelle instance de `CommunityNotesClient`.

<div id="parameters">
  #### Paramètres
</div>

| Nom      | Type                                                     | Description                                            |
| :------- | :------------------------------------------------------- | :----------------------------------------------------- |
| `client` | [`Client`](/fr/xdks/typescript/reference/classes/Client) | L’instance principale de la classe `Client` pour X API |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</div>

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

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

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

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

Rechercher les publications éligibles aux Community Notes\
Renvoie toutes les publications éligibles aux Community Notes.

<div id="parameters">
  #### Paramètres
</div>

| Name       | Type                                                                       | Description                                                                                                                                                                                      |
| :--------- | :------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `testMode` | `boolean`                                                                  | Si `true`, renvoie une liste de Publications destinées au test. Si `false`, renvoie une liste de Publications sur lesquelles les bots peuvent rédiger des notes proposées concernant le produit. |
| `options`  | `SearchEligiblePostsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                                                                                                                                |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou avec l’objet `Response` brut si `requestOptions.raw` est à `true`

<div id="defined-in">
  #### Défini dans
</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`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2NotesSearchPostsEligibleForNotesResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                         |
| :--------- | :--------------------------- |
| `testMode` | `boolean`                    |
| `options?` | `SearchEligiblePostsOptions` |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</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`>

Évaluer une Community Note
Endpoint permettant d’évaluer une Community Note.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                            |
| :-------- | :-------------------------------------------------------------- |
| `options` | `EvaluateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Renvoie

`Promise`\<`Response`>

Promesse résolue avec la réponse de l'API, ou l'objet `Response` brut si `requestOptions.raw` vaut `true`

<div id="defined-in">
  #### Défini dans
</div>

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type              |
| :--------- | :---------------- |
| `options?` | `EvaluateOptions` |

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

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

<div id="defined-in">
  #### Défini dans
</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`>

Rechercher les Community Notes rédigées\
Renvoie toutes les Community Notes que l’utilisateur a rédigées.

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                                                                 | Description                                                                                                                                |
| :--------- | :------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- |
| `testMode` | `boolean`                                                            | Si `true`, renvoie les notes que l’appelant a écrites pour le test. Si `false`, renvoie les notes que l’appelant a écrites sur le produit. |
| `options`  | `SearchWrittenOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                                                                          |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout en la réponse de l’API, ou en `Response` brute si `requestOptions.raw` est `true`

<div id="defined-in">
  #### Défini dans
</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`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2NotesSearchNotesWrittenResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                   |
| :--------- | :--------------------- |
| `testMode` | `boolean`              |
| `options?` | `SearchWrittenOptions` |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</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`>

Supprimer une Community Note
Supprime une Community Note.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type     | Description                                   |
| :--------------------------- | :------- | :-------------------------------------------- |
| `id`                         | `string` | L'id de la note de la communauté à supprimer. |
| `options`                    | `Object` | -                                             |
| `options.requestOptions`     | `Object` | -                                             |
| `options.requestOptions.raw` | `true`   | -                                             |

#### Renvoie

`Promise`\<`Response`>

Promise résolue avec la réponse de l'API, ou l'objet `Response` brut si `requestOptions.raw` vaut `true`

<div id="defined-in">
  #### Défini dans
</div>

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom  | Type     |
| :--- | :------- |
| `id` | `string` |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</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`>

Créer une Community Note
Crée un endpoint Community Note pour des cas d’utilisation de LLM.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `CreateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout en réponse de l’API, ou en objet Response brut si `requestOptions.raw` est à true

<div id="defined-in">
  #### Défini dans
</div>

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</div>

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