@enbbox/api 1.0.0 → 1.0.1

package/models/cta-type.ts

@@ -0,0 +1,28 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * CTA (Call to Action) type for in-app notification buttons.
+ */
+
+export const CtaType = {
+    Redirect: 'redirect'
+} as const;
+
+export type CtaType = typeof CtaType[keyof typeof CtaType];
+
+
+

package/models/cursor-meta.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Metadata about the current page in a cursor-paginated response.
+ */
+export interface CursorMeta {
+    /**
+     * Whether more items exist beyond this page.
+     */
+    'has_more': boolean;
+    /**
+     * Current page size.
+     */
+    'limit': number;
+    /**
+     * Cursor to pass as `after` to fetch the next page.
+     */
+    'next_cursor'?: string | null;
+    /**
+     * Cursor to pass as `before` to fetch the previous page.
+     */
+    'prev_cursor'?: string | null;
+}
+

package/models/cursor-paginated-feed-item-data-inner.ts

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * A notification feed item for subscriber-facing display.
+ */
+export interface CursorPaginatedFeedItemDataInner {
+    'channel': string;
+    'content': string;
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    'data'?: any;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    'is_read': boolean;
+    'is_seen': boolean;
+    'subject'?: string | null;
+    /**
+     * Subscriber identifier.
+     */
+    'subscriber_id': string;
+}
+

package/models/cursor-paginated-feed-item.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CursorMeta } from './cursor-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CursorPaginatedFeedItemDataInner } from './cursor-paginated-feed-item-data-inner';
+
+/**
+ * A cursor-paginated response containing a `data` array and `meta` with cursors for navigation.
+ */
+export interface CursorPaginatedFeedItem {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<CursorPaginatedFeedItemDataInner>;
+    /**
+     * Cursor pagination metadata.
+     */
+    'meta': CursorMeta;
+}
+

package/models/cursor-paginated-message-record-data-inner.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * A sent message with content, channel, and delivery metadata.
+ */
+export interface CursorPaginatedMessageRecordDataInner {
+    'channel': string;
+    'content': string;
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    'data'?: any;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    'is_archived': boolean;
+    'is_read': boolean;
+    'is_seen': boolean;
+    /**
+     * Provider identifier.
+     */
+    'provider_id'?: string | null;
+    'subject'?: string | null;
+    /**
+     * Subscriber identifier.
+     */
+    'subscriber_id': string;
+}
+

package/models/cursor-paginated-message-record.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CursorMeta } from './cursor-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CursorPaginatedMessageRecordDataInner } from './cursor-paginated-message-record-data-inner';
+
+/**
+ * A cursor-paginated response containing a `data` array and `meta` with cursors for navigation.
+ */
+export interface CursorPaginatedMessageRecord {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<CursorPaginatedMessageRecordDataInner>;
+    /**
+     * Cursor pagination metadata.
+     */
+    'meta': CursorMeta;
+}
+

package/models/cursor-pagination.ts

@@ -0,0 +1,34 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Cursor-based pagination for time-ordered streams. Use `after`/`before` cursors returned in previous responses.
+ */
+export interface CursorPagination {
+    /**
+     * Cursor for next page (ISO 8601 timestamp or opaque ID from previous response).
+     */
+    'after'?: string | null;
+    /**
+     * Cursor for previous page.
+     */
+    'before'?: string | null;
+    /**
+     * Maximum number of items to return (1–100, default: 25).
+     */
+    'limit'?: number | null;
+}
+

package/models/delete-subscription.ts

@@ -0,0 +1,20 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface DeleteSubscription {
+    'subscribers': Array<string>;
+}
+

package/models/delivery-ack.ts

@@ -0,0 +1,23 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Acknowledge message delivery from a provider.
+ */
+export interface DeliveryAck {
+    'acknowledged': boolean;
+}
+

package/models/delivery-status-webhook.ts

@@ -0,0 +1,29 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Inbound webhook payload for delivery status updates.
+ */
+export interface DeliveryStatusWebhook {
+    'detail'?: object | null;
+    'message_id': string;
+    'provider': string;
+    /**
+     * Current status.
+     */
+    'status': string;
+}
+

package/models/dns-settings.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * DNS configuration for receiving inbound emails via MX records.
+ */
+export interface DnsSettings {
+    /**
+     * Domain used for inbound email parsing.
+     */
+    'inbound_parse_domain'?: string;
+    /**
+     * Whether the MX record has been verified.
+     */
+    'mx_record_configured'?: boolean;
+}
+

package/models/engagement-stats-response.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Aggregate statistics for subscriber engagement events.
+ */
+export interface EngagementStatsResponse {
+    /**
+     * Total bounced events.
+     */
+    'total_bounced': number;
+    /**
+     * Total clicked events.
+     */
+    'total_clicked': number;
+    /**
+     * Total complained / spam-reported events.
+     */
+    'total_complained': number;
+    /**
+     * Total opened events.
+     */
+    'total_opened': number;
+}
+

package/models/entitlement-item.ts

@@ -0,0 +1,34 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Single entitlement entry.
+ */
+export interface EntitlementItem {
+    /**
+     * Feature key (e.g., \"digest_step\", \"remove_branding\").
+     */
+    'feature_key': string;
+    /**
+     * Whether the feature is active.
+     */
+    'is_active': boolean;
+    /**
+     * Numeric limit value, if applicable.
+     */
+    'value'?: number | null;
+}
+

package/models/entitlements.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { EntitlementItem } from './entitlement-item';
+
+/**
+ * List of active entitlements for the project.
+ */
+export interface Entitlements {
+    'entitlements': Array<EntitlementItem>;
+}
+

package/models/error-detail.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * RFC 7807 Problem Details — a machine-readable error response with a URI type, human-readable title, and optional detail.
+ */
+export interface ErrorDetail {
+    /**
+     * A detailed, human-readable explanation specific to this error occurrence.
+     */
+    'detail'?: string | null;
+    /**
+     * A unique URI identifying this specific occurrence (e.g. trace ID), useful for support.
+     */
+    'instance'?: string | null;
+    /**
+     * A short, human-readable summary of the error type.
+     */
+    'title': string;
+    /**
+     * A URI identifier for the error type, linking to documentation.
+     */
+    'type': string;
+}
+

package/models/events-usage.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Events usage within a billing period (embedded in Subscription).
+ */
+export interface EventsUsage {
+    /**
+     * Events consumed so far.
+     */
+    'current': number;
+    /**
+     * Events included in the plan.
+     */
+    'included'?: number | null;
+}
+

package/models/feed-item.ts

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * A notification feed item for subscriber-facing display.
+ */
+export interface FeedItem {
+    'channel': string;
+    'content': string;
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    'data'?: any;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    'is_read': boolean;
+    'is_seen': boolean;
+    'subject'?: string | null;
+    /**
+     * Subscriber identifier.
+     */
+    'subscriber_id': string;
+}
+

package/models/feed-query.ts

@@ -0,0 +1,28 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Query parameters for listing subscriber notification feed.
+ */
+export interface FeedQuery {
+    'after'?: string | null;
+    'before'?: string | null;
+    'channel'?: string | null;
+    'limit'?: number | null;
+    'read'?: boolean | null;
+    'seen'?: boolean | null;
+}
+

package/models/inbox-notification.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * A notification item in a subscriber inbox feed.
+ */
+export interface InboxNotification {
+    'body': string;
+    'channel_type': string;
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    'data': object;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    'is_archived': boolean;
+    'is_read': boolean;
+    'is_seen': boolean;
+    'read_at'?: string | null;
+    'seen_at'?: string | null;
+    'subject'?: string | null;
+}
+

package/models/inbox-preference.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ChannelPreferences } from './channel-preferences';
+
+/**
+ * Subscriber inbox notification preference settings.
+ */
+export interface InboxPreference {
+    'channels': ChannelPreferences;
+    'workflow_id'?: string | null;
+}
+