Skip to content

Version 0.6.0: the spec at API 1.20.0, email_pdf added, cost fields removed - #12

Merged
bensynapse merged 1 commit into
mainfrom
api-1.20.0
Nov 13, 2026
Merged

bensynapse merged 1 commit into
mainfrom
api-1.20.0

Conversation

@bensynapse

Copy link
Copy Markdown
Contributor

Follows API 1.20.0. The saved spec takes the changes of faxforagents/openapi#10 and the models are regenerated from it.

Added

  • Number.email_pdf, a boolean. A number from an older server reads it as False.
  • NumberUpdate.email_pdf. numbers.update(number_id, email_pdf=True) sends it, on both clients.
  • The field is sent only when given. False is sent and switches the attachment off.

Removed (breaking)

  • Extraction.provider_cost_micro. The server stopped sending it at API 1.19.0.
  • ExtractionPage.cost_micro, an SDK-declared field the server stopped sending at the same release.

Fixed

0.5.0 required provider_cost_micro. Every extraction, classification and summary call failed to parse on API 1.19.0 and later.

Version

0.6.0. A removed model field is a breaking change. Earlier breaking releases of this 0.x package raised the minor number (0.4.0, 0.5.0).

Checks run

  • pytest -q -m "not live": 146 passed.
  • ruff check, ruff format --check, mypy src.
  • python scripts/gen_models.py --check.
  • sh scripts/truthcheck.sh.
  • python -m build and twine check.

The live test needs a test key and did not run here.

…emoved

The saved spec follows the public document at API 1.20.0.
Number and NumberUpdate carry email_pdf. numbers.update sends it only when given.
Extraction.provider_cost_micro and ExtractionPage.cost_micro are removed.
The server stopped sending both at API 1.19.0.
0.5.0 required provider_cost_micro, so an extraction from the current API failed to parse.
Tests cover the email_pdf body, an older number and an extraction without the cost.
@bensynapse
bensynapse merged commit 68f1586 into main Nov 13, 2026
12 checks passed
@bensynapse
bensynapse deleted the api-1.20.0 branch November 13, 2026 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant