Source code for britecore_sdk.api.api_calls.v2.configurations

"""BriteCore V2 configurations 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_custom_error_code( custom_error_code: dict[str, Any] | None = None, **kwargs: Unpack[RequestParameters], ) -> Any: """Create Custom Error Code. POST /api/v2/configurations/create_custom_error_code """ request_json: dict[str, Any] = { "custom_error_code": custom_error_code, } 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/configurations/create_custom_error_code", json=filtered_json, method="POST", **kwargs, ) return API_CLIENT.process_result( request_result, endpoint="/api/v2/configurations/create_custom_error_code" )
[docs] def delete_custom_error_code( id: str | None = None, **kwargs: Unpack[RequestParameters], ) -> Any: """Delete Custom Error Code. POST /api/v2/configurations/delete_custom_error_code """ 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/configurations/delete_custom_error_code", json=filtered_json, method="POST", **kwargs, ) return API_CLIENT.process_result( request_result, endpoint="/api/v2/configurations/delete_custom_error_code" )
[docs] def list_custom_error_codes( module: str | None = None, **kwargs: Unpack[RequestParameters], ) -> Any: """List Custom Error Codes. POST /api/v2/configurations/list_custom_error_codes """ request_json: dict[str, Any] = { "module": module, } 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/configurations/list_custom_error_codes", json=filtered_json, method="POST", **kwargs, ) return API_CLIENT.process_result( request_result, endpoint="/api/v2/configurations/list_custom_error_codes" )
[docs] def update_custom_error_code( custom_error_code: dict[str, Any] | None = None, **kwargs: Unpack[RequestParameters], ) -> Any: """Update Custom Error Code. POST /api/v2/configurations/update_custom_error_code """ request_json: dict[str, Any] = { "custom_error_code": custom_error_code, } 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/configurations/update_custom_error_code", json=filtered_json, method="POST", **kwargs, ) return API_CLIENT.process_result( request_result, endpoint="/api/v2/configurations/update_custom_error_code" )
__all__ = [ "create_custom_error_code", "delete_custom_error_code", "list_custom_error_codes", "update_custom_error_code", ]