@enbbox/api 1.0.0 → 1.1.0

package/models/inbox-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 listing inbox notifications.
+ */
+export interface InboxQuery {
+    'after'?: string | null;
+    'archived'?: boolean | null;
+    'limit'?: number | null;
+    'read'?: boolean | null;
+}
+

package/models/index.ts

@@ -0,0 +1,158 @@
+export * from './action-body';
+export * from './action-record';
+export * from './action-type';
+export * from './activity-chart-point';
+export * from './activity-record';
+export * from './activity-request-record';
+export * from './activity-stats';
+export * from './actor-type';
+export * from './api-key-created';
+export * from './api-key-info';
+export * from './auto-configure-result';
+export * from './billing-interval';
+export * from './branding';
+export * from './broadcast-trigger';
+export * from './bulk-create-subscribers';
+export * from './bulk-preference-item';
+export * from './bulk-preferences';
+export * from './bulk-result';
+export * from './bulk-trigger';
+export * from './channel-connection-record';
+export * from './channel-endpoint-record';
+export * from './channel-preferences';
+export * from './channel-type';
+export * from './chart-query';
+export * from './chat-oauth';
+export * from './chat-oauth-request';
+export * from './checkout-session';
+export * from './context-record';
+export * from './create-channel-connection';
+export * from './create-channel-endpoint';
+export * from './create-checkout';
+export * from './create-context';
+export * from './create-integration';
+export * from './create-layout';
+export * from './create-notification-group';
+export * from './create-project';
+export * from './create-subscriber';
+export * from './create-subscription';
+export * from './create-topic';
+export * from './create-webhook';
+export * from './create-workflow';
+export * from './cta-type';
+export * from './cursor-meta';
+export * from './cursor-paginated-feed-item';
+export * from './cursor-paginated-feed-item-data-inner';
+export * from './cursor-paginated-message-record';
+export * from './cursor-paginated-message-record-data-inner';
+export * from './cursor-pagination';
+export * from './delete-subscription';
+export * from './delivery-ack';
+export * from './delivery-status-webhook';
+export * from './dns-settings';
+export * from './engagement-stats-response';
+export * from './entitlement-item';
+export * from './entitlements';
+export * from './error-detail';
+export * from './events-usage';
+export * from './feed-item';
+export * from './feed-query';
+export * from './inbox-notification';
+export * from './inbox-preference';
+export * from './inbox-query';
+export * from './init-session-request';
+export * from './init-session-response';
+export * from './integration-record';
+export * from './invite-member';
+export * from './invite-member-body';
+export * from './job-log';
+export * from './layout-preview';
+export * from './layout-preview-result';
+export * from './layout-record';
+export * from './layout-usage-item';
+export * from './mark-all';
+export * from './mark-messages';
+export * from './mark-result';
+export * from './member-record';
+export * from './member-role';
+export * from './member-status';
+export * from './message-query';
+export * from './message-record';
+export * from './notification-count';
+export * from './notification-group-record';
+export * from './notification-log';
+export * from './notification-query';
+export * from './offset-meta';
+export * from './offset-pagination';
+export * from './online-status';
+export * from './paginated-channel-connection-record';
+export * from './paginated-channel-connection-record-data-inner';
+export * from './paginated-channel-endpoint-record';
+export * from './paginated-channel-endpoint-record-data-inner';
+export * from './paginated-context-record';
+export * from './paginated-context-record-data-inner';
+export * from './paginated-integration-record';
+export * from './paginated-integration-record-data-inner';
+export * from './paginated-layout-record';
+export * from './paginated-layout-record-data-inner';
+export * from './paginated-subscriber-record';
+export * from './paginated-subscriber-record-data-inner';
+export * from './paginated-topic-record';
+export * from './paginated-topic-record-data-inner';
+export * from './paginated-topic-subscription-record';
+export * from './paginated-topic-subscription-record-data-inner';
+export * from './paginated-workflow-record';
+export * from './paginated-workflow-record-data-inner';
+export * from './pagination-query';
+export * from './patch-credentials';
+export * from './plan';
+export * from './plan-limits-response';
+export * from './portal-url';
+export * from './preference-channels';
+export * from './preference-record';
+export * from './preview-result';
+export * from './price-info';
+export * from './prices';
+export * from './project-record';
+export * from './set-credentials';
+export * from './step-preview';
+export * from './step-record';
+export * from './step-type';
+export * from './subscriber-credential';
+export * from './subscriber-payload';
+export * from './subscriber-record';
+export * from './subscription';
+export * from './sync-workflow';
+export * from './system-avatar-icon';
+export * from './topic-record';
+export * from './topic-subscribers';
+export * from './topic-subscription';
+export * from './topic-subscription-record';
+export * from './trial-info';
+export * from './trigger-event';
+export * from './trigger-recipients';
+export * from './trigger-recipients-one-of';
+export * from './trigger-result';
+export * from './trigger-status';
+export * from './unseen-count';
+export * from './update-channel-connection';
+export * from './update-channel-endpoint';
+export * from './update-context';
+export * from './update-inbox-preferences';
+export * from './update-integration';
+export * from './update-layout';
+export * from './update-notification-group';
+export * from './update-preference';
+export * from './update-project';
+export * from './update-subscriber';
+export * from './update-subscription-meta';
+export * from './update-topic';
+export * from './update-workflow';
+export * from './usage';
+export * from './webhook-record';
+export * from './widget-settings';
+export * from './workflow-record';
+export * from './workflow-run-record';
+export * from './workflow-stats-response';
+export * from './workflow-status';
+export * from './workflow-step-create';

package/models/init-session-request.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.
+ */
+
+
+
+/**
+ * Initialize a subscriber inbox session.
+ */
+export interface InitSessionRequest {
+    /**
+     * Optional HMAC-SHA256 hash of the subscriber_id for production security.
+     */
+    'subscriber_hash'?: string | null;
+    /**
+     * Subscriber identifier (e.g. user ID from your system).
+     */
+    'subscriber_id': string;
+}
+

package/models/init-session-response.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.
+ */
+
+
+
+/**
+ * Subscriber session token and initial counts.
+ */
+export interface InitSessionResponse {
+    /**
+     * Whether the project\'s plan allows removing Enbbox branding. `true` for Pro+ plans, `false` for Free.
+     */
+    'remove_branding': boolean;
+    /**
+     * Short-lived JWT for authenticating subsequent inbox requests.
+     */
+    'token': string;
+    /**
+     * Current total unread notification count.
+     */
+    'total_unread_count': number;
+}
+

package/models/integration-record.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 { ChannelType } from './channel-type';
+
+/**
+ * A configured provider integration with its routing priority and status.
+ */
+export interface IntegrationRecord {
+    /**
+     * Whether the integration is active and available for routing.
+     */
+    'active': boolean;
+    /**
+     * Channel this integration serves.
+     */
+    'channel': ChannelType;
+    /**
+     * Integration UUID.
+     */
+    'id': string;
+    /**
+     * Unique slug identifier for API references.
+     */
+    'identifier': string;
+    /**
+     * Display name.
+     */
+    'name': string;
+    /**
+     * Whether this is the primary integration for its channel.
+     */
+    'primary': boolean;
+    /**
+     * Routing priority (lower = higher priority).
+     */
+    'priority': number;
+    /**
+     * Provider identifier.
+     */
+    'provider_id': string;
+}
+
+
+

package/models/invite-member-body.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.
+ */
+
+
+
+/**
+ * Invite a user to join the project by email.
+ */
+export interface InviteMemberBody {
+    /**
+     * Email address of the user to invite.
+     */
+    'email': string;
+    /**
+     * Role to assign: `admin`, `member`, or `viewer`.
+     */
+    'role'?: string | null;
+}
+

package/models/invite-member.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.
+ */
+
+
+
+/**
+ * Invite a user to join the project by email.
+ */
+export interface InviteMember {
+    /**
+     * Email address of the user to invite.
+     */
+    'email': string;
+    /**
+     * Role to assign: `admin` or `member`.
+     */
+    'role'?: string | null;
+}
+

package/models/job-log.ts

@@ -0,0 +1,47 @@
+/* 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 job processing log entry with timing and status.
+ */
+export interface JobLog {
+    /**
+     * ISO 8601 creation timestamp.
+     */
+    'created_at': string;
+    /**
+     * Error type.
+     */
+    'error'?: string | null;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    /**
+     * Provider identifier.
+     */
+    'provider_id'?: string | null;
+    /**
+     * Current status.
+     */
+    'status': string;
+    'step_type': string;
+    /**
+     * ISO 8601 last-modified timestamp.
+     */
+    'updated_at': string;
+}
+

package/models/layout-preview-result.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.
+ */
+
+
+
+/**
+ * Result of a layout preview rendering.
+ */
+export interface LayoutPreviewResult {
+    'rendered': string;
+}
+

package/models/layout-preview.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.
+ */
+
+
+
+/**
+ * Request body for previewing a rendered layout.
+ */
+export interface LayoutPreview {
+    'content': string;
+}
+

package/models/layout-record.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 LayoutRecord {
+    'content': string;
+    'description'?: string | null;
+    /**
+     * Unique identifier.
+     */
+    'id': string;
+    /**
+     * Unique slug identifier.
+     */
+    'identifier': string;
+    'is_default': boolean;
+    /**
+     * Display name.
+     */
+    'name': string;
+}
+

package/models/layout-usage-item.ts

@@ -0,0 +1,24 @@
+/* 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 workflow that references this layout.
+ */
+export interface LayoutUsageItem {
+    'workflow_id': string;
+    'workflow_name': string;
+}
+

package/models/mark-all.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.
+ */
+
+
+
+/**
+ * Mark all inbox messages as read.
+ */
+export interface MarkAll {
+    'mark': string;
+}
+

package/models/mark-messages.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+
+
+/**
+ * Mark specific message(s) as read or seen.
+ */
+export interface MarkMessages {
+    'mark': string;
+    'message_ids': Array<string>;
+}
+

package/models/mark-result.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.
+ */
+
+
+
+/**
+ * Result of a mark-as-read/seen operation.
+ */
+export interface MarkResult {
+    'updated': number;
+}
+

package/models/member-record.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.
+ */
+
+
+
+/**
+ * A member of the project with their assigned roles and invitation status.
+ */
+export interface MemberRecord {
+    /**
+     * Member UUID.
+     */
+    'id': string;
+    /**
+     * Assigned roles.
+     */
+    'roles': Array<string>;
+    /**
+     * Membership status: `invited`, `active`, or `disabled`.
+     */
+    'status': string;
+    /**
+     * Associated user ID (null if invitation is still pending).
+     */
+    'user_id'?: string | null;
+}
+

package/models/member-role.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+
+/**
+ * Role assigned to a project member. Determines permission level.
+ */
+
+export const MemberRole = {
+    Owner: 'owner',
+    Admin: 'admin',
+    Member: 'member',
+    Viewer: 'viewer'
+} as const;
+
+export type MemberRole = typeof MemberRole[keyof typeof MemberRole];
+
+
+