@enbbox/api 1.0.0 → 1.1.0

package/models/channel-type.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+
+/**
+ * Notification delivery channels (from Novu ChannelTypeEnum).
+ */
+
+export const ChannelType = {
+    InApp: 'in_app',
+    Email: 'email',
+    Sms: 'sms',
+    Chat: 'chat',
+    Push: 'push'
+} as const;
+
+export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
+
+
+

package/models/chart-query.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.
+ */
+
+
+
+/**
+ * Query parameters for the activity chart endpoint.
+ */
+export interface ChartQuery {
+    /**
+     * Number of days to include in the chart (1–365, default: 30).
+     */
+    'days'?: number | null;
+}
+

package/models/chat-oauth-request.ts

@@ -0,0 +1,21 @@
+/* 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 ChatOauthRequest {
+    'provider': string;
+    'redirect_uri': string;
+}
+

package/models/chat-oauth.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.
+ */
+
+
+
+/**
+ * OAuth authorization URL for a chat provider.
+ */
+export interface ChatOauth {
+    'oauth_url': string;
+}
+

package/models/checkout-session.ts

@@ -0,0 +1,35 @@
+/* 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 { Plan } from './plan';
+
+/**
+ * Stripe Checkout session created for an upgrade.
+ */
+export interface CheckoutSession {
+    /**
+     * The plan being subscribed to.
+     */
+    'plan': Plan;
+    /**
+     * URL to redirect the user to for Stripe Checkout.
+     */
+    'stripe_checkout_url': string;
+}
+
+
+

package/models/context-record.ts

@@ -0,0 +1,42 @@
+/* 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 context providing typed data to notification templates.
+ */
+export interface ContextRecord {
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    /**
+     * Context data.
+     */
+    'data': object;
+    /**
+     * Context identifier.
+     */
+    'id': string;
+    /**
+     * Context type.
+     */
+    'type': string;
+    /**
+     * ISO 8601 last-modified timestamp.
+     */
+    'updated_at': string;
+}
+

package/models/create-channel-connection.ts

@@ -0,0 +1,35 @@
+/* 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.
+ */
+
+
+
+/**
+ * Create a channel connection linking a subscriber to a delivery provider.
+ */
+export interface CreateChannelConnection {
+    'credentials': object;
+    /**
+     * Unique slug identifier.
+     */
+    'identifier': string;
+    /**
+     * Provider identifier.
+     */
+    'provider_id': string;
+    /**
+     * Subscriber identifier.
+     */
+    'subscriber_id': string;
+}
+

package/models/create-channel-endpoint.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.
+ */
+
+
+
+/**
+ * Register a channel endpoint (device token, webhook URL) for delivery.
+ */
+export interface CreateChannelEndpoint {
+    /**
+     * Parent channel connection UUID.
+     */
+    'channel_connection_id': string;
+    /**
+     * Endpoint type (e.g. device_token, webhook_url).
+     */
+    'endpoint_type': string;
+    /**
+     * Unique slug identifier.
+     */
+    'identifier': string;
+    'metadata'?: object | null;
+    /**
+     * Delivery target (token, URL, address).
+     */
+    'target': string;
+}
+

package/models/create-checkout.ts

@@ -0,0 +1,35 @@
+/* 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 { Plan } from './plan';
+
+/**
+ * Request to create a Stripe Checkout session.
+ */
+export interface CreateCheckout {
+    /**
+     * Billing interval: \"month\" or \"year\".
+     */
+    'billing_interval': string;
+    /**
+     * The plan to subscribe to.
+     */
+    'plan': Plan;
+}
+
+
+

package/models/create-context.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.
+ */
+
+
+
+/**
+ * Create a context — typed key-value data available inside notification templates.
+ */
+export interface CreateContext {
+    /**
+     * Context data accessible in templates via `{{context.type.data.field}}`.
+     */
+    'data': object;
+    /**
+     * Unique context ID within the type (e.g. `acme-corp`).
+     */
+    'id': string;
+    /**
+     * Context type/category (e.g. `tenant`, `app`, `region`).
+     */
+    'type': string;
+}
+

package/models/create-integration.ts

@@ -0,0 +1,51 @@
+/* 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 { ChannelType } from './channel-type';
+
+/**
+ * Register a delivery provider integration. Each integration connects a provider (e.g. SendGrid) to a channel (e.g. email).
+ */
+export interface CreateIntegration {
+    /**
+     * Whether this integration is active and available for routing. Defaults to `true`.
+     */
+    'active'?: boolean | null;
+    /**
+     * Channel this integration serves.
+     */
+    'channel': ChannelType;
+    /**
+     * Routing conditions — JSON rules that control when this integration is selected.
+     */
+    'conditions': object;
+    /**
+     * Provider-specific credentials (API keys, tokens, secrets).
+     */
+    'credentials': object;
+    /**
+     * Human-readable display name for this integration.
+     */
+    'name': string;
+    /**
+     * Provider identifier string (e.g. `sendgrid`, `twilio`, `fcm`).
+     */
+    'provider_id': string;
+}
+
+
+

package/models/create-layout.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.
+ */
+
+
+
+/**
+ * Create a notification layout template (e.g. email wrapper).
+ */
+export interface CreateLayout {
+    'content': string;
+    'description'?: string | null;
+    /**
+     * Unique slug identifier.
+     */
+    'identifier': string;
+    'is_default'?: boolean | null;
+    /**
+     * Display name.
+     */
+    'name': string;
+    'variables': object;
+}
+

package/models/create-notification-group.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.
+ */
+
+
+
+/**
+ * Create a notification group to categorize workflows.
+ */
+export interface CreateNotificationGroup {
+    /**
+     * Display name.
+     */
+    'name': string;
+}
+

package/models/create-project.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.
+ */
+
+
+
+/**
+ * Create a new project.
+ */
+export interface CreateProject {
+    /**
+     * Project display name.
+     */
+    'name': string;
+}
+

package/models/create-subscriber.ts

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

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

package/models/create-webhook.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.
+ */
+
+
+
+/**
+ * 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/models/create-workflow.ts

@@ -0,0 +1,60 @@
+/* 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';
+// May contain unused imports in some cases
+// @ts-ignore
+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;
+}
+