openbankproject_client.customer_message module

Customer Message endpoints for the OpenBankProject API Client.

class openbankproject_client.customer_message.CustomerMessageEndpoints(client)[source]

Bases: object

Customer Message-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_customer_message(bank_id: str, customer_id: str, data: Dict) Dict[source]

Create Customer Message.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

  • data – Message data

Returns:

Dict containing created message information

get_customer_messages_for_customer(bank_id: str, customer_id: str) Dict[source]

Get Customer Messages for a Customer.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

Returns:

Dict containing customer messages information

get_customer_messages_for_all_customers(bank_id: str) Dict[source]

Get Customer Messages for all Customers.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing customer messages information for all customers