ComplianceClient

用于合规操作的客户端

该客户端提供与 X API 合规端点交互的方法，并负责处理身份验证、请求格式化，以及与所有合规相关操作的响应解析。

​

构造器

​

构造函数

• new ComplianceClient(client): ComplianceClient

创建新的合规客户端实例

​

参数

名称	类型	说明
client	Client	X API 的主客户端实例

​

返回

ComplianceClient

​

定义于

compliance/client.ts:67

​

方法

​

getJobsById

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

按 ID 获取合规作业 根据该 ID 获取特定合规作业的详细信息。

​

参数

名称	类型	描述
id	string	要获取的合规任务的 id。
options	GetJobsByIdOptions	-

​

返回

Promise<Get2ComplianceJobsIdResponse>

解析为 API 响应的 Promise

​

定义位置

compliance/client.ts:84

---

​

getJobs

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

获取合规任务 按任务类型和（可选）状态检索合规任务列表。

​

参数

名称	类型	描述
type	string	要列出的合规作业类型。
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