@enbbox/api 1.0.0

package/dist/esm/models/create-notification-group.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * Create a notification group to categorize workflows.
+ */
+export interface CreateNotificationGroup {
+    /**
+     * Display name.
+     */
+    'name': string;
+}

package/dist/esm/models/create-notification-group.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/create-project.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * Create a new project.
+ */
+export interface CreateProject {
+    /**
+     * Project display name.
+     */
+    'name': string;
+}

package/dist/esm/models/create-project.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/create-subscriber.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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.
+ */
+/**
+ * Create or upsert a subscriber (notification recipient). The `subscriber_id` is your unique key for this user.
+ */
+export interface CreateSubscriber {
+    /**
+     * URL to the subscriber\'s avatar image.
+     */
+    'avatar'?: string | null;
+    /**
+     * Arbitrary key-value metadata attached to this subscriber.
+     */
+    'data': object;
+    /**
+     * Subscriber\'s email address, used for email channel delivery.
+     */
+    'email'?: string | null;
+    /**
+     * Subscriber\'s first (given) name.
+     */
+    'first_name'?: string | null;
+    /**
+     * Subscriber\'s last (family) name.
+     */
+    'last_name'?: string | null;
+    /**
+     * IETF BCP 47 locale tag for localized content delivery.
+     */
+    'locale'?: string | null;
+    /**
+     * Subscriber\'s phone number in E.164 format, used for SMS channel delivery.
+     */
+    'phone'?: string | null;
+    /**
+     * Unique identifier for this subscriber in your system (e.g. user ID).
+     */
+    'subscriber_id': string;
+    /**
+     * IANA timezone identifier for time-aware scheduling.
+     */
+    'timezone'?: string | null;
+}

package/dist/esm/models/create-subscriber.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/create-subscription.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+/**
+ * Subscribe a subscriber to a topic.
+ */
+export interface CreateSubscription {
+    'subscribers': Array<string>;
+}

package/dist/esm/models/create-subscription.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/create-topic.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * Create a topic for subscriber fan-out notifications.
+ */
+export interface CreateTopic {
+    /**
+     * Topic key.
+     */
+    'key': string;
+    /**
+     * Display name.
+     */
+    'name': string;
+}

package/dist/esm/models/create-topic.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/create-webhook.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * Register a new webhook endpoint to receive event callbacks.
+ */
+export interface CreateWebhook {
+    /**
+     * Event types this webhook subscribes to.
+     */
+    'events'?: Array<string>;
+    /**
+     * Webhook callback URL.
+     */
+    'url': string;
+}

package/dist/esm/models/create-webhook.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/create-workflow.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+import type { PreferenceChannels } from './preference-channels';
+import type { WorkflowStepCreate } from './workflow-step-create';
+/**
+ * Create a multi-step notification workflow. Each step sends through a specific channel (email, SMS, push, etc.).
+ */
+export interface CreateWorkflow {
+    /**
+     * Whether the workflow is active. Inactive workflows ignore triggers.
+     */
+    'active'?: boolean | null;
+    /**
+     * Whether notifications from this workflow are critical (bypass subscriber preferences).
+     */
+    'critical'?: boolean | null;
+    /**
+     * Optional description of what this workflow does.
+     */
+    'description'?: string | null;
+    /**
+     * Human-readable workflow name.
+     */
+    'name': string;
+    /**
+     * Notification group this workflow belongs to.
+     */
+    'notification_group_id': string;
+    /**
+     * Per-channel preference overrides for this workflow.
+     */
+    'preference_settings'?: PreferenceChannels | null;
+    /**
+     * Ordered list of workflow steps.
+     */
+    'steps': Array<WorkflowStepCreate>;
+    /**
+     * Tags for organizing and filtering workflows.
+     */
+    'tags'?: Array<string> | null;
+}

package/dist/esm/models/create-workflow.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/cta-type.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 declare const CtaType: {
+    readonly Redirect: "redirect";
+};
+export type CtaType = typeof CtaType[keyof typeof CtaType];

package/dist/esm/models/cta-type.js

@@ -0,0 +1,19 @@
+/* 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'
+};

package/dist/esm/models/cursor-meta.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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/dist/esm/models/cursor-meta.js

@@ -0,0 +1,14 @@
+/* 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 {};

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

@@ -0,0 +1,34 @@
+/**
+ * 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/dist/esm/models/cursor-paginated-feed-item-data-inner.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/cursor-paginated-feed-item.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+import type { CursorMeta } from './cursor-meta';
+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/dist/esm/models/cursor-paginated-feed-item.js

@@ -0,0 +1,14 @@
+/* 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 {};

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

@@ -0,0 +1,39 @@
+/**
+ * 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/dist/esm/models/cursor-paginated-message-record-data-inner.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/cursor-paginated-message-record.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+import type { CursorMeta } from './cursor-meta';
+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/dist/esm/models/cursor-paginated-message-record.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/cursor-pagination.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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/dist/esm/models/cursor-pagination.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/delete-subscription.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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>;
+}