[TA-3805] docs(calendars): document tentative_as_busy in get_free_busy request body#546
Merged
Merged
Conversation
…y request body - Document the get_free_busy request body keys (start_time, end_time, emails, tentative_as_busy) in the YARD comment, aligning the Ruby SDK with the typed free/busy request models in the other Nylas SDKs - Add a spec asserting tentative_as_busy is forwarded in the request body - Add an Unreleased CHANGELOG entry Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
tentative_as_busysupport to theCalendars#get_free_busyrequest body in the Ruby SDK, aligning it with the typed free/busy request models in the other Nylas SDKs (e.g. Python'sGetFreeBusyRequest).The Ruby SDK is entirely Hash-based and has no type system, so customers can already pass
tentative_as_busythrough the untypedrequest_bodyHash. As with the other SDKs, this change makes the field a documented, first-class part of the request contract — the Ruby-idiomatic equivalent of a typed request model is documenting the accepted hash keys in the YARD comment (matching howcreate/updatedocument their nested request fields).Changes
get_free_busyrequest body keys (start_time,end_time,emails,tentative_as_busy) in the YARD comment.tentative_as_busyuses wording consistent with the other SDKs: when set tofalse, treats tentative calendar events asbusy: false; only applicable for Microsoft and EWS calendar providers; defaults totrue.identifierparam type in the same doc block (str→String).tentative_as_busyis forwarded in the request body.UnreleasedCHANGELOG entry.Testing
bundle exec rspec spec/nylas/resources/calendars_spec.rb— 11 examples, 0 failures.bundle exec rubocop lib/nylas/resources/calendars.rb spec/nylas/resources/calendars_spec.rb— no offenses.Related