openbankproject_client.view_custom module

View Custom endpoints for the OpenBankProject API Client.

class openbankproject_client.view_custom.ViewCustomEndpoints(client)[source]

Bases: object

View Custom-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_custom_view(bank_id: str, account_id: str, data: Dict) Dict[source]

Create Custom View.

Parameters:
  • bank_id – Bank identifier

  • account_id – Account identifier

  • data – Custom view data

Returns:

Dict containing created custom view information

get_custom_view(bank_id: str, account_id: str, view_id: str) Dict[source]

Get Custom View.

Parameters:
  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

Returns:

Dict containing custom view information

get_views_for_account(bank_id: str, account_id: str) Dict[source]

Get Views for Account.

Parameters:
  • bank_id – Bank identifier

  • account_id – Account identifier

Returns:

Dict containing views information for the account

update_custom_view(bank_id: str, account_id: str, view_id: str, data: Dict) Dict[source]

Update Custom View.

Parameters:
  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • data – Updated custom view data

Returns:

Dict containing updated custom view information

delete_custom_view(bank_id: str, account_id: str, view_id: str) Dict[source]

Delete Custom View.

Parameters:
  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

Returns:

Dict containing deletion status

get_account_access_for_user(bank_id: str, account_id: str, user_id: str) Dict[source]

Get Account access for User.

Parameters:
  • bank_id – Bank identifier

  • account_id – Account identifier

  • user_id – User identifier

Returns:

Dict containing account access information for the user

get_access(bank_id: str, account_id: str) Dict[source]

Get access.

Parameters:
  • bank_id – Bank identifier

  • account_id – Account identifier

Returns:

Dict containing access information