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

# GeneralClient

> X API TypeScript SDK の GeneralClient クラスのリファレンス。 X API v2 の general エンドポイントのメソッド、パラメーター、戻り値の型。

general 操作向けのクライアント

このクライアントは X API の general エンドポイントと対話するためのメソッドを提供します。認証、リクエストの整形、general に関連するすべての操作のレスポンス解析を扱います。

## コンストラクター

### コンストラクター

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

新しい general クライアントインスタンスを作成します

#### パラメーター

| 名前       | 型                                                     | 説明                      |
| :------- | :---------------------------------------------------- | :---------------------- |
| `client` | [`Client`](/xdks/typescript/reference/classes/Client) | メインの X API クライアントインスタンス |

#### 戻り値

[`GeneralClient`](/xdks/typescript/reference/classes/GeneralClient)

#### 定義場所

[general/client.ts:42](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/general/client.ts#L42)

## メソッド

### getOpenApiSpec

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

Get OpenAPI Spec.
Retrieves the full OpenAPI Specification in JSON format. (See [https://github.com/OAI/OpenAPI-Specification/blob/master/README.md](https://github.com/OAI/OpenAPI-Specification/blob/master/README.md))

#### パラメーター

| 名前                           | 型        |
| :--------------------------- | :------- |
| `options`                    | `Object` |
| `options.requestOptions`     | `Object` |
| `options.requestOptions.raw` | `true`   |

#### 戻り値

`Promise`\<`Response`>

API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

#### 定義場所

[general/client.ts:83](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/general/client.ts#L83)

▸ **getOpenApiSpec**(): `Promise`\<[`GetOpenApiSpecResponse`](/xdks/typescript/reference/modules/General#getopenapispecresponse)>

#### 戻り値

`Promise`\<[`GetOpenApiSpecResponse`](/xdks/typescript/reference/modules/General#getopenapispecresponse)>

#### 定義場所

[general/client.ts:92](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/general/client.ts#L92)