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

# paginator

Outils de pagination à base de curseur pour le SDK X API.

Ce module fournit une classe Cursor pour une gestion élégante de la pagination sur
l’ensemble des clients API. Cursor permet d’itérer facilement sur les résultats paginés
en utilisant les méthodes .pages() et .items() avec une sécurité de typage appropriée.

<div id="class-xdkpaginatorcursor">
  ### `class xdk.paginator.Cursor`
</div>

\[`ResponseType`]

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

<ParamField path="path.method" type="PaginatableMethod" />

<div id="__init__">
  ### `__init__`
</div>

Initialiser le curseur.

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

<ParamField path="path.method" type="PaginatableMethod">
  La méthode d'API à appeler pour chaque page (doit prendre en charge la pagination)
</ParamField>

<div id="items">
  ### `items`
</div>

Itérer sur chaque élément des réponses paginées.

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

<ParamField path="path.limit" type="int or None" default="None">
  Nombre maximal d’éléments à renvoyer (None pour ne pas fixer de limite)
</ParamField>

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

`IteratorAny`

<div id="pages">
  ### `pages`
</div>

Parcourt les pages de réponses.

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

<ParamField path="path.limit" type="int or None" default="None">
  Nombre maximal de pages à retourner (None pour un nombre illimité)
</ParamField>

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

`IteratorResponseType`

<div id="class-xdkpaginatorpaginatablemethod">
  ### `class xdk.paginator.PaginatableMethod`
</div>

\[`ResponseType`]

<div id="__init__">
  ### `__init__`
</div>

<div id="xdkpaginatorcursor">
  ### `xdk.paginator.cursor`
</div>

Crée un curseur avec une inférence de types et une validation appropriées.
Cette fonction de fabrique facilite l’inférence de types afin que vous obteniez des
annotations de type correctes pour le type de réponse, et elle valide que la méthode
prend en charge la pagination aussi bien à l’analyse statique qu’à l’exécution.

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

<ParamField path="path.method" type="PaginatableMethod">
  La méthode d'API à encapsuler (doit être compatible avec la pagination)
</ParamField>