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

X API SDK 向けのカーソルベースのページネーション用ユーティリティ。

このモジュールは、すべての API クライアントで洗練されたページネーションをサポートするための Cursor クラスを提供します。Cursor を使うことで、適切な型安全性を保ちながら、`.pages()` と `.items()` の両メソッドを用いて、ページネーションされた結果を簡単にイテレートできます。

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

\[`ResponseType`]

<div id="parameters">
  #### パラメーター
</div>

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

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

カーソルを初期化します。

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.method" type="PaginatableMethod">
  各ページごとに呼び出す API メソッド（ページネーションをサポートしている必要があります）
</ParamField>

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

ページネーションされたレスポンスの各アイテムを反復処理します。

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.limit" type="int or None" default="None">
  返されるアイテム数の上限（制限なしの場合は None）
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`IteratorAny`

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

レスポンスをページ単位で反復処理します。

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.limit" type="int or None" default="None">
  返すページ数の上限（無制限の場合は None）
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`IteratorResponseType`

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

\[`ResponseType`]

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

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

適切な型推論とバリデーションを行うカーソルを作成します。
このファクトリ関数は、レスポンス型に対して適切な型ヒントが得られるよう型推論を支援し、
メソッドがページネーションをサポートしていることを静的解析時と実行時の両方で検証します。

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.method" type="PaginatableMethod">
  ラップする API メソッド（ページネーションをサポートしている必要があります）
</ParamField>