v1.14.0
1.14.0 (2025-04-17)
Full Changelog: v0.0.1-alpha.0...v1.14.0
⚠ BREAKING CHANGES
- bump min supported ruby version to 3.1 (oldest non-EOL)
- remove top level type aliases to relocated classes
- use tagged enums in sorbet type definitions
- support
for item in stream
style iteration onStream
s - model: base model should recursively store coerced base models
Features
- add reference links in yard (c8112ba)
- allow all valid
JSON
types to be encoded (0e60330) - api: fixed license key pagination issues in openapi spec (653b19c)
- api: fixed openapi spec issues (691e1e4)
- api: manual updates (1a32da1)
- api: manual updates (f0b9884)
- api: manual updates (a680087)
- api: openapi spec updated (31b931f)
- api: updated openapi spec (1c3e4df)
- api: updated openapispec to v1.10.1 (e1f3743)
- api: updated stainless config (bc00e20)
- bump min supported ruby version to 3.1 (oldest non-EOL) (c66807f)
- client: enable setting base URL from environment variable (90a50f5)
- consistently accept
AnyHash
types in parameter positions in sorbet (c059ee7) - implement
to_json
for base model (f49536b) - internal: converter interface should recurse without schema (311fe61)
- link response models to their methods in yard doc (3983431)
- prevent tapioca from introspecting the gem internals (c8092f5)
- remove top level type aliases to relocated classes (6f906f2)
- support
for item in stream
style iteration onStream
s (d3e29e7) - support query, header, and body params that have identical names (cd22aac)
- support solargraph generics (6173376)
- use Pathname alongside raw IO handles for file uploads (c3aba4a)
- use tagged enums in sorbet type definitions (3b11bb1)
Bug Fixes
- bad documentation url for gemdocs.org (8fe7986)
- converter should transform stringio into string where applicable (fa77255)
- internal: update release-please to use ruby strategy for README.md (b683ef0)
- label optional keyword arguments in *.rbs type definitions (0a8efde)
- model: base model should recursively store coerced base models (7e3ec62)
- path interpolation template strings (d5683b7)
- pre-release version string should match ruby, not semver conventions (e7415da)
- raise connection error for errors that result from HTTP transports (3834676)
- resolve tapioca derived sorbet errors (bc47cc1)
- switch to github compatible markdown engine (4acafa8)
- yard example tag formatting (884ae9d)
Chores
BaseModel
fields that areBaseModel
typed should also acceptHash
(915e7e5)- add
[@yieldparam](https://github.com/yieldparam)
to yard doc (764cd83) - add example directory (9599dc0)
- add README docs for using solargraph when installing gem from git (cc5afeb)
- add type annotations for enum and union member listing methods (933f18b)
- always fold up method bodies in sorbet type definitions (e838c12)
- configure new SDK language (fbf7c1f)
- demonstrate how to make undocumented requests in README (15e30c1)
- disable overloads in
*.rbs
definitions for readable LSP errors (da0e8d5) - disable unnecessary linter rules for sorbet manifests (c76ef72)
- do not label modules as abstract (ee3ebf5)
- do not use literals for version in type definitions (ad10ce8)
- document Client's concurrency capability (58a127e)
- document LSP support in read me (a47019f)
- ensure readme.md is bumped when release please updates versions (c1755a1)
- extract error classes into own module (89bad55)
- fix misc rubocop errors (87f611e)
- ignore some spurious linter warnings and formatting changes (d606be8)
- improve yard docs readability (27ae393)
- internal: add sorbet config for SDK local development (0c7073d)
- internal: codegen related update (9c7c1d8)
- internal: expand CI branch coverage (57ab4ac)
- internal: minor refactoring of utils (508daf1)
- internal: misc small improvements (85b3cc3)
- internal: more concise handling of parameter naming conflicts (b09b0d6)
- internal: protect SSE parsing pipeline from broken UTF-8 characters (5bf6136)
- internal: reduce CI branch coverage (442e1cc)
- internal: remove workflow (b8bdca8)
- internal: rubocop rules (aa67a5c)
- internal: run rubocop linter in parallel (4a79ab0)
- loosen const and integer coercion rules (c8e265c)
- make client tests look prettier (991a08d)
- mark non-inheritable SDK internal classes as final (c2dc25e)
- misc sdk polish (5776dd3)
- more accurate type annotations for SDK internals (7e903b3)
- more aggressive tapioca detection logic for skipping compiler introspection (7ee8b2a)
- more readable output when tests fail (77fd8e7)
- move private classes into internal module (75c8b88)
- order client variables by "importance" (2b96cdd)
- relax sorbet enum parameters to allow
String
in addition toSymbol
(51bd455) - relocate internal modules (68aff7a)
- remove unnecessary & confusing module (727590d)
- rename confusing
Type::BooleanModel
toType::Boolean
(71169db) - sdk client internal refactoring (1c5f4d7)
- simplify internal utils (799832e)
- slightly more consistent type definition layout (c43efe9)
- update readme (fe8ff7a)
- update SDK settings (990f795)
- update yard comment formatting (3b01edb)
- use fully qualified name in sorbet README example (259f1d3)
- use generics instead of overloading for sorbet type definitions (768b452)
- use multi-line formatting style for really long lines (9f3d5db)