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

# ComplianceClient

コンプライアンス操作用の Client

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

<div id="constructors">
  ## コンストラクタ
</div>

<div id="constructor">
  ### constructor
</div>

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

新しい ComplianceClient インスタンスを作成します

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

| Name     | Type                                                     | Description              |
| :------- | :------------------------------------------------------- | :----------------------- |
| `client` | [`Client`](/ja/xdks/typescript/reference/classes/Client) | X API のメイン Client インスタンス |

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

[`ComplianceClient`](/ja/xdks/typescript/reference/classes/ComplianceClient)

<div id="defined-in">
  #### 定義場所
</div>

[compliance/client.ts:93](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L93)

<div id="methods">
  ## メソッド
</div>

<div id="getjobsbyid">
  ### getJobsById
</div>

▸ **getJobsById**(`id`, `options`): `Promise`\<`Response`>

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

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

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

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

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 定義場所
</div>

[compliance/client.ts:138](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L138)

▸ **getJobsById**(`id`, `options?`): `Promise`\<[`Get2ComplianceJobsIdResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsIdResponse)>

#### パラメータ

| 名前         | 型                    |
| :--------- | :------------------- |
| `id`       | `string`             |
| `options?` | `GetJobsByIdOptions` |

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

`Promise`\<[`Get2ComplianceJobsIdResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsIdResponse)>

#### 定義元

[compliance/client.ts:151](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L151)

***

<div id="getjobs">
  ### getJobs
</div>

▸ **getJobs**(`type`, `options`): `Promise`\<`Response`>

コンプライアンスジョブを取得します\
ジョブ種別と任意のステータスでフィルタリングされたコンプライアンスジョブの一覧を取得します。

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

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

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

`Promise`\<`Response`>

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

#### 定義元

[compliance/client.ts:273](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L273)

▸ **getJobs**(`type`, `options?`): `Promise`\<[`Get2ComplianceJobsResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsResponse)>

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

| 名前         | 型                |
| :--------- | :--------------- |
| `type`     | `string`         |
| `options?` | `GetJobsOptions` |

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

`Promise`\<[`Get2ComplianceJobsResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsResponse)>

<div id="defined-in">
  #### 定義場所
</div>

[compliance/client.ts:286](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L286)

***

<div id="createjobs">
  ### createJobs
</div>

▸ **createJobs**(`body`, `options`): `Promise`\<`Response`>

コンプライアンスジョブの作成
指定されたジョブ type の新しいコンプライアンスジョブを作成します。

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

| Name                         | Type                                                                                                        | Description                     |
| :--------------------------- | :---------------------------------------------------------------------------------------------------------- | :------------------------------ |
| `body`                       | [`CreateComplianceJobRequest`](/ja/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobRequest) | 新しいバッチコンプライアンスジョブを作成するためのリクエスト。 |
| `options`                    | `Object`                                                                                                    | -                               |
| `options.requestOptions`     | `Object`                                                                                                    | -                               |
| `options.requestOptions.raw` | `true`                                                                                                      | -                               |

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

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 定義場所
</div>

[compliance/client.ts:430](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L430)

▸ **createJobs**(`body`): `Promise`\<[`CreateComplianceJobResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobResponse)>

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

| 名前     | 型                                                                                                           |
| :----- | :---------------------------------------------------------------------------------------------------------- |
| `body` | [`CreateComplianceJobRequest`](/ja/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobRequest) |

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

`Promise`\<[`CreateComplianceJobResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobResponse)>

<div id="defined-in">
  #### 定義場所
</div>

[compliance/client.ts:441](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L441)