Skip to content

Commands

interfaces.fetch_request.cli.commands

Summary

Subcommand implementations: list, get, create-file, create-email, ambiguities, resolve, retry. Each cmd_* function receives the parsed argparse namespace and prints its result to stdout.

Classes

Functions

cmd_ambiguities async

cmd_ambiguities(args)

List ambiguities for a fetch request, optionally cleaning them.

Parameters:

Name Type Description Default
args

Parsed argparse namespace with fr_id, status, clean, and yes fields.

required

cmd_create_email async

cmd_create_email(args)

Create an email-based fetch request.

Requires an existing account and user; parses the date range, builds an EmailSource, and persists the created fetch request.

Parameters:

Name Type Description Default
args

Parsed argparse namespace with account, user, from-email, bank, subject, raw-terms, start-date, and end-date fields.

required

cmd_create_file async

cmd_create_file(args)

Create a file-based fetch request.

Requires an existing account and user; parses the date range, builds a FileSource, and persists the created fetch request.

Parameters:

Name Type Description Default
args

Parsed argparse namespace with account, user, path, bank, start-date, and end-date fields.

required

cmd_get async

cmd_get(args)

Show details of a single fetch request.

Parameters:

Name Type Description Default
args

Parsed argparse namespace with the id field.

required

cmd_list async

cmd_list(args)

List fetch requests, optionally filtered by status and account.

Parameters:

Name Type Description Default
args

Parsed argparse namespace with status, account, and limit fields.

required

cmd_resolve async

cmd_resolve(args)

Resolve ambiguities, interactively or directly by amount and balance.

Parameters:

Name Type Description Default
args

Parsed argparse namespace with fr_id, ambiguity-id, amount, and balance fields.

required

cmd_retry async

cmd_retry(args)

Reset a failed or paused fetch request back to pending.

Optionally clears extracted data such as raw_lines and txn_blocks.

Parameters:

Name Type Description Default
args

Parsed argparse namespace with the id and reset-data fields.

required