TermsOfService
- class matterapi.endpoints.async_api.TermsOfServiceApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)
Endpoints for getting and updating custom terms of service.
- async create_terms_of_service() matterapi.models.TermsOfService
Creates a new terms of service
Creates new terms of service
- Permissions:
Must have manage_system permission.
- Minimum Server Version:
5.4
- Api Reference:
- async get_terms_of_service() matterapi.models.TermsOfService
Get latest terms of service
Get latest terms of service from the server
- Permissions:
Must be authenticated.
- Minimum Server Version:
5.4
- Api Reference:
- async get_user_terms_of_service(user_id: str) Union[matterapi.models.AppError, matterapi.models.UserTermsOfService]
Fetches user’s latest terms of service action if the latest action was for acceptance.
Will be deprecated in v6.0 Fetches user’s latest terms of service action if the latest action was for acceptance.
- Permissions:
Must be logged in as the user being acted on.
- Minimum Server Version:
5.6
- Api Reference:
- async register_terms_of_service_action(user_id: str, *, json_body: Union[matterapi.models.RegisterTermsOfServiceActionJsonBody, Dict]) matterapi.models.StatusOK
Records user action when they accept or decline custom terms of service
Records user action when they accept or decline custom terms of service. Records the action in audit table. Updates user’s last accepted terms of service ID if they accepted it.
- Permissions:
Must be logged in as the user being acted on.
- Minimum Server Version:
5.4
- Api Reference: