Skip to content

docs(turboquote): document quote naming rules and the renew action - #137

Merged
amitsharma-turbodocx merged 1 commit into
developfrom
docs/turboquote-rename-and-expiry-actions
Aug 20, 2026
Merged

docs(turboquote): document quote naming rules and the renew action#137
amitsharma-turbodocx merged 1 commit into
developfrom
docs/turboquote-rename-and-expiry-actions

Conversation

@yacinekahlerras-turbodocx

Copy link
Copy Markdown
Contributor

Description

TurboQuote's quote naming behaviour changed underneath API surface that already existed. No endpoint, request shape, or response shape moved — so callers see the change with no version bump and no compile error, and nothing in the docs mentioned it.

What's now documented

Across all six docs/SDKs/quote-*.md pages:

  1. name is trimmed on create and update, and a whitespace-only name returns a 400. " Acme " is stored as "Acme"; interior spaces are untouched.
  2. Duplicate naming — the copy is Copy of <source>, truncated to the 255-character column limit.
  3. The expired-quote endpoint keeps the original name on the draft it creates — no Copy of prefix — so repeated renewals cannot compound into Copy of Copy of ….

All three matter for one reason: sending a quote snapshots its current name onto the TurboSign document, so that name is what signers read in the request email and on the signed PDF. Each page says so explicitly.

Pre-existing inaccuracy corrected

Every one of the six pages carried this:

:::warning There is no extend or resend action
action accepts only "void" and "decline".

renew has been a valid action for some time (Joi.string().valid("void", "decline", "renew")), and reason is optional for it. This wasn't introduced here, but it's the action whose naming behaviour item 3 describes — documenting the renewal rule while the page denied the action exists would have been unreadable. The pages now list all three and note the reason rule.

New user guide

docs/TurboQuote/Renaming a Quote.md — covers both rename entry points (the quote page header, and the ⋮ menu in the quotes list), the naming rules, why duplicates arrive as Copy of …, and why renaming is draft-only with the void-and-resend workaround.

Screenshots — not included

This guide ships without screenshots. The repo's convention is /guidewright-capture, which drives the live UI and draws the red click-target boxes; it isn't installed in the environment this was written in, and hand-cropped images wouldn't match the surrounding pages. The prose is structured so captures can be dropped in per step without restructuring.

Happy to add them in a follow-up, or for a reviewer with the skill installed to run it on this branch.

Verification

Pre-Review Checklist

  • Targets develop, not main
  • No internal repo or PR references (public repo)
  • Existing page structure and admonition style preserved
  • Screenshots for the new guide (blocked — see above)

🤖 Generated with Claude Code

Quote names gained two behaviours that every SDK and API caller sees with no
version bump, and neither was documented:

- `name` is trimmed on create and update, and a whitespace-only name is a 400
- a duplicate is `Copy of <source>` capped at 255; the draft that the
  expired-quote endpoint creates keeps the ORIGINAL name, so repeated renewals
  never compound into `Copy of Copy of ...`

Both matter because sending a quote snapshots its name onto the TurboSign
document — that name is what signers read.

Also corrects a pre-existing inaccuracy: all six SDK pages claimed
`handleExpiredQuote` accepts "only void and decline". `renew` has been valid for
some time, and it is the action whose naming behaviour this change describes, so
leaving it undocumented made the new note unreadable. The pages now list all
three actions and note that `reason` is optional for `renew` only.

Adds a user guide for renaming a quote, covering both entry points, the naming
rules, and why renaming is draft-only.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@amitsharma-turbodocx
amitsharma-turbodocx force-pushed the docs/turboquote-rename-and-expiry-actions branch from 41ad0b6 to 785d9c4 Compare August 19, 2026 17:25
@amitsharma-turbodocx
amitsharma-turbodocx merged commit 5e959b1 into develop Aug 20, 2026
1 check passed
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.

3 participants