Skip to content

CHANGELOG.md

Latest commit

 

History

History
69 lines (60 loc) · 3.27 KB

CHANGELOG.md

File metadata and controls

69 lines (60 loc) · 3.27 KB
Raw

Changelog

All notable changes to hellio-messaging are documented here. This project follows Semantic Versioning.

[1.2.0] - 2026-07-07

Added

  • USSD apps now have test/live modes:
    • create_app responses return id (UUID string), name, callback_url, mode ("test" for new apps), test_secret ("ussk_test_..."), live_secret ("ussk_live_..."), is_live, and active instead of a single secret.
    • set_mode(id, mode) switches an app between "test" and "live".
    • rotate_secret(id, mode) rotates the secret for one mode.
  • Hellio::ExtensionRequiredError (402), raised when switching an app to "live" before a USSD extension is purchased (slug "extension_required").
  • Error mapping now resolves a few responses by their error slug before the HTTP status, covering "extension_required" and "insufficient_ussd_balance".

Changed

  • USSD app and extension ids are UUID strings (were integers).
  • simulate now targets an app: simulate(app_id:, session_id:, msisdn:, input: "", new_session: false, service_code: nil). service_code is sent only when given and defaults server-side to the shared short code. Simulation is always sandboxed (no charge, no extension). A not-owned app returns 422 ("unknown_app").
  • Extension rentals draw from the dedicated USSD balance; an underfunded rental now returns 402 with slug "insufficient_ussd_balance" (still Hellio::InsufficientBalanceError).

[1.1.0] - 2026-07-07

Added

  • USSD service, reached through client.ussd:
    • Pricing: pricing, availability(code).
    • Apps: apps, create_app, update_app, delete_app.
    • Extensions: extensions, rent_extension, release_extension.
    • Sessions: sessions, session.
    • Simulator: simulate (drive an app's callback without a live dial).
  • Hellio::ConflictError (409), raised when renting an extension that is no longer available. Renting with too low a balance still raises the existing Hellio::InsufficientBalanceError (402).
  • Error messages now fall back to the response error field when no message is present.

[1.0.0] - 2026-07-05

Initial release of the official Ruby SDK for the Hellio Messaging API v1.

Added

  • Hellio::Client with Bearer-token auth and one method per endpoint:
    • Account: balance, pricing.
    • SMS: sms, message, campaign.
    • OTP: otp, verify_otp, verify (channels sms, email, voice).
    • Voice: voice, voice_status.
    • Number lookup (HLR): lookup, lookups, lookup_result.
    • Email verification: verify_email.
    • Webhooks: webhooks, create_webhook, delete_webhook.
  • Recipient normalization: methods accept a single string, a comma-separated string, or an array.
  • Typed errors: Hellio::InvalidApiTokenError (401), Hellio::InsufficientBalanceError (402), Hellio::ValidationError (422, with #errors), Hellio::RateLimitError (429), and Hellio::Error (base). Each carries status_code and the parsed response body.
  • Configuration via constructor or the HELLIO_API_TOKEN, HELLIO_BASE_URL, and HELLIO_DEFAULT_SENDER environment variables.
  • Pluggable HTTP adapter (defaults to the standard library net/http) so tests can inject a fake transport.
  • RSpec suite with WebMock and a GitHub Actions matrix (Ruby 3.1, 3.2, 3.3).