@enbbox/api 1.0.0 → 1.0.1

package/models/trigger-event.ts

@@ -0,0 +1,49 @@
+/* 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 { 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/models/trigger-recipients-one-of.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.
+ */
+
+
+
+/**
+ * Topic fan-out: `{\"topic_key\": \"my-topic\"}`
+ */
+export interface TriggerRecipientsOneOf {
+    'topic_key': string;
+}
+

package/models/trigger-recipients.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 { SubscriberPayload } from './subscriber-payload';
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/trigger-result.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/trigger-status.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.
+ */
+
+
+
+/**
+ * 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'
+} as const;
+
+export type TriggerStatus = typeof TriggerStatus[keyof typeof TriggerStatus];
+
+
+

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

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

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

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

package/models/update-inbox-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.
+ */
+
+
+
+/**
+ * Update subscriber inbox preferences.
+ */
+export interface UpdateInboxPreferences {
+    'chat'?: boolean | null;
+    'email'?: boolean | null;
+    'in_app'?: boolean | null;
+    'push'?: boolean | null;
+    'sms'?: boolean | null;
+}
+

package/models/update-integration.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.
+ */
+
+
+
+/**
+ * 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/models/update-layout.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.
+ */
+
+
+
+/**
+ * Update a layout template.
+ */
+export interface UpdateLayout {
+    'content'?: string | null;
+    'description'?: string | null;
+    /**
+     * Display name.
+     */
+    'name'?: string | null;
+    'variables': object;
+}
+

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

package/models/update-preference.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PreferenceChannels } from './preference-channels';
+
+/**
+ * Update subscriber notification preferences.
+ */
+export interface UpdatePreference {
+    'channels'?: PreferenceChannels | null;
+    'enabled'?: boolean | null;
+}
+

package/models/update-project.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/update-subscriber.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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/models/update-subscription-meta.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.
+ */
+
+
+
+/**
+ * Update topic subscription metadata.
+ */
+export interface UpdateSubscriptionMeta {
+    'metadata'?: object | null;
+}
+

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

package/models/update-workflow.ts

@@ -0,0 +1,52 @@
+/* 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';
+
+/**
+ * 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/models/usage.ts

@@ -0,0 +1,59 @@
+/* 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';
+
+/**
+ * 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;
+}
+
+
+