"""BriteCore V2 violations API endpoint wrappers."""
from typing import Any, Unpack
from britecore_sdk.api.api_calls import (
BritecoreAPIClient,
RequestParameters,
api_client,
)
API_CLIENT: BritecoreAPIClient = api_client
# --- Autogenerated spec wrappers ---
[docs]
def create_driver_mvr_report_file(
driver_id: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Create Driver Mvr Report File.
POST /api/v2/violations/create_driver_mvr_report_file
"""
request_json: dict[str, Any] = {"driver_id": driver_id}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/create_driver_mvr_report_file",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/create_driver_mvr_report_file"
)
[docs]
def create_violation(
violation: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Create Violation.
POST /api/v2/violations/create_violation
"""
request_json: dict[str, Any] = {"violation": violation}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/create_violation",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/create_violation"
)
[docs]
def create_violations(
violations: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Create Violations.
POST /api/v2/violations/create_violations
"""
request_json: dict[str, Any] = {"violations": violations}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/create_violations",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/create_violations"
)
[docs]
def delete_violation(
id: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Delete Violation.
POST /api/v2/violations/delete_violation
"""
request_json: dict[str, Any] = {"id": id}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/delete_violation",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/delete_violation"
)
[docs]
def dispute_violation(
violation_dispute: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Dispute Violation.
POST /api/v2/violations/dispute_violation
"""
request_json: dict[str, Any] = {"violation_dispute": violation_dispute}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/dispute_violation",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/dispute_violation"
)
[docs]
def get_violation(
id: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Get Violation.
POST /api/v2/violations/get_violation
"""
request_json: dict[str, Any] = {"id": id}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/get_violation",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/get_violation"
)
[docs]
def list_violation_for_driver(
driver_id: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""List Violation For Driver.
POST /api/v2/violations/list_violation_for_driver
"""
request_json: dict[str, Any] = {"driver_id": driver_id}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/list_violation_for_driver",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/list_violation_for_driver"
)
[docs]
def remove_violation_dispute(
violation_id: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Remove Violation Dispute.
POST /api/v2/violations/remove_violation_dispute
"""
request_json: dict[str, Any] = {"violation_id": violation_id}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/remove_violation_dispute",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/remove_violation_dispute"
)
[docs]
def update_violation(
violation: Any | None = None,
**kwargs: Unpack[RequestParameters],
) -> Any:
"""Update Violation.
POST /api/v2/violations/update_violation
"""
request_json: dict[str, Any] = {"violation": violation}
filtered_json = {k: v for k, v in request_json.items() if v is not None}
request_result = API_CLIENT.do_request(
path="/api/v2/violations/update_violation",
json=filtered_json,
method="POST",
**kwargs,
)
return API_CLIENT.process_result(
request_result, endpoint="/api/v2/violations/update_violation"
)
__all__ = [
"create_driver_mvr_report_file",
"create_violation",
"create_violations",
"delete_violation",
"dispute_violation",
"get_violation",
"list_violation_for_driver",
"remove_violation_dispute",
"update_violation",
]