feat(subscriptions): topic-level updates (PR 5/7)

[sarthak688]

PR 5/7 in the Notification SDK stack. Stacked on top of #516.

Adds the topic-scoped subscription writes. Each method takes an array of update entries, letting callers batch many subscription toggles into one request.

Methods Added

Layer	Method	Signature
Service	subscriptions.updateTopics()	updateTopics(tenantId: string, subscriptions: TopicSubscriptionUpdate[]): Promise<SubscriptionUpdateTopicsResponse>
Service	subscriptions.updateCategories()	updateCategories(tenantId: string, subscriptions: CategorySubscriptionUpdate[]): Promise<SubscriptionUpdateCategoriesResponse>

Endpoints Called

Method	HTTP	Endpoint	OAuth Scope
updateTopics()	POST	notificationservice_/usersubscriptionservice/api/v1/UserSubscription	NotificationService
updateCategories()	POST	notificationservice_/usersubscriptionservice/api/v1/UserSubscription/CategorySubscription	NotificationService

• UPDATE_TOPIC reuses the same URL as GET_ALL — POST vs GET differentiates the operation. Documented inline in the endpoint constants.
• updateTopics sends { userSubscriptions: [...] }; updateCategories sends { categorySubscriptions: [...] }.
• Each entry is a (topicId|publisherId, isSubscribed, notificationMode) triple.
• Both methods are plural — they take an array of updates (batch), per the SDK singular/plural cardinality convention.

Example Usage

import { NotificationMode, NotificationCategory } from '@uipath/uipath-typescript/notifications';

// Unsubscribe a single topic from a single channel
await subscriptions.updateTopics(tenantId, [
  { topicId: '<topicId>', isSubscribed: false, notificationMode: NotificationMode.Email },
]);

// Unsubscribe from all Error topics under one publisher via email
await subscriptions.updateCategories(tenantId, [
  {
    publisherId: '<publisherId>',
    category: NotificationCategory.Error,
    isSubscribed: false,
    notificationMode: NotificationMode.Email,
  },
]);

API Response vs SDK Response

Method	SDK Response
updateTopics	{ success: true, data: { subscriptions } } (echoes input)
updateCategories	{ success: true, data: { subscriptions } } (echoes input)

Verification

Check	Status
npm run typecheck	✅ clean
npm run lint	✅ 0 warnings, 0 errors
npm run test:unit	✅ notification suite (updateTopics/updateCategories covered)

Integration: both updateTopics and updateCategories have round-trip tests (flip → restore) in the describe.skip block — ready to run once OAuth is wired into the integration harness (the subscription API rejects PAT auth).

Files

Area	Files
Endpoint constants	src/utils/constants/endpoints/notification.ts (UPDATE_TOPIC, UPDATE_CATEGORY)
Types	src/models/notification/subscriptions.types.ts (TopicSubscriptionUpdate, CategorySubscriptionUpdate)
Models	src/models/notification/subscriptions.models.ts (response types + ServiceModel methods)
Service	src/services/notification/subscriptions.ts
Unit tests	tests/unit/services/notification/subscriptions.test.ts
Integration tests	tests/integration/shared/notification/subscriptions.integration.test.ts
Test utils	tests/utils/constants/notification.ts (ERROR_SUBSCRIPTION_INVALID)

PR Stack

#	Branch	Status
1	feat/notifications-sdk	#512
2	feat/notifications-mark-read	#513
3	feat/notifications-delete	#514
4	feat/subscriptions-sdk	#516
5	feat/subscriptions-topic-updates (this PR)	—
6	feat/subscriptions-publisher-updates	upcoming
7	feat/subscriptions-mode-reset	upcoming

🤖 Generated with Claude Code

[claude]

Review findings (1 issue):

New finding posted:

• tests/unit/services/notification/subscriptions.test.ts lines 210–222 — updateCategory error test uses TEST_CONSTANTS.ERROR_MESSAGE (generic) instead of NOTIFICATION_TEST_CONSTANTS.ERROR_SUBSCRIPTION_INVALID (domain-specific), inconsistent with the parallel updateTopic error test. Per conventions, the generic constant is only acceptable for collection methods like getAll.

[sarthak688]

All findings addressed in the latest commit on this branch. Inline reply threads are resolved with commit references.

[claude]

Review finding (1 new):

New finding posted:

• tests/integration/shared/notification/subscriptions.integration.test.ts line 136 — updateCategory has no integration test body. Convention requires every new method to have one, even in a describe.skip file — the body should be written as if it will eventually run. A suggested round-trip block is in the inline comment.

[Sarath1018]

Remove this from PR description: Docs | docs/oauth-scopes.md

[Sarath1018]

for PR gate check-samples to run I think you need to push something or close and open this PR

[claude]

Review finding (1 new):

New finding posted:

• tests/integration/shared/notification/subscriptions.integration.test.ts line 152 — updateCategories restore step hardcodes isSubscribed: true instead of snapshotting the original state before the flip. If the tenant's Error–Email category was originally unsubscribed, the test leaves it subscribed. The sibling updateTopics test (line 119) correctly reads mode.isSubscribed and restores to that exact value. Suggested fix: snapshot the original state from getAll() before flipping, same pattern as updateTopics.

[claude]

✅ No issues found. Checked for bugs and CLAUDE.md compliance.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud