@enbbox/api 1.0.0 → 1.0.1

package/models/paginated-integration-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OffsetMeta } from './offset-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PaginatedIntegrationRecordDataInner } from './paginated-integration-record-data-inner';
+
+/**
+ * A paginated response containing a `data` array and `meta` pagination info.
+ */
+export interface PaginatedIntegrationRecord {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<PaginatedIntegrationRecordDataInner>;
+    /**
+     * Pagination metadata.
+     */
+    'meta': OffsetMeta;
+}
+

package/models/paginated-layout-record-data-inner.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.
+ */
+
+
+
+/**
+ * A layout template wrapping notification content.
+ */
+export interface PaginatedLayoutRecordDataInner {
+    'content': string;
+    'description'?: string | null;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    /**
+     * Unique slug identifier.
+     */
+    'identifier': string;
+    'is_default': boolean;
+    /**
+     * Display name.
+     */
+    'name': string;
+}
+

package/models/paginated-layout-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OffsetMeta } from './offset-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PaginatedLayoutRecordDataInner } from './paginated-layout-record-data-inner';
+
+/**
+ * A paginated response containing a `data` array and `meta` pagination info.
+ */
+export interface PaginatedLayoutRecord {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<PaginatedLayoutRecordDataInner>;
+    /**
+     * Pagination metadata.
+     */
+    'meta': OffsetMeta;
+}
+

package/models/paginated-subscriber-record-data-inner.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 PaginatedSubscriberRecordDataInner {
+    /**
+     * 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/paginated-subscriber-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OffsetMeta } from './offset-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PaginatedSubscriberRecordDataInner } from './paginated-subscriber-record-data-inner';
+
+/**
+ * A paginated response containing a `data` array and `meta` pagination info.
+ */
+export interface PaginatedSubscriberRecord {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<PaginatedSubscriberRecordDataInner>;
+    /**
+     * Pagination metadata.
+     */
+    'meta': OffsetMeta;
+}
+

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

package/models/paginated-topic-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OffsetMeta } from './offset-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PaginatedTopicRecordDataInner } from './paginated-topic-record-data-inner';
+
+/**
+ * A paginated response containing a `data` array and `meta` pagination info.
+ */
+export interface PaginatedTopicRecord {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<PaginatedTopicRecordDataInner>;
+    /**
+     * Pagination metadata.
+     */
+    'meta': OffsetMeta;
+}
+

package/models/paginated-topic-subscription-record-data-inner.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 PaginatedTopicSubscriptionRecordDataInner {
+    /**
+     * 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/paginated-topic-subscription-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OffsetMeta } from './offset-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PaginatedTopicSubscriptionRecordDataInner } from './paginated-topic-subscription-record-data-inner';
+
+/**
+ * A paginated response containing a `data` array and `meta` pagination info.
+ */
+export interface PaginatedTopicSubscriptionRecord {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<PaginatedTopicSubscriptionRecordDataInner>;
+    /**
+     * Pagination metadata.
+     */
+    'meta': OffsetMeta;
+}
+

package/models/paginated-workflow-record-data-inner.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.
+ */
+
+
+
+/**
+ * A notification workflow with its steps, status, and configuration.
+ */
+export interface PaginatedWorkflowRecordDataInner {
+    /**
+     * 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/models/paginated-workflow-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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OffsetMeta } from './offset-meta';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PaginatedWorkflowRecordDataInner } from './paginated-workflow-record-data-inner';
+
+/**
+ * A paginated response containing a `data` array and `meta` pagination info.
+ */
+export interface PaginatedWorkflowRecord {
+    /**
+     * Array of items for this page.
+     */
+    'data': Array<PaginatedWorkflowRecordDataInner>;
+    /**
+     * Pagination metadata.
+     */
+    'meta': OffsetMeta;
+}
+

package/models/pagination-query.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.
+ */
+
+
+
+/**
+ * Page-based pagination parameters.
+ */
+export interface PaginationQuery {
+    /**
+     * Maximum number of items per page (1–100, default: 10).
+     */
+    'limit'?: number | null;
+    /**
+     * Zero-based page index (default: 0).
+     */
+    'page'?: number | null;
+    /**
+     * Optional full-text search query (e.g. detail text, provider_id, workflow_identifier).
+     */
+    'q'?: string | null;
+}
+

package/models/patch-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.
+ */
+
+
+
+/**
+ * Partially update subscriber provider credentials.
+ */
+export interface PatchCredentials {
+    'credentials': object;
+    'device_tokens'?: Array<string> | null;
+    /**
+     * Provider identifier.
+     */
+    'provider_id': string;
+    'webhook_url'?: string | null;
+}
+

package/models/plan-limits-response.ts

@@ -0,0 +1,55 @@
+/* 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';
+
+/**
+ * Plan limits + current usage for the project.
+ */
+export interface PlanLimitsResponse {
+    /**
+     * Events consumed this period.
+     */
+    'current_events': number;
+    /**
+     * Current team member count.
+     */
+    'current_members': number;
+    /**
+     * Current workflow count.
+     */
+    'current_workflows': number;
+    /**
+     * Max events/month (null = unlimited).
+     */
+    'max_events'?: number | null;
+    /**
+     * Max team members (null = unlimited).
+     */
+    'max_team_members'?: number | null;
+    /**
+     * Max workflows (null = unlimited).
+     */
+    'max_workflows'?: number | null;
+    /**
+     * Current plan tier.
+     */
+    'plan': Plan;
+}
+
+
+

package/models/plan.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.
+ */
+
+
+
+/**
+ * Billing plan that determines API rate limits and feature access.
+ */
+
+export const Plan = {
+    Free: 'free',
+    Pro: 'pro',
+    Business: 'business',
+    Enterprise: 'enterprise',
+    Unlimited: 'unlimited'
+} as const;
+
+export type Plan = typeof Plan[keyof typeof Plan];
+
+
+

package/models/portal-url.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.
+ */
+
+
+
+/**
+ * Billing portal URL.
+ */
+export interface PortalUrl {
+    /**
+     * URL to redirect the user to the Stripe Customer Portal.
+     */
+    'url': string;
+}
+

package/models/preference-channels.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.
+ */
+
+
+
+/**
+ * Per-channel preference toggles.
+ */
+export interface PreferenceChannels {
+    'chat'?: boolean | null;
+    'email'?: boolean | null;
+    'in_app'?: boolean | null;
+    'push'?: boolean | null;
+    'sms'?: boolean | null;
+}
+

package/models/preference-record.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PreferenceChannels } from './preference-channels';
+
+/**
+ * A subscriber preference for a specific workflow or channel.
+ */
+export interface PreferenceRecord {
+    'channels': PreferenceChannels;
+    'enabled': boolean;
+    /**
+     * Subscriber identifier.
+     */
+    'subscriber_id': string;
+    'workflow_id'?: string | null;
+}
+