openbankproject_client.user_invitation module

User Invitation endpoints for the OpenBankProject API Client.

class openbankproject_client.user_invitation.UserInvitationEndpoints(client)[source]

Bases: object

User Invitation-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_user_invitation(bank_id: str, data: Dict) → Dict[source]

Create User Invitation.

Parameters:

  • bank_id – Bank identifier

  • data – User invitation data

Returns:

Dict containing created user invitation information

get_user_invitation(bank_id: str, invitation_id: str) → Dict[source]

Get User Invitation.

Parameters:

  • bank_id – Bank identifier

  • invitation_id – Invitation identifier

Returns:

Dict containing user invitation information

get_user_invitation_information(invitation_id: str) → Dict[source]

Get User Invitation Information.

Parameters:

invitation_id – Invitation identifier

Returns:

Dict containing user invitation information

get_user_invitations(bank_id: str) → Dict[source]

Get User Invitations.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing user invitations information