Compliance

class matterapi.endpoints.async_api.ComplianceApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

Endpoints for creating, getting and downloading compliance reports.

async create_compliance_report() matterapi.models.Compliance

Create report

Create and save a compliance report.

Permissions:

Must have manage_system permission.

Api Reference:

CreateComplianceReport

async download_compliance_report(report_id: str) None

Download a report

Download the full contents of a report as a file.

Permissions:

Must have manage_system permission.

Api Reference:

DownloadComplianceReport

async get_compliance_report(report_id: str) matterapi.models.Compliance

Get a report

Get a compliance reports previously created.

Permissions:

Must have manage_system permission.

Api Reference:

GetComplianceReport

async get_compliance_reports(*, page: Optional[int] = 0, per_page: Optional[int] = 60) List[matterapi.models.Compliance]

Get reports

Get a list of compliance reports previously created by page, selected with page and per_page query parameters.

Permissions:

Must have manage_system permission.

Api Reference:

GetComplianceReports