openbankproject_client.atm module
ATM endpoints for the OpenBankProject API Client.
- class openbankproject_client.atm.AtmEndpoints(client)[source]
Bases:
objectATM-related API endpoints.
- __init__(client)[source]
Initialize the endpoint group.
- Parameters:
client – OpenBankProjectClient instance
- get_atms(bank_id: str, params: Dict | None = None) Dict[source]
Get all ATMs at a specific bank.
- Parameters:
bank_id – Bank identifier
params – Optional query parameters like limit, offset, etc.
- Returns:
Dict containing ATM information
- get_atm_by_id(bank_id: str, atm_id: str) Dict[source]
Get ATM by ID at a specific bank.
- Parameters:
bank_id – Bank identifier
atm_id – ATM identifier
- Returns:
Dict containing ATM information
- create_atm(bank_id: str, data: Dict) Dict[source]
Create a new ATM at a specific bank.
- Parameters:
bank_id – Bank identifier
data – ATM data
- Returns:
Dict containing created ATM information
- update_atm(bank_id: str, atm_id: str, data: Dict) Dict[source]
Update an existing ATM at a specific bank.
- Parameters:
bank_id – Bank identifier
atm_id – ATM identifier
data – Updated ATM data
- Returns:
Dict containing updated ATM information
- delete_atm(bank_id: str, atm_id: str) Dict[source]
Delete an ATM at a specific bank.
- Parameters:
bank_id – Bank identifier
atm_id – ATM identifier
- Returns:
Dict containing deletion status
- get_atm_attributes(bank_id: str, atm_id: str) Dict[source]
Get attributes for an ATM.
- Parameters:
bank_id – Bank identifier
atm_id – ATM identifier
- Returns:
Dict containing ATM attribute information
- create_atm_attribute(bank_id: str, atm_id: str, data: Dict) Dict[source]
Create an attribute for an ATM.
- Parameters:
bank_id – Bank identifier
atm_id – ATM identifier
data – Attribute data
- Returns:
Dict containing created attribute information
- update_atm_attribute(bank_id: str, atm_id: str, attribute_id: str, data: Dict) Dict[source]
Update an attribute of an ATM.
- Parameters:
bank_id – Bank identifier
atm_id – ATM identifier
attribute_id – Attribute identifier
data – Updated attribute data
- Returns:
Dict containing updated attribute information