Class ReceiptImportHandler

Handles the multi-step receipt import conversation via Telegram.

Index

Accessors

isAwaitingPhoto

Constructors

Methods

setApi start handlePhoto onAccountSelected onCategorySelected onConfirm onChooseDifferent onCancel

Accessors

isAwaitingPhoto

get isAwaitingPhoto(): boolean
Whether the handler is currently awaiting a photo.

Returns boolean
True when the state machine is waiting for a photo.
- Defined in Services/ReceiptImportHandler.ts:161

Constructors

constructor

new ReceiptImportHandler(opts: IReceiptHandlerOptions): ReceiptImportHandler
Creates a ReceiptImportHandler.
Parameters
- opts: IReceiptHandlerOptions
  Handler options with OCR, notifier, and optional API.
Returns ReceiptImportHandler
- Defined in Services/ReceiptImportHandler.ts:46

Methods

setApi

setApi(api: IReceiptActualApi): void
Sets the Actual Budget API after connection is established.
Parameters
- api: IReceiptActualApi
  The Actual Budget API instance.
Returns void
- Defined in Services/ReceiptImportHandler.ts:80

start

start(): Promise<Procedure<{ status: string }>>
Starts the receipt import flow.

Returns Promise<Procedure<{ status: string }>>
Procedure indicating the prompt was sent.
- Defined in Services/ReceiptImportHandler.ts:86

handlePhoto

handlePhoto(fileId: string): Promise<Procedure<{ status: string }>>
Processes an incoming photo during the receipt import flow.
Parameters
- fileId: string
  Telegram file_id of the largest photo resolution.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating the processing result.
- Defined in Services/ReceiptImportHandler.ts:100

onAccountSelected

onAccountSelected(accountId: string): Promise<Procedure<{ status: string }>>
Handles account selection callback.
Parameters
- accountId: string
  Selected Actual Budget account UUID.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating the next step.
- Defined in Services/ReceiptImportHandler.ts:116

onCategorySelected

onCategorySelected(categoryId: string): Promise<Procedure<{ status: string }>>
Handles category selection and triggers import.
Parameters
- categoryId: string
  Selected Actual Budget category UUID.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating the import result.
- Defined in Services/ReceiptImportHandler.ts:126

onConfirm

onConfirm(): Promise<Procedure<{ status: string }>>
Confirms smart match and imports.

Returns Promise<Procedure<{ status: string }>>
Import result Procedure.
- Defined in Services/ReceiptImportHandler.ts:135

onChooseDifferent

onChooseDifferent(): Promise<Procedure<{ status: string }>>
Shows full menus instead of smart match.

Returns Promise<Procedure<{ status: string }>>
Menu result Procedure.
- Defined in Services/ReceiptImportHandler.ts:143

onCancel

onCancel(): Promise<Procedure<{ status: string }>>
Cancels the receipt import flow.

Returns Promise<Procedure<{ status: string }>>
Procedure indicating cancellation.
- Defined in Services/ReceiptImportHandler.ts:151