ComplianceClient

コンプライアンス操作用クライアント

このクライアントは、X API のコンプライアンス関連エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストの整形、レスポンスの解析を担い、コンプライアンスに関するすべての操作をカバーします。

​

コンストラクタ

​

constructor

• new ComplianceClient(client): ComplianceClient

新しいコンプライアンスクライアントのインスタンスを生成します

​

パラメータ

名前	型	説明
client	Client	X API のメインクライアントインスタンス

​

戻り値

ComplianceClient

​

定義箇所

compliance/client.ts:67

​

手法

​

getJobsById

▸ getJobsById(id, options?): Promise<Get2ComplianceJobsIdResponse>

IDでCompliance Jobを取得 指定したIDのCompliance Jobの詳細を取得します。

​

パラメータ

名前	型	説明
id	string	取得する Compliance Job の id。
options	GetJobsByIdOptions	-

​

返り値

Promise<Get2ComplianceJobsIdResponse>

API レスポンスで解決される Promise

​

定義場所

compliance/client.ts:84

---

​

getJobs

▸ getJobs(type, options?): Promise<Get2ComplianceJobsResponse>

コンプライアンスジョブを取得 ジョブタイプと、必要に応じてステータスでフィルタリングしたコンプライアンスジョブの一覧を取得します。

​

パラメーター

名前	型	説明
type	string	一覧に表示する Compliance Job の種類。
options	GetJobsOptions	-

​

返り値

Promise<Get2ComplianceJobsResponse>

API レスポンスで解決される Promise

​

定義元

compliance/client.ts:134

---

​

createJobs

▸ createJobs(body): Promise<CreateComplianceJobResponse>

コンプライアンスジョブの作成 指定したジョブタイプの新規コンプライアンスジョブを作成します。

​

パラメータ

名前	型	説明
body	CreateComplianceJobRequest	リクエストボディ

​

返り値

Promise<CreateComplianceJobResponse>

API レスポンスで解決される Promise

​

定義元

compliance/client.ts:190