Skip to main content

FiscusConnector Class (API Reference)

The FiscusConnector class represents an integration with an external API or service. It handles authentication and the execution of operations for the associated service.

Initialization​

__init__​

__init__(self, name: str, user: 'FiscusUser')​

Initializes a new FiscusConnector instance.

Parameters:​
  • name (str): The name of the connector (e.g., Gmail, Stripe).
  • user (FiscusUser): Reference to the FiscusUser instance that owns the connector.

Methods​

authenticate​

authenticate(self, auth_params: Dict[str, Any]) -> None​

Authenticates the connector with the external service.

Parameters:​
  • auth_params (Dict[str, Any]): A dictionary containing the authentication parameters required by the external service.
Returns:​
  • None.

deauthenticate​

deauthenticate(self) -> None​

Deauthenticates the connector from the external service.

Parameters:​
  • None.
Returns:​
  • None.

get_operations​

get_operations(self) -> Dict[str, Any]​

Retrieves a dictionary of available operations for the connector.

Parameters:​
  • None.
Returns:​
  • Dict[str, Any]: A dictionary containing available operations.

update_configuration​

update_configuration(self, config_options: Dict[str, Any]) -> None​

Updates the configuration of the connector with the provided options.

Parameters:​
  • config_options (Dict[str, Any]): A dictionary containing the configuration options to be updated.
Returns:​
  • None.

get_info​

get_info(self) -> Dict[str, Any]​

Retrieves information about the connector, including its name, category, and authentication status.

Parameters:​
  • None.
Returns:​
  • Dict[str, Any]: A dictionary containing information about the connector.