ComplianceClient

コンプライアンス操作用の Client この Client は、X API のコンプライアンス関連エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスの解析を処理し、コンプライアンス関連のすべての操作に対応します。

コンストラクタ

constructor

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

パラメーター

Name	Type	Description
`client`	`Client`	X API のメイン Client インスタンス

戻り値

ComplianceClient

定義場所

compliance/client.ts:93

メソッド

getJobsById

▸ getJobsById(id, options): Promise<Response> ID を指定して Compliance Job を取得指定した ID の特定の Compliance Job の詳細を取得します。

パラメーター

Name	Type	Description
`id`	`string`	取得対象の Compliance Job の ID。
`options`	`GetJobsByIdOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

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

定義場所

compliance/client.ts:138 ▸ getJobsById(id, options?): Promise<Get2ComplianceJobsIdResponse>

パラメータ

名前	型
`id`	`string`
`options?`	`GetJobsByIdOptions`

戻り値

Promise<Get2ComplianceJobsIdResponse>

定義元

compliance/client.ts:151

getJobs

▸ getJobs(type, options): Promise<Response> コンプライアンスジョブを取得します
ジョブ種別と任意のステータスでフィルタリングされたコンプライアンスジョブの一覧を取得します。

パラメーター

Name	Type	Description
`type`	`string`	一覧表示するコンプライアンスジョブの種類。
`options`	`GetJobsOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

定義元

compliance/client.ts:273 ▸ getJobs(type, options?): Promise<Get2ComplianceJobsResponse>

パラメーター

名前	型
`type`	`string`
`options?`	`GetJobsOptions`

戻り値

Promise<Get2ComplianceJobsResponse>

定義場所

compliance/client.ts:286

createJobs

▸ createJobs(body, options): Promise<Response> コンプライアンスジョブの作成指定されたジョブ type の新しいコンプライアンスジョブを作成します。

パラメーター

Name	Type	Description
`body`	`CreateComplianceJobRequest`	新しいバッチコンプライアンスジョブを作成するためのリクエスト。
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

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

定義場所

compliance/client.ts:430 ▸ createJobs(body): Promise<CreateComplianceJobResponse>

パラメーター

名前	型
`body`	`CreateComplianceJobRequest`

戻り値

Promise<CreateComplianceJobResponse>

定義場所

compliance/client.ts:441