openbankproject_client.scheduled_event module

Scheduled Event endpoints for the OpenBankProject API Client.

class openbankproject_client.scheduled_event.ScheduledEventEndpoints(client)[source]

Bases: object

Scheduled Event-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_scheduled_event(data: Dict) → Dict[source]

Create Scheduled Event.

Parameters:

data – Scheduled event data

Returns:

Dict containing created scheduled event information

get_scheduled_event(scheduled_event_id: str) → Dict[source]

Get Scheduled Event.

Parameters:

scheduled_event_id – Scheduled event identifier

Returns:

Dict containing scheduled event information

get_scheduled_events() → Dict[source]

Get Scheduled Events.

Returns:

Dict containing scheduled events information

update_scheduled_event(scheduled_event_id: str, data: Dict) → Dict[source]

Update Scheduled Event.

Parameters:

  • scheduled_event_id – Scheduled event identifier

  • data – Updated scheduled event data

Returns:

Dict containing updated scheduled event information

delete_scheduled_event(scheduled_event_id: str) → Dict[source]

Delete Scheduled Event.

Parameters:

scheduled_event_id – Scheduled event identifier

Returns:

Dict containing deletion status