@openmeter/client 1.0.0-beta-91c742cf435f → 1.0.0-beta-940352b52249

package/dist/models/types.d.ts

@@ -424,6 +424,23 @@ export interface EntitlementAccessQueryRequestFeatures {
     /** List of feature keys to evaluate access for. */
     keys: string[];
 }
+/**
+ * The response the recipient returned for a delivery attempt. For webhook channels
+ * this is the HTTP response.
+ */
+export interface NotificationEventDeliveryAttemptResponse {
+    /**
+     * The HTTP status code returned by the recipient. Absent when no response was
+     * received.
+     */
+    statusCode?: number;
+    /** The response body returned by the recipient. Empty when no body was received. */
+    body: string;
+    /** How long the delivery attempt took, in milliseconds. */
+    durationMs: bigint;
+    /** The URL the event was delivered to. Only set for webhook channels. */
+    url?: string;
+}
 /**
  * A query filter for an integer attribute. Operators are mutually exclusive, only
  * one operator is allowed at a time.
@@ -1045,6 +1062,29 @@ export interface ChargeReference {
 export interface UpdateResourceReference {
     id: string;
 }
+/** A reference to the feature of an entitlement notification event. */
+export interface NotificationEventFeatureReference {
+    /** The unique identifier of the feature. */
+    id: string;
+    /** The immutable key of the feature. */
+    key: string;
+}
+/** A reference to the invoice of an invoice notification event. */
+export interface NotificationEventInvoiceReference {
+    /** The unique identifier of the invoice. */
+    id: string;
+    /** The human-readable invoice number. */
+    number: string;
+}
+/** Request body for resending a notification event. */
+export interface ResendBillingNotificationEventRequest {
+    /**
+     * The channels to resend the event to. When omitted or empty, the event is resent
+     * to every enabled channel of the rule. Channels not targeted by the rule or
+     * disabled are rejected.
+     */
+    channels?: string[];
+}
 /** Customer reference. */
 export interface BillingCustomerReference {
     /** The ID of the customer. */
@@ -2444,6 +2484,34 @@ export interface UpdateBillingNotificationChannelRequest {
      */
     signingSecret?: string;
 }
+/** A reference to the notification rule that generated an event. */
+export interface NotificationRuleReference {
+    /** The unique identifier of the rule. */
+    id: string;
+    /** The type of event the rule generates. */
+    type: 'entitlements.balance.threshold' | 'entitlements.reset' | 'invoice.created' | 'invoice.updated';
+    /** The user-provided name of the rule. */
+    name: string;
+}
+/** A single delivery attempt to a channel. */
+export interface NotificationEventDeliveryAttempt {
+    /** The delivery state reached by this attempt. */
+    state: 'success' | 'failed' | 'sending' | 'pending' | 'resending';
+    /** The response returned by the recipient. */
+    response: NotificationEventDeliveryAttemptResponse;
+    /** When the attempt was made. */
+    timestamp: Date;
+}
+/**
+ * A balance threshold of a notification rule. Crossing it generates an
+ * `entitlements.balance.threshold` event.
+ */
+export interface NotificationBalanceThreshold {
+    /** What the threshold value is measured against. */
+    type: 'balance_value' | 'usage_percentage' | 'usage_value';
+    /** The threshold value. */
+    value: number;
+}
 /** App customer data. */
 export interface AppCustomerData {
     /**
@@ -3076,6 +3144,19 @@ export interface UpdateTaxCodeConfig {
     /** Tax code applied to the invoice line item. */
     code?: UpdateResourceReference;
 }
+/** The invoice an invoice notification event refers to. */
+export interface NotificationEventInvoiceData {
+    /** The invoice the event was generated for. */
+    invoice: NotificationEventInvoiceReference;
+    /** The identifier of the customer the invoice was issued to. */
+    customerId?: string;
+    /** The currency the invoice is denominated in. */
+    currency: string;
+    /** The status of the invoice at the time the event was generated. */
+    status: string;
+    /** The invoice total, including taxes, at the time the event was generated. */
+    total: string;
+}
 /** Filter options for listing ingested events. */
 export interface ListEventsParamsFilter {
     /** Filter events by ID. */
@@ -3167,6 +3248,43 @@ export interface ListNotificationChannelsParamsFilter {
     createdAt?: DateTimeFieldFilter;
     updatedAt?: DateTimeFieldFilter;
 }
+/** Filter options for listing notification events. */
+export interface ListNotificationEventsParamsFilter {
+    id?: UlidFieldFilter;
+    type?: StringFieldFilterExact;
+    createdAt?: DateTimeFieldFilter;
+    ruleId?: UlidFieldFilter;
+    /**
+     * Filter by a channel of the generating rule. Matches events whose rule targets at
+     * least one of the given channels. Only `eq` and `oeq` are supported.
+     */
+    channelId?: UlidFieldFilter;
+    /**
+     * Filter by delivery state. Matches events where delivery to at least one channel
+     * is in one of the given states. Only `eq` and `oeq` are supported.
+     */
+    deliveryStatus?: StringFieldFilterExact;
+    /**
+     * Filter by the key of the subject the event refers to. Events without a subject
+     * never match, not even with `neq`.
+     */
+    subjectKey?: StringFieldFilterExact;
+    /**
+     * Filter by the id of the subject the event refers to. Events without a subject
+     * never match, not even with `neq`.
+     */
+    subjectId?: UlidFieldFilter;
+    /**
+     * Filter by the key of the feature the event refers to. Events without a feature
+     * never match, not even with `neq`.
+     */
+    featureKey?: StringFieldFilterExact;
+    /**
+     * Filter by the id of the feature the event refers to. Events without a feature
+     * never match, not even with `neq`.
+     */
+    featureId?: UlidFieldFilter;
+}
 /** Resource filters. */
 export interface ResourceFilters {
     name?: StringFieldFilter;
@@ -4111,6 +4229,27 @@ export interface NotificationChannelPagePaginatedResponse {
     data: NotificationChannel[];
     meta: PaginatedMeta;
 }
+/**
+ * The delivery status of a notification event for one channel of the generating
+ * rule.
+ */
+export interface NotificationEventDeliveryStatus {
+    /** The identifier of the channel this delivery status belongs to. */
+    channelId: string;
+    /** The current delivery state. */
+    state: 'success' | 'failed' | 'sending' | 'pending' | 'resending';
+    /** The reason for the last state change. Empty for successful deliveries. */
+    reason: string;
+    /** When the delivery state was last updated. */
+    updatedAt: Date;
+    /**
+     * When the next delivery attempt is scheduled. Absent when no further attempts
+     * will be made.
+     */
+    nextAttempt?: Date;
+    /** The delivery attempts made so far, most recent first. */
+    attempts: NotificationEventDeliveryAttempt[];
+}
 /** Billing customer data. */
 export interface CustomerData {
     /**
@@ -4178,6 +4317,37 @@ export interface ListCustomerEntitlementAccessResponseData {
     /** The list of entitlement access results. */
     data: EntitlementValueResult[];
 }
+/** The entities and threshold a balance threshold event refers to. */
+export interface NotificationEventBalanceThresholdData {
+    /** The identifier of the entitlement that triggered the event. */
+    entitlementId: string;
+    /** The feature the entitlement grants access to. */
+    feature: NotificationEventFeatureReference;
+    /** The key of the subject the entitlement belongs to. */
+    subjectKey: string;
+    /** The identifier of the customer the subject belongs to, if any. */
+    customerId?: string;
+    /** The entitlement value at the time the event was generated. */
+    value: EntitlementValueResult;
+    /** The threshold the balance crossed. */
+    threshold: NotificationBalanceThreshold;
+}
+/**
+ * The entitlement, feature, and subject an entitlement notification event refers
+ * to.
+ */
+export interface NotificationEventEntitlementData {
+    /** The identifier of the entitlement that triggered the event. */
+    entitlementId: string;
+    /** The feature the entitlement grants access to. */
+    feature: NotificationEventFeatureReference;
+    /** The key of the subject the entitlement belongs to. */
+    subjectKey: string;
+    /** The identifier of the customer the subject belongs to, if any. */
+    customerId?: string;
+    /** The entitlement value at the time the event was generated. */
+    value: EntitlementValueResult;
+}
 /**
  * Graduated tiered price.
  *
@@ -4415,6 +4585,28 @@ export interface PlanAddonPagePaginatedResponse {
     data: PlanAddon[];
     meta: PaginatedMeta;
 }
+/** An invoice created notification event payload. */
+export interface NotificationEventInvoiceCreatedPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'invoice.created';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The invoice the event refers to. */
+    data: NotificationEventInvoiceData;
+}
+/** An invoice updated notification event payload. */
+export interface NotificationEventInvoiceUpdatedPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'invoice.updated';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The invoice the event refers to. */
+    data: NotificationEventInvoiceData;
+}
 /** Cursor paginated response. */
 export interface IngestedEventPaginatedResponse {
     data: IngestedEvent[];
@@ -5046,6 +5238,28 @@ export interface EntitlementAccessQueryResult {
      */
     updatedAt: Date;
 }
+/** A balance threshold notification event payload. */
+export interface NotificationEventBalanceThresholdPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'entitlements.balance.threshold';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The entities and threshold the event refers to. */
+    data: NotificationEventBalanceThresholdData;
+}
+/** An entitlement reset notification event payload. */
+export interface NotificationEventResetPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'entitlements.reset';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The entities the event refers to. */
+    data: NotificationEventEntitlementData;
+}
 /** A capability or billable dimension offered by a provider. */
 export interface Feature {
     id: string;
@@ -5698,6 +5912,25 @@ export interface ProfileApps {
     /** The payment app used for this workflow. */
     payment: App;
 }
+/**
+ * A notification event records that a notification rule fired and tracks the
+ * delivery of its payload to each channel of the rule. Events are created by the
+ * system and cannot be modified.
+ */
+export interface NotificationEvent {
+    /** The unique identifier of the event. */
+    id: string;
+    /** The type of the event. */
+    type: 'entitlements.balance.threshold' | 'entitlements.reset' | 'invoice.created' | 'invoice.updated';
+    /** When the event was generated. */
+    createdAt: Date;
+    /** The rule that generated the event. */
+    rule: NotificationRuleReference;
+    /** The delivery status of the event, one entry per channel of the rule. */
+    deliveryStatus: NotificationEventDeliveryStatus[];
+    /** The payload delivered to the channels. */
+    payload: NotificationEventPayload;
+}
 /** A subscription item pins a rate card to a cadence within a subscription phase. */
 export interface SubscriptionItem {
     /** The unique identifier of the subscription item instance. */
@@ -6135,6 +6368,11 @@ export interface ChargeRealization {
      */
     detailedLines?: ChargeRealizationDetailedLine[];
 }
+/** Page paginated response. */
+export interface NotificationEventPagePaginatedResponse {
+    data: NotificationEvent[];
+    meta: PaginatedMeta;
+}
 /**
  * A subscription phase groups the rate cards in effect for a segment of the
  * subscription's lifetime. Analogous to plan phases.
@@ -7174,6 +7412,8 @@ export type CreateEntitlementRequest = CreateEntitlementMeteredRequest | CreateE
 export type App = AppStripe | AppSandbox | AppExternalInvoicing;
 /** Response of the app install. */
 export type BillingInstallAppResponse = InstalledAppStripe | InstalledAppSandbox | InstalledAppExternalInvoicing;
+/** The payload delivered to the channels, discriminated by the event type. */
+export type NotificationEventPayload = NotificationEventBalanceThresholdPayload | NotificationEventResetPayload | NotificationEventInvoiceCreatedPayload | NotificationEventInvoiceUpdatedPayload;
 /** Feature or reference. */
 export type FeatureOrReference = Feature | FeatureReference;
 /** ChargeRealizationInvoice or reference. */

package/dist/sdk/internal.d.ts

@@ -2,6 +2,8 @@ import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
 import type { CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse, UpdateSubscriptionAddonRequest, UpdateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
 import type { ExecuteAppActionRequest, ExecuteAppActionResponse } from '../models/operations/apps.js';
+import type { ListNotificationEventsRequest, ListNotificationEventsResponse, GetNotificationEventRequest, GetNotificationEventResponse, ResendNotificationEventRequest, ResendNotificationEventResponse } from '../models/operations/notifications.js';
+import type { NotificationEvent } from '../models/types.js';
 /**
  * Operations marked internal in the API definition. They are not part of
  * the customer surface: they may require additional permissions, and they
@@ -14,6 +16,8 @@ export declare class Internal {
     get subscriptions(): InternalSubscriptions;
     private _apps?;
     get apps(): InternalApps;
+    private _notifications?;
+    get notifications(): InternalNotifications;
 }
 export declare class InternalSubscriptions {
     private readonly _client;
@@ -50,3 +54,45 @@ export declare class InternalApps {
      */
     executeAction(request: ExecuteAppActionRequest, options?: RequestOptions): Promise<ExecuteAppActionResponse>;
 }
+export declare class InternalNotifications {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * List notification events
+     *
+     * List all notification events.
+     *
+     * GET /openmeter/notification/events
+     */
+    listEvents(request?: ListNotificationEventsRequest, options?: RequestOptions): Promise<ListNotificationEventsResponse>;
+    /**
+     * List notification events
+     *
+     * List all notification events.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/notification/events
+     */
+    listEventsAll(request?: ListNotificationEventsRequest, options?: RequestOptions): AsyncIterable<NotificationEvent>;
+    /**
+     * Get notification event
+     *
+     * Get a notification event by id.
+     *
+     * GET /openmeter/notification/events/{notificationEventId}
+     */
+    getEvent(request: GetNotificationEventRequest, options?: RequestOptions): Promise<GetNotificationEventResponse>;
+    /**
+     * Resend notification event
+     *
+     * Resend a notification event to the channels of the rule that generated it.
+     *
+     * Delivery is asynchronous: the request marks the selected channels for redelivery
+     * and returns immediately. Channels whose delivery is still pending or already
+     * being resent are left untouched.
+     *
+     * POST /openmeter/notification/events/{notificationEventId}/resend
+     */
+    resendEvent(request: ResendNotificationEventRequest, options?: RequestOptions): Promise<ResendNotificationEventResponse>;
+}

package/dist/sdk/internal.js

@@ -1,7 +1,9 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
+import { paginatePages } from '../lib/paginate.js';
 import { createSubscriptionAddon, updateSubscriptionAddon, } from '../funcs/subscriptions.js';
 import { executeAppAction } from '../funcs/apps.js';
+import { listNotificationEvents, getNotificationEvent, resendNotificationEvent, } from '../funcs/notifications.js';
 /**
  * Operations marked internal in the API definition. They are not part of
  * the customer surface: they may require additional permissions, and they
@@ -20,6 +22,10 @@ export class Internal {
     get apps() {
         return (this._apps ??= new InternalApps(this._client));
     }
+    _notifications;
+    get notifications() {
+        return (this._notifications ??= new InternalNotifications(this._client));
+    }
 }
 export class InternalSubscriptions {
     _client;
@@ -66,3 +72,55 @@ export class InternalApps {
         return unwrap(await executeAppAction(this._client, request, options));
     }
 }
+export class InternalNotifications {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * List notification events
+     *
+     * List all notification events.
+     *
+     * GET /openmeter/notification/events
+     */
+    async listEvents(request, options) {
+        return unwrap(await listNotificationEvents(this._client, request, options));
+    }
+    /**
+     * List notification events
+     *
+     * List all notification events.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/notification/events
+     */
+    listEventsAll(request, options) {
+        return paginatePages((req, opts) => listNotificationEvents(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Get notification event
+     *
+     * Get a notification event by id.
+     *
+     * GET /openmeter/notification/events/{notificationEventId}
+     */
+    async getEvent(request, options) {
+        return unwrap(await getNotificationEvent(this._client, request, options));
+    }
+    /**
+     * Resend notification event
+     *
+     * Resend a notification event to the channels of the rule that generated it.
+     *
+     * Delivery is asynchronous: the request marks the selected channels for redelivery
+     * and returns immediately. Channels whose delivery is still pending or already
+     * being resent are left untouched.
+     *
+     * POST /openmeter/notification/events/{notificationEventId}/resend
+     */
+    async resendEvent(request, options) {
+        return unwrap(await resendNotificationEvent(this._client, request, options));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-91c742cf435f",
+  "version": "1.0.0-beta-940352b52249",
   "description": "Official TypeScript SDK for the OpenMeter API — usage metering and billing",
   "keywords": [
     "openmeter",