ComplianceClient

​

하위 모듈

• xdk.compliance.client 모듈
  • ComplianceClient
    • ComplianceClient.__init__()
    • ComplianceClient.create_jobs()
    • ComplianceClient.get_jobs()
    • ComplianceClient.get_jobs_by_id()
• xdk.compliance.models 모듈
  • CreateJobsRequest
    • CreateJobsRequest.model_config
  • CreateJobsResponse
    • CreateJobsResponse.model_config
  • GetJobsByIdResponse
    • GetJobsByIdResponse.model_config
  • GetJobsResponse
    • GetJobsResponse.model_config

​

모듈 내용

이 모듈은 X API의 컴플라이언스 엔드포인트에 대한 접근을 제공하며, 모든 컴플라이언스 관련 기능을 위한 주요 진입점 역할을 합니다.

​

class xdk.compliance.ComplianceClient

규정 준수(compliance) 작업용 Client

​

매개변수

path.client · Client

​

__init__

​

매개변수

path.client · Client

​

create_jobs

Compliance Job 생성 지정된 job type의 새 Compliance Job을 생성합니다. body: 요청 본문 :returns: 응답 데이터 :rtype: CreateJobsResponse

​

매개변수

body.body · CreateJobsRequest

​

get_jobs

컴플라이언스 작업 조회 작업 유형과 선택적 상태로 필터링된 컴플라이언스 작업 리스트를 조회합니다.

​

Parameters

path.type · str

나열할 Compliance Job의 유형.

path.status · str or None · 기본값: "None"

나열할 Compliance Job의 상태.

path.compliance_job_fields · List or None · 기본값: "None"

표시할 ComplianceJob 필드를 쉼표로 구분한 목록.

​

반환값

GetJobsResponse - 응답 데이터

​

get_jobs_by_id

ID로 Compliance Job 조회 특정 Compliance Job의 상세 정보를 해당 ID로 조회합니다.

​

매개변수

path.id · Any

조회할 Compliance Job의 ID입니다.

path.compliance_job_fields · List or None · 기본값: "None"

표시할 ComplianceJob 필드의 쉼표로 구분된 목록입니다.

​

반환값

GetJobsByIdResponse - 응답 데이터