Interface: UpdateSubscriptionRequest

@kortexya/reasoninglayer / UpdateSubscriptionRequest

Interface: UpdateSubscriptionRequest

Defined in: src/types/subscriptions.ts:150

An edit of a stored subscription. Every field is optional; at least one must be set.

Remarks

An omitted field keeps its stored value. features and kinds REPLACE the stored set; they do not merge. The id, the creation time and the delivery counters are kept.

Example

// Pause delivery and drop the sort filter.
const edit: UpdateSubscriptionRequest = { enabled: false, sort: null };

Properties

backoffMs?

optional backoffMs?: number

Defined in: src/types/subscriptions.ts:178

A new backoff between attempts, in milliseconds.

enabled?

optional enabled?: boolean

Defined in: src/types/subscriptions.ts:180

false pauses delivery — no later event reaches the target — and true resumes it.

exact?

optional exact?: boolean

Defined in: src/types/subscriptions.ts:159

Match the sort exactly instead of by subsumption.

features?

optional features?: Record<string, string>

Defined in: src/types/subscriptions.ts:167

Replacement feature equalities — the whole set, not a merge.

Remarks

The keys are feature names and reach the engine verbatim — they are not rewritten to snake_case.

kinds?

optional kinds?: SubscriptionEventKind[]

Defined in: src/types/subscriptions.ts:169

Replacement kinds. An empty list means all four.

maxRetries?

optional maxRetries?: number

Defined in: src/types/subscriptions.ts:176

A new retry count after a failed delivery.

name?

optional name?: string

Defined in: src/types/subscriptions.ts:152

A new name. Must not be empty.

sort?

optional sort?: string | null

Defined in: src/types/subscriptions.ts:157

A new sort filter. null removes the filter, so every sort matches; omitting the key keeps the stored filter.

url?

optional url?: string

Defined in: src/types/subscriptions.ts:174

A new delivery target, held to the same SSRF check as create (see CreateSubscriptionRequest.url).