Skip to main content

FiscusCallbacks (API Reference)

The FiscusCallbacks are functions that handle various events during the execution of operations in the Fiscus SDK. These callbacks allow customization of behavior during success, error, authentication, streaming, and logging events. They are passed to the execute or execute_async methods when performing operations.

Callback Functions​

fiscus_on_success​

fiscus_on_success(info: Dict[str, Any]) -> None​

The default callback function that is invoked when an operation succeeds.

Parameters:​
  • info (Dict[str, Any]): A dictionary containing information about the successful operation.
Returns:​
  • None.

fiscus_on_error​

fiscus_on_error(info: Dict[str, Any]) -> None​

The default callback function that is invoked when an operation fails.

Parameters:​
  • info (Dict[str, Any]): A dictionary containing information about the error that occurred.
Returns:​
  • None.

fiscus_on_auth​

fiscus_on_auth(connector_name: str) -> Dict[str, Any]​

The default callback function that handles authentication requests.

Parameters:​
  • connector_name (str): The name of the connector that requires authentication.
Returns:​
  • Dict[str, Any]: A dictionary containing the authentication parameters required by the connector.

fiscus_on_stream​

fiscus_on_stream(data: Any) -> None​

The default callback function that handles streaming data.

Parameters:​
  • data (Any): The data received during the streaming operation.
Returns:​
  • None.

fiscus_on_log​

fiscus_on_log(info: Dict[str, Any]) -> None​

The default callback function that logs information during the execution of operations.

Parameters:​
  • info (Dict[str, Any]): A dictionary containing log information.
Returns:​
  • None.

Type Alias​

FiscusCallback​

FiscusCallback = Callable[[Dict[str, Any]], None]​

A type alias representing a callback function that takes a dictionary of information as input and returns None.

Parameters:​
  • info (Dict[str, Any]): A dictionary containing information passed to the callback function.
Returns:​
  • None.