deprecated: Mark isSequenceOf as deprecated and document Segment as alternative (DEV-3455)

[BalduinLandolt]

Pull Request Checklist

Task Description/Number

Issue Number: DEV-

PR Type

• build/chore: maintenance tasks (no production code change)
• docs: documentation changes (no production code change)
• feat: represents new features
• fix: represents bug fixes
• perf: performance improvements
• refactor: represents production code refactoring
• test: adding or refactoring tests (no production code change)

Basic requirements for bug fixes and features

• Tests for the changes have been added
• Docs have been added / updated

Does this PR introduce a breaking change?

• Yes

Does this PR change client-test-data?

• Yes

[linear]

DEV-3455 Segment documentation in API

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 13.49%. Comparing base (62260e4) to head (8e81059).
Report is 15 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #3161       +/-   ##
===========================================
- Coverage   88.79%   13.49%   -75.30%     
===========================================
  Files         265      269        +4     
  Lines       22260    22334       +74     
===========================================
- Hits        19765     3014    -16751     
- Misses       2495    19320    +16825     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mpro7]

Please check my comment below.

[siers]

Read through all of it, sounds good!