docs(partner): document org display preferences (get/update) - #141
Merged
amitsharma-turbodocx merged 2 commits intoAug 14, 2026
Conversation
amitsharma-turbodocx
marked this pull request as ready for review
August 13, 2026 16:00
…rences / updateOrganizationPreferences) Add a Preferences section + Preferences Reference table to all six partner SDK pages (JS, Python, Go, PHP, Java, Ruby), covering the two new methods and the three settable TurboSign display flags (hideSignatureOutline, hideSignatureHash, lockedFieldsBackground). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
amitsharma-turbodocx
force-pushed
the
feature/partner-org-preferences-docs
branch
from
August 13, 2026 16:01
9aff331 to
d902e30
Compare
The backend schema is Joi.boolean().strict(), so the strings "true" / "false" are rejected with a 400 rather than coerced. That matters most for the dynamically-typed SDKs (Python, Ruby, PHP), which pass the map through untouched — a caller reading a flag from env or a form would otherwise get a confusing 400. Applied to the Preferences Reference on all six partner SDK pages. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
3 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.
What this adds
Documentation for the new partner org display preferences methods, across all six partner SDK pages.
A partner can now read and set a child organization's TurboSign display preferences through the SDK:
getOrganizationPreferences(organizationId)— read the org's current display preferencesupdateOrganizationPreferences(organizationId, preferences)— set one or more of them (only the keys you pass change; all other org settings are preserved)The three settable, boolean display flags:
hideSignatureOutlinefalsehideSignatureHashfalselockedFieldsBackgroundtruetrue) or as plain text (false)Pages updated
Each page gets two method subsections under Organization Management and a new Preferences Reference table, in that language's idiom:
docs/SDKs/partner-javascript.mddocs/SDKs/partner-python.mddocs/SDKs/partner-go.mddocs/SDKs/partner-php.mddocs/SDKs/partner-java.mddocs/SDKs/partner-ruby.mdNotes
developper the repo's branching rule.TurboDocx/SDK#64).🤖 Generated with Claude Code