인증, 요청 포맷팅, 응답 파싱까지 모든 컴플라이언스 관련 작업을 처리합니다.
생성자
constructor
client): ComplianceClient
새 컴플라이언스 Client 인스턴스를 생성합니다
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
client | Client | 주요 X API Client 인스턴스 |
반환값
ComplianceClient
정의된 위치
메서드
getJobsById
id, options): Promise<Response>
ID로 컴플라이언스 작업 조회
특정 id를 가진 컴플라이언스 작업의 세부 정보를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
id | string | 조회할 Compliance Job의 ID입니다. |
options | GetJobsByIdOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다.
정의 위치
compliance/client.ts:138 ▸ getJobsById(id, options?): Promise<Get2ComplianceJobsIdResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetJobsByIdOptions |
반환값
Promise<Get2ComplianceJobsIdResponse>
정의된 위치
getJobs
type, options): Promise<Response>
규정 준수 작업 조회작업 type과 선택적 상태로 필터링된 규정 준수 작업 리스트를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
type | string | 나열할 Compliance Job의 유형입니다. |
options | GetJobsOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다
정의 위치
compliance/client.ts:273 ▸ getJobs(type, options?): Promise<Get2ComplianceJobsResponse>
매개변수
| 이름 | 유형 |
|---|---|
type | string |
options? | GetJobsOptions |
반환값
Promise<Get2ComplianceJobsResponse>
정의된 위치
createJobs
body, options): Promise<Response>
컴플라이언스 작업 생성
지정된 job type에 대한 새 컴플라이언스 작업을 생성합니다.
매개변수
| Name | Type | Description |
|---|---|---|
body | CreateComplianceJobRequest | 새 배치 컴플라이언스 작업을 생성하는 요청입니다. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Returns
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
compliance/client.ts:430 ▸ createJobs(body): Promise<CreateComplianceJobResponse>
매개변수
| 이름 | Type |
|---|---|
body | CreateComplianceJobRequest |
반환
Promise<CreateComplianceJobResponse>