@enbbox/api 1.0.0

package/dist/esm/models/update-preference.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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';
+/**
+ * Update subscriber notification preferences.
+ */
+export interface UpdatePreference {
+    'channels'?: PreferenceChannels | null;
+    'enabled'?: boolean | null;
+}

package/dist/esm/models/update-preference.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/update-project.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { Branding } from './branding';
+/**
+ * Partial update of a project\'s name or branding settings.
+ */
+export interface UpdateProject {
+    /**
+     * Branding configuration (logo, colors, fonts) for white-label notification UIs.
+     */
+    'branding'?: Branding | null;
+    /**
+     * Updated project display name.
+     */
+    'name'?: string | null;
+}

package/dist/esm/models/update-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/update-subscriber.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+/**
+ * Partial update of an existing subscriber\'s profile. Only provided fields are updated.
+ */
+export interface UpdateSubscriber {
+    /**
+     * Updated avatar URL.
+     */
+    'avatar'?: string | null;
+    /**
+     * Updated metadata (replaces existing data).
+     */
+    'data': object;
+    /**
+     * Updated email address.
+     */
+    'email'?: string | null;
+    /**
+     * Updated first name.
+     */
+    'first_name'?: string | null;
+    /**
+     * Updated last name.
+     */
+    'last_name'?: string | null;
+    /**
+     * Updated locale tag.
+     */
+    'locale'?: string | null;
+    /**
+     * Updated phone number in E.164 format.
+     */
+    'phone'?: string | null;
+    /**
+     * Updated timezone.
+     */
+    'timezone'?: string | null;
+}

package/dist/esm/models/update-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/update-subscription-meta.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.
+ */
+/**
+ * Update topic subscription metadata.
+ */
+export interface UpdateSubscriptionMeta {
+    'metadata'?: object | null;
+}

package/dist/esm/models/update-subscription-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/update-topic.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.
+ */
+/**
+ * Update a topic name or key.
+ */
+export interface UpdateTopic {
+    /**
+     * Display name.
+     */
+    'name'?: string | null;
+}

package/dist/esm/models/update-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/update-workflow.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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';
+/**
+ * Partial update of an existing workflow. Only provided fields are changed.
+ */
+export interface UpdateWorkflow {
+    /**
+     * Updated active status.
+     */
+    'active'?: boolean | null;
+    /**
+     * Updated description.
+     */
+    'description'?: string | null;
+    /**
+     * Updated workflow name.
+     */
+    'name'?: string | null;
+    /**
+     * Updated preference settings.
+     */
+    'preference_settings'?: PreferenceChannels | null;
+    /**
+     * Updated steps (replaces all existing steps).
+     */
+    'steps'?: Array<WorkflowStepCreate> | null;
+    /**
+     * Updated tags.
+     */
+    'tags'?: Array<string> | null;
+}

package/dist/esm/models/update-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/usage.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { Plan } from './plan';
+/**
+ * Detailed usage data for the current billing period.
+ */
+export interface Usage {
+    /**
+     * Events consumed in the current billing period.
+     */
+    'events_current': number;
+    /**
+     * Events included in the plan (null = unlimited).
+     */
+    'events_included'?: number | null;
+    /**
+     * Overage event count beyond the included quota.
+     */
+    'events_overage': number;
+    /**
+     * Total overage cost in dollars for this period.
+     */
+    'overage_cost': number;
+    /**
+     * Cost per 1,000 overage events in dollars.
+     */
+    'overage_rate': number;
+    /**
+     * Billing period end (ISO 8601).
+     */
+    'period_end'?: string | null;
+    /**
+     * Billing period start (ISO 8601).
+     */
+    'period_start'?: string | null;
+    /**
+     * Plan the usage applies to.
+     */
+    'plan': Plan;
+}

package/dist/esm/models/usage.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/webhook-record.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 registered webhook endpoint that receives event callbacks.
+ */
+export interface WebhookRecord {
+    /**
+     * Whether this resource is active.
+     */
+    'active': boolean;
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    /**
+     * Event types this webhook subscribes to.
+     */
+    'events': Array<string>;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    /**
+     * HMAC signing key for verifying webhook payloads.
+     */
+    'signing_key': string;
+    /**
+     * Webhook callback URL.
+     */
+    'url': string;
+}

package/dist/esm/models/webhook-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/widget-settings.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.
+ */
+/**
+ * Configuration for the embeddable notification center widget.
+ */
+export interface WidgetSettings {
+    /**
+     * Whether to encrypt the HMAC subscriber token for the widget.
+     */
+    'notification_center_encryption'?: boolean;
+}

package/dist/esm/models/widget-settings.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/workflow-record.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.
+ */
+/**
+ * A notification workflow with its steps, status, and configuration.
+ */
+export interface WorkflowRecord {
+    /**
+     * Whether the workflow is active.
+     */
+    'active': boolean;
+    /**
+     * Whether this workflow is critical (bypasses preferences).
+     */
+    'critical': boolean;
+    /**
+     * Description.
+     */
+    'description'?: string | null;
+    /**
+     * Workflow UUID.
+     */
+    'id': string;
+    /**
+     * Unique slug identifier used in trigger calls.
+     */
+    'identifier': string;
+    /**
+     * Display name.
+     */
+    'name': string;
+    /**
+     * Associated notification group UUID.
+     */
+    'notification_group_id': string;
+    /**
+     * Serialized step definitions.
+     */
+    'steps': Array<any>;
+    /**
+     * Tags for filtering.
+     */
+    'tags': Array<string>;
+}

package/dist/esm/models/workflow-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/workflow-run-record.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 execution run of a workflow — tracks start/end time and completion status.
+ */
+export interface WorkflowRunRecord {
+    /**
+     * ISO 8601 timestamp when the run completed (null if still running).
+     */
+    'completed_at'?: string | null;
+    /**
+     * Run UUID.
+     */
+    'id': string;
+    /**
+     * Project where the run executed.
+     */
+    'project_id': string;
+    /**
+     * ISO 8601 timestamp when the run started.
+     */
+    'started_at': string;
+    /**
+     * Run status: `running`, `completed`, `failed`.
+     */
+    'status': string;
+    /**
+     * Workflow UUID that was executed.
+     */
+    'workflow_id': string;
+}

package/dist/esm/models/workflow-run-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/workflow-stats-response.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.
+ */
+/**
+ * Aggregate statistics for workflow executions.
+ */
+export interface WorkflowStatsResponse {
+    /**
+     * Average duration in milliseconds.
+     */
+    'avg_duration_ms': number;
+    /**
+     * Completed runs.
+     */
+    'completed': number;
+    /**
+     * Failed runs.
+     */
+    'failed': number;
+    /**
+     * Total workflow runs.
+     */
+    'total_runs': number;
+}

package/dist/esm/models/workflow-stats-response.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/workflow-status.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.
+ */
+/**
+ * Toggle a workflow on or off.
+ */
+export interface WorkflowStatus {
+    /**
+     * New active status.
+     */
+    'active': boolean;
+}

package/dist/esm/models/workflow-status.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/workflow-step-create.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 { StepType } from './step-type';
+/**
+ * Defines one step of a workflow — the channel type, template, and conditions.
+ */
+export interface WorkflowStepCreate {
+    /**
+     * Whether this step is active. Inactive steps are skipped.
+     */
+    'active'?: boolean | null;
+    /**
+     * Step execution filters/conditions.
+     */
+    'filters': object;
+    /**
+     * Arbitrary step metadata.
+     */
+    'metadata': object;
+    /**
+     * Human-readable step name.
+     */
+    'name'?: string | null;
+    /**
+     * Delivery channel/type for this step.
+     */
+    'step_type': StepType;
+    /**
+     * Content template with {{handlebar}} placeholders.
+     */
+    'template': object;
+}