メインコンテンツへスキップ
汎用的な操作用の Client この Client は、X API の汎用エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスの解析を行い、汎用エンドポイントに関するすべての操作を処理します。

コンストラクタ

コンストラクター

new GeneralClient(client): GeneralClient 新しい GeneralClient インスタンスを作成します

パラメーター

NameTypeDescription
clientClientX API のメイン Client インスタンス

戻り値

GeneralClient

定義場所

general/client.ts:42

メソッド

getOpenApiSpec

getOpenApiSpec(options): Promise<Response> OpenAPI 仕様を取得します。 JSON 形式の完全な OpenAPI 仕様 (OpenAPI Specification) を取得します。 (https://github.com/OAI/OpenAPI-Specification/blob/master/README.md を参照)

パラメーター

名前type
optionsObject
options.requestOptionsObject
options.requestOptions.rawtrue

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response

定義元

general/client.ts:83 getOpenApiSpec(): Promise<GetOpenApiSpecResponse>

戻り値

Promise<GetOpenApiSpecResponse>

定義元

general/client.ts:92