Skip to content

Reference

This section is generated from the public PHP API in src/. PHPDoc summaries, real method signatures, promoted constructor properties, enum cases and default values are included in the generated pages.

Use the practical guides for task-oriented examples, and use Reference when you need the exact object shape or method contract.

Categories

  • Clients — the two public client facades.
  • Configuration — locale, credentials, device and protocol configuration objects.
  • Services — the objects returned by BydClient and their public methods.
  • Request DTOs — immutable request objects and constructor parameters.
  • Response DTOs — immutable response objects and public fields.
  • Enums — backed values and helper methods.
  • Exceptions — error types and their metadata.
  • Value objects — strongly typed values such as Vin.

The generated pages are refreshed with php tools/generate-reference.php. CI fails if the committed reference is out of date.