openbankproject_client.transaction_metadata module

Transaction Metadata endpoints for the OpenBankProject API Client.

class openbankproject_client.transaction_metadata.TransactionMetadataEndpoints(client)

Bases: object

Transaction Metadata-related API endpoints.

__init__(client)

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

add_transaction_comment(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a Transaction Comment.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Comment data

Returns:

Dict containing created comment information

add_transaction_image(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a Transaction Image.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Image data

Returns:

Dict containing created image information

add_transaction_narrative(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a Transaction Narrative.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Narrative data

Returns:

Dict containing created narrative information

add_transaction_tag(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a Transaction Tag.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Tag data

Returns:

Dict containing created tag information

add_transaction_where_tag(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a Transaction where Tag.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Where tag data

Returns:

Dict containing created where tag information

delete_transaction_comment(bank_id: str, account_id: str, view_id: str, transaction_id: str, comment_id: str) → Dict

Delete a Transaction Comment.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• comment_id – Comment identifier

Returns:

Dict containing deletion status

delete_transaction_image(bank_id: str, account_id: str, view_id: str, transaction_id: str, image_id: str) → Dict

Delete a Transaction Image.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• image_id – Image identifier

Returns:

Dict containing deletion status

delete_transaction_narrative(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Delete a Transaction Narrative.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing deletion status

delete_transaction_tag(bank_id: str, account_id: str, view_id: str, transaction_id: str, tag_id: str) → Dict

Delete a Transaction Tag.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• tag_id – Tag identifier

Returns:

Dict containing deletion status

get_transaction_comments(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get Transaction Comments.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing comments information

get_transaction_images(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get Transaction Images.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing images information

get_transaction_tags(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get Transaction Tags.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing tags information

get_transaction_narrative(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get a Transaction Narrative.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing narrative information

get_transaction_where_tag(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get a Transaction where Tag.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing where tag information

update_transaction_narrative(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Update a Transaction Narrative.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Updated narrative data

Returns:

Dict containing updated narrative information

update_transaction_where_tag(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Update a Transaction where Tag.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Updated where tag data

Returns:

Dict containing updated where tag information