openbankproject_client.product module
Product endpoints for the OpenBankProject API Client.
- class openbankproject_client.product.ProductEndpoints(client)[source]
Bases:
objectProduct-related API endpoints.
- __init__(client)[source]
Initialize the endpoint group.
- Parameters:
client – OpenBankProjectClient instance
- create_product(bank_id: str, data: Dict) Dict[source]
Create Product.
- Parameters:
bank_id – Bank identifier
data – Product data
- Returns:
Dict containing created product information
- get_bank_product(bank_id: str, product_id: str) Dict[source]
Get Bank Product.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
- Returns:
Dict containing product information
- get_products(bank_id: str) Dict[source]
Get Products.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing products information
- get_product_tree(bank_id: str, product_id: str) Dict[source]
Get Product Tree.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
- Returns:
Dict containing product tree information
- create_product_attribute(bank_id: str, product_id: str, data: Dict) Dict[source]
Create Product Attribute.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
data – Attribute data
- Returns:
Dict containing created attribute information
- update_product_attribute(bank_id: str, product_id: str, product_attribute_id: str, data: Dict) Dict[source]
Update Product Attribute.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
product_attribute_id – Product attribute identifier
data – Updated attribute data
- Returns:
Dict containing updated attribute information
- get_product_attribute(bank_id: str, product_id: str, product_attribute_id: str) Dict[source]
Get Product Attribute.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
product_attribute_id – Product attribute identifier
- Returns:
Dict containing attribute information
- delete_product_attribute(bank_id: str, product_id: str, product_attribute_id: str) Dict[source]
Delete Product Attribute.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
product_attribute_id – Product attribute identifier
- Returns:
Dict containing deletion status
- create_product_fee(bank_id: str, product_id: str, data: Dict) Dict[source]
Create Product Fee.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
data – Fee data
- Returns:
Dict containing created fee information
- update_product_fee(bank_id: str, product_id: str, product_fee_id: str, data: Dict) Dict[source]
Update Product Fee.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
product_fee_id – Product fee identifier
data – Updated fee data
- Returns:
Dict containing updated fee information
- get_product_fee(bank_id: str, product_id: str, product_fee_id: str) Dict[source]
Get Product Fee.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
product_fee_id – Product fee identifier
- Returns:
Dict containing fee information
- get_product_fees(bank_id: str, product_id: str) Dict[source]
Get Product Fees.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
- Returns:
Dict containing fees information
- delete_product_fee(bank_id: str, product_id: str, product_fee_id: str) Dict[source]
Delete Product Fee.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
product_fee_id – Product fee identifier
- Returns:
Dict containing deletion status
- get_product_attribute_definition(bank_id: str) Dict[source]
Get Product Attribute Definition.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing attribute definition information
- create_or_update_product_attribute_definition(bank_id: str, data: Dict) Dict[source]
Create or Update Product Attribute Definition.
- Parameters:
bank_id – Bank identifier
data – Attribute definition data
- Returns:
Dict containing created or updated attribute definition information