Skip to content

docs: add TurboPartner Java SDK documentation#51

Open
nicolasiscoding wants to merge 12 commits intodevelopfrom
docs/partner-java-sdk
Open

docs: add TurboPartner Java SDK documentation#51
nicolasiscoding wants to merge 12 commits intodevelopfrom
docs/partner-java-sdk

Conversation

@nicolasiscoding
Copy link
Copy Markdown
Member

Summary

  • Adds comprehensive TurboPartner Java SDK documentation (partner-java.md) mirroring the PHP/Go/Python/JS partner docs structure
  • Registers Java in the TurboPartner SDKs sidebar section
  • Updates the SDKs index page to include Java in the TurboPartner table (removes "coming soon" notice)

Changes

File Change
docs/SDKs/partner-java.md New — 873 lines covering all TurboPartner operations
docs/SDKs/index.md Add Java row to TurboPartner table, remove "coming soon"
sidebars.js Add partner-java entry to TurboPartner SDKs category

Sections covered

  • TLDR quick example
  • Installation (Maven/Gradle)
  • Configuration (Builder pattern)
  • Organization management (CRUD + entitlements)
  • Organization user management
  • Organization API key management
  • Partner API key management (with PartnerScope constants)
  • Partner portal user management (with permissions)
  • Audit logs
  • Entitlements reference (features + tracking tables)
  • Scope constants (22 scopes)
  • Error handling (typed exceptions)
  • Complete workflow example

Test plan

  • Run npm start and verify the new page renders correctly
  • Verify sidebar shows "Java" under TurboPartner SDKs
  • Verify index page table includes Java row
  • Check all internal doc links resolve

🤖 Generated with Claude Code

nicolasiscoding and others added 12 commits February 16, 2026 12:23
- Add TurboPartner PHP SDK docs with full API reference
- Add TurboPartner JavaScript SDK docs with full API reference
- Add TLDR copy-pastable quickstart snippets to both pages
- Add JS SDK to TurboPartner table in SDK overview and sidebar
- QA fixes: remove ipWhitelist/allowedOrigins, fix scope count (22)
- Remove baseUrl from config examples
- Add contact us callout linking to turbodocx.com/demo
- Standardize admonition banner types across both docs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix Python version requirement (3.8 → 3.9)
- Add metadata param to create_organization() example
- Add search and resource_id params to get_partner_audit_logs() example

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add NotFoundError, RateLimitError, NetworkError to error handling section
- Fix broken /docs/API/partner-api link to /docs/SDKs/
- Add scopes param to update_partner_api_key() example

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add tracking param to update_organization_entitlements() example
- Add search param to list_organization_users() example
- Add offset/search params to list_organization_api_keys() example
- Add offset/search params to list_partner_api_keys() example
- Add offset/search params to list_partner_portal_users() example

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add comprehensive partner management documentation for the Java SDK,
mirroring the structure of existing PHP/Go/Python/JS partner docs.
Includes organization CRUD, user management, API key management,
partner portal users, audit logs, entitlements reference, and error handling.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…anizationDetails response

- java.md: artifactId sdk → turbodocx-sdk, version 1.0.0 → 0.1.6 (Maven/Gradle)
- java.md: add required senderEmail to all TurboDocxClient.Builder examples
- java.md: fix Maven Central link to use correct artifactId
- partner-java.md: fix getOrganizationDetails() response — name/isActive are under
  data.organization, not data directly (matches TurboPartnerBasic.java example)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- java.md: add missing .fileName() to File Upload example — required when
  using .file(byte[]) or the SDK passes null to the multipart upload
- java.md: replace raw Field/TemplateAnchor constructors with Field.Builder /
  TemplateAnchor.Builder pattern, matching the README and all example files
- partner-java.md: fix audit log action filter "ORG_CREATED" → "org.created"
  to match the value format used in the SDK README example

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
java.md:
- Fix prose artifact ID: com.turbodocx:sdk → com.turbodocx:turbodocx-sdk
- Fix duplicate TurboDocxClient variable declaration in Configuration section
  (two `TurboDocxClient client` in same scope was a compile error)
- Add catch(IOException) to error handling example — all TurboSign methods
  throw checked IOException; network errors surface as IOException, not
  TurboDocxException.NetworkException
- Update error types table: NetworkException → IOException

partner-java.md:
- Fix audit log action value: "org.created" → "org.create" (verified against
  backend test suite: audit-logs.test.ts uses "org.create")
- Add catch(IOException) to error handling example — all TurboPartner methods
  throw checked IOException; PartnerHttpClient never throws NetworkException
- Update error types table: NetworkException → IOException

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Backend uses dot-separated lowercase actions (e.g. "org.create"), not
SCREAMING_SNAKE_CASE ("ORG_CREATED"). Fixed PHP, Python, and Go docs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant