@enbbox/api 1.0.0 → 1.0.1

package/models/activity-chart-point.ts

@@ -0,0 +1,46 @@
+/* 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 single data point in the activity timeline chart.
+ */
+export interface ActivityChartPoint {
+    /**
+     * Date string (YYYY-MM-DD).
+     */
+    'date': string;
+    /**
+     * Email channel count.
+     */
+    'email': number;
+    /**
+     * In-app notification count.
+     */
+    'in_app': number;
+    /**
+     * Push notification count.
+     */
+    'push': number;
+    /**
+     * SMS channel count.
+     */
+    'sms': number;
+    /**
+     * Total notifications on this date.
+     */
+    'total': number;
+}
+

package/models/activity-record.ts

@@ -0,0 +1,62 @@
+/* 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.
+ */
+
+
+
+/**
+ * An activity log entry recording one execution step of a notification delivery.
+ */
+export interface ActivityRecord {
+    /**
+     * ISO 8601 timestamp when this activity was recorded.
+     */
+    'created_at': string;
+    /**
+     * Human-readable detail of this execution step.
+     */
+    'detail': string;
+    /**
+     * Execution detail UUID.
+     */
+    'id': string;
+    /**
+     * Whether this was an automatic retry.
+     */
+    'is_retry': boolean;
+    /**
+     * Whether this was a test-mode execution.
+     */
+    'is_test': boolean;
+    /**
+     * Parent job UUID.
+     */
+    'job_id': string;
+    /**
+     * Parent notification UUID.
+     */
+    'notification_id': string;
+    /**
+     * Provider that handled delivery (null if not yet assigned).
+     */
+    'provider_id'?: string | null;
+    /**
+     * Originating source: `api`, `worker`, `webhook`.
+     */
+    'source': string;
+    /**
+     * Execution status: `success`, `failed`, `pending`.
+     */
+    'status': string;
+}
+

package/models/activity-request-record.ts

@@ -0,0 +1,46 @@
+/* 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 record of a trigger API request — which workflow was triggered for which subscribers.
+ */
+export interface ActivityRequestRecord {
+    /**
+     * ISO 8601 timestamp.
+     */
+    'created_at': string;
+    /**
+     * Request UUID.
+     */
+    'id': string;
+    /**
+     * Processing status.
+     */
+    'status': string;
+    /**
+     * List of targeted subscriber IDs.
+     */
+    'subscriber_ids': Array<string>;
+    /**
+     * Client-provided transaction ID for idempotency.
+     */
+    'transaction_id': string;
+    /**
+     * The workflow that was triggered.
+     */
+    'workflow_identifier': string;
+}
+

package/models/activity-stats.ts

@@ -0,0 +1,46 @@
+/* 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.
+ */
+
+
+
+/**
+ * Summary statistics of notification delivery activity.
+ */
+export interface ActivityStats {
+    /**
+     * Notifications sent in the last 30 days.
+     */
+    'monthly_sent': number;
+    /**
+     * Total successful deliveries.
+     */
+    'total_delivered': number;
+    /**
+     * Total failed deliveries.
+     */
+    'total_failed': number;
+    /**
+     * Total pending deliveries.
+     */
+    'total_pending': number;
+    /**
+     * Total notifications sent.
+     */
+    'total_sent': number;
+    /**
+     * Notifications sent in the last 7 days.
+     */
+    'weekly_sent': number;
+}
+

package/models/actor-type.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+
+/**
+ * Actor type for notification attribution.
+ */
+
+export const ActorType = {
+    None: 'none',
+    User: 'user',
+    SystemIcon: 'system_icon',
+    SystemCustom: 'system_custom'
+} as const;
+
+export type ActorType = typeof ActorType[keyof typeof ActorType];
+
+
+

package/models/api-key-created.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.
+ */
+
+
+
+/**
+ * Newly created API key. The raw key is shown only at creation time.
+ */
+export interface ApiKeyCreated {
+    /**
+     * Unique identifier for this API key.
+     */
+    'id': string;
+    /**
+     * The raw API key value. Save this — it will not be shown again.
+     */
+    'key': string;
+    /**
+     * The masked display version.
+     */
+    'masked_key': string;
+    /**
+     * ID of the user who created this key.
+     */
+    'user_id': string;
+}
+

package/models/api-key-info.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.
+ */
+
+
+
+/**
+ * API key metadata. The full key is only shown at creation time.
+ */
+export interface ApiKeyInfo {
+    /**
+     * When the key was created.
+     */
+    'created_at'?: string | null;
+    /**
+     * Unique identifier for this API key.
+     */
+    'id': string;
+    /**
+     * Masked API key (first 12 chars + `...`).
+     */
+    'masked_key': string;
+    /**
+     * ID of the user who created this key.
+     */
+    'user_id': string;
+}
+

package/models/auto-configure-result.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.
+ */
+
+
+
+/**
+ * Result of auto-configuring a provider integration.
+ */
+export interface AutoConfigureResult {
+    'webhook_url': string;
+}
+

package/models/billing-interval.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.
+ */
+
+
+
+/**
+ * Billing interval for paid plans.
+ */
+
+export const BillingInterval = {
+    Month: 'month',
+    Year: 'year'
+} as const;
+
+export type BillingInterval = typeof BillingInterval[keyof typeof BillingInterval];
+
+
+

package/models/branding.ts

@@ -0,0 +1,46 @@
+/* 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.
+ */
+
+
+
+/**
+ * White-label branding for notification center and email templates.
+ */
+export interface Branding {
+    /**
+     * Primary brand color (hex).
+     */
+    'color': string;
+    /**
+     * Background color for content area (hex).
+     */
+    'content_background'?: string | null;
+    /**
+     * Text direction: `ltr` or `rtl`.
+     */
+    'direction'?: string | null;
+    /**
+     * Text color override (hex).
+     */
+    'font_color'?: string | null;
+    /**
+     * Font family for notification UI.
+     */
+    'font_family'?: string | null;
+    /**
+     * URL of the brand logo.
+     */
+    'logo': string;
+}
+

package/models/broadcast-trigger.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.
+ */
+
+
+
+/**
+ * Trigger a broadcast notification to a topic or segment.
+ */
+export interface BroadcastTrigger {
+    /**
+     * Display name.
+     */
+    'name': string;
+    'overrides': object;
+    'payload': object;
+    'transaction_id'?: string | null;
+}
+

package/models/bulk-create-subscribers.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 { CreateSubscriber } from './create-subscriber';
+
+/**
+ * Batch-create multiple subscribers in one request.
+ */
+export interface BulkCreateSubscribers {
+    'subscribers': Array<CreateSubscriber>;
+}
+

package/models/bulk-preference-item.ts

@@ -0,0 +1,25 @@
+/* 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 { PreferenceChannels } from './preference-channels';
+
+export interface BulkPreferenceItem {
+    'channels'?: PreferenceChannels | null;
+    'enabled'?: boolean | null;
+    'workflow_id': string;
+}
+

package/models/bulk-preferences.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 { BulkPreferenceItem } from './bulk-preference-item';
+
+/**
+ * Bulk-update subscriber notification preferences.
+ */
+export interface BulkPreferences {
+    'preferences': Array<BulkPreferenceItem>;
+}
+

package/models/bulk-result.ts

@@ -0,0 +1,24 @@
+/* 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 { SubscriberRecord } from './subscriber-record';
+
+export interface BulkResult {
+    'created': Array<SubscriberRecord>;
+    'failed': Array<string>;
+}
+

package/models/bulk-trigger.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { TriggerEvent } from './trigger-event';
+
+/**
+ * Batch multiple trigger events into one API call for efficient bulk processing.
+ */
+export interface BulkTrigger {
+    /**
+     * Array of trigger events to process.
+     */
+    'events': Array<TriggerEvent>;
+}
+

package/models/channel-connection-record.ts

@@ -0,0 +1,43 @@
+/* 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 channel connection linking a subscriber to a provider with stored credentials.
+ */
+export interface ChannelConnectionRecord {
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    'credentials': object;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    /**
+     * Unique slug identifier.
+     */
+    'identifier': string;
+    /**
+     * Provider identifier.
+     */
+    'provider_id': string;
+    /**
+     * Subscriber identifier.
+     */
+    'subscriber_id': string;
+}
+

package/models/channel-endpoint-record.ts

@@ -0,0 +1,47 @@
+/* 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 channel endpoint for push/chat/webhook delivery.
+ */
+export interface ChannelEndpointRecord {
+    /**
+     * Parent channel connection UUID.
+     */
+    'channel_connection_id': string;
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    /**
+     * Endpoint type (e.g. device_token, webhook_url).
+     */
+    'endpoint_type': string;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    /**
+     * Unique slug identifier.
+     */
+    'identifier': string;
+    'metadata'?: object | null;
+    /**
+     * Delivery target (token, URL, address).
+     */
+    'target': string;
+}
+

package/models/channel-preferences.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.
+ */
+
+
+
+/**
+ * Per-channel notification preference toggles.
+ */
+export interface ChannelPreferences {
+    'chat'?: boolean | null;
+    'email'?: boolean | null;
+    'in_app'?: boolean | null;
+    'push'?: boolean | null;
+    'sms'?: boolean | null;
+}
+