Search by

speedfin / financial-calculators-admin

speedfin

Wrapper for speedfin financial calculators API admin

Package info

bitbucket.org/speedfin/financial-calculators-api-admin-wrapper

Homepage

pkg:composer/speedfin/financial-calculators-admin

Statistics

Installs: 1 135

Dependents: 0

Suggesters: 0

1.72 2026-09-08 10:40 UTC

README

This README would normally document whatever steps are necessary to get your application up and running.

What is this repository for?

How do I get set up?

  • Summary of set up
  • Configuration
  • Dependencies
  • Database configuration
  • How to run tests
  • Deployment instructions

Mortgage knowledge cards

The admin wrapper exposes mortgage knowledge card regeneration endpoints from Calculators.

Regenerate a bank-level mortgage card:

$result = $bankService->regenerateBankMortgageCard($bankId);
$downloadUrl = $result->downloadUrl;
$offers = $result->manifest->offers;

Each item in $offers is a BankMortgageCardOfferDto with mortgageId, name, and downloadUrl. These links are returned in the regeneration response rather than embedded in the bank's Markdown card.

Regenerate a single mortgage offer card:

$result = $mortgageService->regenerateMortgageOfferCard($mortgageId);
$downloadUrl = $result->downloadUrl;

Offer card regeneration calls:

POST /api/admin/mortgages/{id}/mortgage-card/regenerate

The regeneration response contains metadata and a downloadUrl. The wrapper does not download the Markdown file as part of regeneration.

Download a single mortgage offer card Markdown:

$markdown = $mortgageService->getMortgageOfferCardMarkdown($mortgageId);

This calls:

GET /api/mortgages/{id}/mortgage-card.md

The request uses the same bearer token as admin wrapper calls.

Contribution guidelines

  • Writing tests
  • Code review
  • Other guidelines

Who do I talk to?

  • Repo owner or admin
  • Other community or team contact