@enbbox/api 1.0.0 → 1.1.0

package/models/preview-result.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 PreviewResult {
+    'rendered': string;
+}
+

package/models/price-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.
+ */
+
+
+
+/**
+ * Price info for a plan tier.
+ */
+export interface PriceInfo {
+    /**
+     * Annual price in cents (null for free/enterprise).
+     */
+    'annual_price'?: number | null;
+    /**
+     * Currency code (e.g., \"usd\").
+     */
+    'currency': string;
+    /**
+     * Monthly price in cents (null for free/enterprise).
+     */
+    'monthly_price'?: number | null;
+    /**
+     * Plan tier label.
+     */
+    'tier': string;
+}
+

package/models/prices.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 { PriceInfo } from './price-info';
+
+/**
+ * Available plan prices.
+ */
+export interface Prices {
+    'prices': Array<PriceInfo>;
+}
+

package/models/project-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Branding } from './branding';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Plan } from './plan';
+
+/**
+ * Full project record with branding and service tier info.
+ */
+export interface ProjectRecord {
+    /**
+     * Branding configuration.
+     */
+    'branding'?: Branding | null;
+    /**
+     * Project UUID.
+     */
+    'id': string;
+    /**
+     * Display name.
+     */
+    'name': string;
+    /**
+     * Billing plan.
+     */
+    'plan': Plan;
+}
+
+
+

package/models/set-credentials.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.
+ */
+
+
+
+/**
+ * Set provider credentials on a subscriber (e.g. FCM token).
+ */
+export interface SetCredentials {
+    'credentials': object;
+    'device_tokens'?: Array<string>;
+    /**
+     * Provider identifier.
+     */
+    'provider_id': string;
+    'webhook_url'?: string | null;
+}
+

package/models/step-preview.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.
+ */
+
+
+
+/**
+ * Request body for previewing a rendered step template.
+ */
+export interface StepPreview {
+    'payload': any;
+}
+

package/models/step-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.
+ */
+
+
+
+/**
+ * A workflow step with its template and active status.
+ */
+export interface StepRecord {
+    /**
+     * Whether this resource is active.
+     */
+    'active': boolean;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    /**
+     * Display name.
+     */
+    'name'?: string | null;
+    'step_type': string;
+    'template'?: any;
+}
+

package/models/step-type.ts

@@ -0,0 +1,37 @@
+/* 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.
+ */
+
+
+
+/**
+ * Combined step type used in workflow step definitions.
+ */
+
+export const StepType = {
+    InApp: 'in_app',
+    Email: 'email',
+    Sms: 'sms',
+    Chat: 'chat',
+    Push: 'push',
+    Digest: 'digest',
+    Trigger: 'trigger',
+    Delay: 'delay',
+    Throttle: 'throttle',
+    Custom: 'custom'
+} as const;
+
+export type StepType = typeof StepType[keyof typeof StepType];
+
+
+

package/models/subscriber-credential.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.
+ */
+
+
+
+/**
+ * Provider credentials stored on a subscriber (e.g. FCM device tokens).
+ */
+export interface SubscriberCredential {
+    'credentials'?: any;
+    'device_tokens'?: Array<string>;
+    'provider_id': string;
+    'webhook_url'?: string | null;
+}
+

package/models/subscriber-payload.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.
+ */
+
+
+
+/**
+ * @type SubscriberPayload
+ * Either a subscriber ID string (e.g. \"user_123\") or a full inline subscriber object with profile data.
+ */
+import { CreateSubscriber } from './create-subscriber';
+export type SubscriberPayload = CreateSubscriber | string;
+
+

package/models/subscriber-record.ts

@@ -0,0 +1,69 @@
+/* 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 { SubscriberCredential } from './subscriber-credential';
+
+/**
+ * Full subscriber profile as stored in the system.
+ */
+export interface SubscriberRecord {
+    /**
+     * Avatar URL.
+     */
+    'avatar'?: string | null;
+    /**
+     * Push/chat provider credentials for this subscriber.
+     */
+    'credentials'?: Array<SubscriberCredential>;
+    /**
+     * Email address.
+     */
+    'email'?: string | null;
+    /**
+     * First name.
+     */
+    'first_name'?: string | null;
+    /**
+     * Internal UUID assigned by the system.
+     */
+    'id': string;
+    /**
+     * Whether the subscriber is currently connected via SSE/WebSocket.
+     */
+    'is_online'?: boolean;
+    /**
+     * Last name.
+     */
+    'last_name'?: string | null;
+    /**
+     * ISO 8601 timestamp of when the subscriber was last seen online.
+     */
+    'last_online_at'?: string | null;
+    /**
+     * Locale tag.
+     */
+    'locale'?: string | null;
+    /**
+     * Phone number.
+     */
+    'phone'?: string | null;
+    /**
+     * Your unique subscriber identifier.
+     */
+    'subscriber_id': string;
+}
+

package/models/subscription.ts

@@ -0,0 +1,73 @@
+/* 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 { EventsUsage } from './events-usage';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Plan } from './plan';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { TrialInfo } from './trial-info';
+
+/**
+ * Current subscription details.
+ */
+export interface Subscription {
+    /**
+     * Billing interval (month or year).
+     */
+    'billing_interval'?: string | null;
+    /**
+     * Cancellation date (ISO 8601), if scheduled.
+     */
+    'cancel_at'?: string | null;
+    /**
+     * Billing period end (ISO 8601).
+     */
+    'current_period_end'?: string | null;
+    /**
+     * Billing period start (ISO 8601).
+     */
+    'current_period_start'?: string | null;
+    /**
+     * Events usage in the current period.
+     */
+    'events': EventsUsage;
+    /**
+     * Whether the customer has a payment method on file.
+     */
+    'has_payment_method': boolean;
+    /**
+     * Whether the subscription is active.
+     */
+    'is_active': boolean;
+    /**
+     * Current plan.
+     */
+    'plan': Plan;
+    /**
+     * Stripe subscription status (active, past_due, canceled, etc.).
+     */
+    'status': string;
+    /**
+     * Trial information.
+     */
+    'trial': TrialInfo;
+}
+
+
+

package/models/sync-workflow.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 { WorkflowStepCreate } from './workflow-step-create';
+
+/**
+ * Sync a workflow from code-first definitions.
+ */
+export interface SyncWorkflow {
+    'steps': Array<WorkflowStepCreate>;
+}
+

package/models/system-avatar-icon.ts

@@ -0,0 +1,33 @@
+/* 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.
+ */
+
+
+
+/**
+ * System avatar icons.
+ */
+
+export const SystemAvatarIcon = {
+    Warning: 'warning',
+    Info: 'info',
+    Error: 'error',
+    Success: 'success',
+    Up: 'up',
+    Question: 'question'
+} as const;
+
+export type SystemAvatarIcon = typeof SystemAvatarIcon[keyof typeof SystemAvatarIcon];
+
+
+

package/models/topic-record.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.
+ */
+
+
+
+export interface TopicRecord {
+    /**
+     * Topic key.
+     */
+    'key': string;
+    /**
+     * Display name.
+     */
+    'name': string;
+    'subscribers': Array<string>;
+}
+

package/models/topic-subscribers.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.
+ */
+
+
+
+/**
+ * Manage subscribers on a topic (add/remove).
+ */
+export interface TopicSubscribers {
+    'subscribers': Array<string>;
+}
+

package/models/topic-subscription-record.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 subscription linking a subscriber to a topic.
+ */
+export interface TopicSubscriptionRecord {
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    'metadata'?: object | null;
+    /**
+     * Subscriber identifier.
+     */
+    'subscriber_id': string;
+    /**
+     * Topic key for fan-out.
+     */
+    'topic_key': string;
+}
+

package/models/topic-subscription.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.
+ */
+
+
+
+/**
+ * A topic subscription with metadata.
+ */
+export interface TopicSubscription {
+    /**
+     * Topic key for fan-out.
+     */
+    'topic_key': string;
+    'topic_name': string;
+}
+

package/models/trial-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.
+ */
+
+
+
+/**
+ * Trial status information.
+ */
+export interface TrialInfo {
+    /**
+     * Days remaining in the trial.
+     */
+    'days_total': number;
+    /**
+     * Trial end date (ISO 8601).
+     */
+    'end'?: string | null;
+    /**
+     * Whether the trial is currently active.
+     */
+    'is_active': boolean;
+    /**
+     * Trial start date (ISO 8601).
+     */
+    'start'?: string | null;
+}
+