@enbbox/api 1.0.0

package/dist/esm/models/topic-subscription-record.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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/dist/esm/models/topic-subscription-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/topic-subscription.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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/dist/esm/models/topic-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/trial-info.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.
+ */
+/**
+ * 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;
+}

package/dist/esm/models/trial-info.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/trigger-event.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 { TriggerRecipients } from './trigger-recipients';
+/**
+ * Trigger a notification workflow. Sends notifications through the configured channels (email, SMS, push, etc.) to the specified recipients.
+ */
+export interface TriggerEvent {
+    /**
+     * Context data for template personalization. Keys are context types (e.g. `tenant`, `region`). Values can be a string ID (resolved from store) or an object with `id` and optional `data`. Available in templates as `{{ context.type.data.field }}`.
+     */
+    'context': object;
+    /**
+     * Workflow identifier — must match the `identifier` field of an existing workflow.
+     */
+    'name': string;
+    /**
+     * Per-provider overrides (e.g. custom sender, priority). Keys are provider IDs.
+     */
+    'overrides': object;
+    /**
+     * Template variables available inside {{handlebar}} expressions.
+     */
+    'payload': object;
+    /**
+     * Recipient specification — a single subscriber ID, multiple IDs, inline subscriber data, or a topic key.
+     */
+    'to': TriggerRecipients;
+    /**
+     * Client-generated idempotency key. Duplicate `transaction_id` values within 24 h are silently ignored.
+     */
+    'transaction_id'?: string | null;
+}

package/dist/esm/models/trigger-event.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/trigger-recipients-one-of.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.
+ */
+/**
+ * Topic fan-out: `{\"topic_key\": \"my-topic\"}`
+ */
+export interface TriggerRecipientsOneOf {
+    'topic_key': string;
+}

package/dist/esm/models/trigger-recipients-one-of.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/trigger-recipients.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.
+ */
+import type { SubscriberPayload } from './subscriber-payload';
+import type { TriggerRecipientsOneOf } from './trigger-recipients-one-of';
+/**
+ * @type TriggerRecipients
+ * Flexible recipient targeting: a subscriber ID string, an array of IDs, an inline subscriber object, or a topic fan-out key.
+ */
+export type TriggerRecipients = Array<SubscriberPayload> | SubscriberPayload | TriggerRecipientsOneOf;

package/dist/esm/models/trigger-recipients.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/trigger-result.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { TriggerStatus } from './trigger-status';
+/**
+ * Acknowledgement returned after a trigger event is accepted by the system.
+ */
+export interface TriggerResult {
+    /**
+     * Whether the event was accepted for processing.
+     */
+    'acknowledged': boolean;
+    /**
+     * Processing status of the trigger.
+     */
+    'status': TriggerStatus;
+    /**
+     * Unique transaction identifier for tracking this trigger.
+     */
+    'transaction_id': string;
+}

package/dist/esm/models/trigger-result.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/trigger-status.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.
+ */
+/**
+ * Status of a trigger event processing.
+ */
+export declare const TriggerStatus: {
+    readonly Processed: "processed";
+    readonly Error: "error";
+    readonly TriggerNotActive: "trigger_not_active";
+    readonly NoWorkflowActiveSteps: "no_workflow_active_steps";
+    readonly NoWorkflowSteps: "no_workflow_steps";
+    readonly TenantMissing: "tenant_missing";
+    readonly InvalidRecipients: "invalid_recipients";
+};
+export type TriggerStatus = typeof TriggerStatus[keyof typeof TriggerStatus];

package/dist/esm/models/trigger-status.js

@@ -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.
+ */
+/**
+ * Status of a trigger event processing.
+ */
+export const TriggerStatus = {
+    Processed: 'processed',
+    Error: 'error',
+    TriggerNotActive: 'trigger_not_active',
+    NoWorkflowActiveSteps: 'no_workflow_active_steps',
+    NoWorkflowSteps: 'no_workflow_steps',
+    TenantMissing: 'tenant_missing',
+    InvalidRecipients: 'invalid_recipients'
+};

package/dist/esm/models/unseen-count.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.
+ */
+/**
+ * Count of unseen inbox notifications.
+ */
+export interface UnseenCount {
+    'count': number;
+}

package/dist/esm/models/unseen-count.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-channel-connection.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.
+ */
+/**
+ * Partial update of a channel connection.
+ */
+export interface UpdateChannelConnection {
+    'credentials': object;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * 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 a channel endpoint.
+ */
+export interface UpdateChannelEndpoint {
+    'metadata'?: object | null;
+    /**
+     * Delivery target (token, URL, address).
+     */
+    'target'?: string | null;
+}

package/dist/esm/models/update-channel-endpoint.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-context.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.
+ */
+/**
+ * Partial update of a context\'s data.
+ */
+export interface UpdateContext {
+    /**
+     * Updated context data (replaces existing data).
+     */
+    'data': object;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * 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 subscriber inbox preferences.
+ */
+export interface UpdateInboxPreferences {
+    'chat'?: boolean | null;
+    'email'?: boolean | null;
+    'in_app'?: boolean | null;
+    'push'?: boolean | null;
+    'sms'?: boolean | null;
+}

package/dist/esm/models/update-inbox-preferences.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-integration.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.
+ */
+/**
+ * Partial update of an existing provider integration. Only provided fields are changed.
+ */
+export interface UpdateIntegration {
+    /**
+     * Updated active status.
+     */
+    'active'?: boolean | null;
+    /**
+     * Updated routing conditions.
+     */
+    'conditions': object;
+    /**
+     * Updated credentials.
+     */
+    'credentials': object;
+    /**
+     * Updated display name.
+     */
+    'name'?: string | null;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * 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 layout template.
+ */
+export interface UpdateLayout {
+    'content'?: string | null;
+    'description'?: string | null;
+    /**
+     * Display name.
+     */
+    'name'?: string | null;
+    'variables': object;
+}

package/dist/esm/models/update-layout.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-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.
+ */
+/**
+ * Update a notification group name.
+ */
+export interface UpdateNotificationGroup {
+    /**
+     * Display name.
+     */
+    'name'?: string | null;
+}

package/dist/esm/models/update-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 {};