Skip to content

docs(events): document and deprecate objectId in favor of objectIdStr (AUD-907)#190

Merged
ggoranov-smar merged 3 commits into
smartsheet:mainlinefrom
vitoraykov:docs/AUD-907-objectidstr-advanced
Jun 29, 2026
Merged

docs(events): document and deprecate objectId in favor of objectIdStr (AUD-907)#190
ggoranov-smar merged 3 commits into
smartsheet:mainlinefrom
vitoraykov:docs/AUD-907-objectidstr-advanced

Conversation

@vitoraykov

@vitoraykov vitoraykov commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the objectIdStr property on the Event interface and marks the older numeric objectId property as deprecated. The objectIdStr property itself was added to the SDK in #177; this PR adds the user-facing documentation and the deprecation marker.

objectIdStr holds the affected object's identifier as a string and supports both numeric and non-numeric identifiers. The existing numeric objectId property is deprecated (kept for backward compatibility) — it contains -1 when the identifier is non-numeric, in which case the real value is only available in objectIdStr. New code should read objectIdStr.

Changes

  • ADVANCED.md — add an explanatory paragraph plus a before/after code sample to the Event Reporting section showing event.objectIdStr (preferred) vs. event.objectId (deprecated).
  • lib/events/types.ts — add a JSDoc @deprecated tag to the objectId property in the Event interface pointing to objectIdStr.
  • CHANGELOG.md — add a Deprecated entry under Unreleased.

Notes for reviewers

  • This is a soft deprecation. The JSDoc states that objectId is not scheduled for removal — matching the API changelog (Jun-08-2026). The @deprecated tag surfaces as an IDE strikethrough; it has no runtime effect. Please flag if you'd prefer stronger or weaker language.
  • The generated dist/lib/events/types.d.ts is not edited here — it regenerates from source on build/release.
  • Part of AUD-907. Parallel PRs apply the equivalent documentation + deprecation to the Python, Java, and C# SDKs, and a cross-language migration guide is going into api-docs.

Related

@vitoraykov vitoraykov changed the title docs(events): document objectIdStr in Event Reporting (AUD-907) docs(events): document and deprecate objectId in favor of objectIdStr (AUD-907) Jun 29, 2026
@ggoranov-smar
ggoranov-smar merged commit 880278d into smartsheet:mainline Jun 29, 2026
5 checks 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.

2 participants