@enbbox/api 1.0.0 → 1.0.1

package/docs/CreateWorkflow.md

@@ -0,0 +1,35 @@
+# CreateWorkflow
+
+Create a multi-step notification workflow. Each step sends through a specific channel (email, SMS, push, etc.).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Whether the workflow is active. Inactive workflows ignore triggers. | [optional] [default to undefined]
+**critical** | **boolean** | Whether notifications from this workflow are critical (bypass subscriber preferences). | [optional] [default to undefined]
+**description** | **string** | Optional description of what this workflow does. | [optional] [default to undefined]
+**name** | **string** | Human-readable workflow name. | [default to undefined]
+**notification_group_id** | **string** | Notification group this workflow belongs to. | [default to undefined]
+**preference_settings** | [**PreferenceChannels**](PreferenceChannels.md) | Per-channel preference overrides for this workflow. | [optional] [default to undefined]
+**steps** | [**Array<WorkflowStepCreate>**](WorkflowStepCreate.md) | Ordered list of workflow steps. | [default to undefined]
+**tags** | **Array<string>** | Tags for organizing and filtering workflows. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateWorkflow } from '@enbbox/api';
+
+const instance: CreateWorkflow = {
+    active,
+    critical,
+    description,
+    name,
+    notification_group_id,
+    preference_settings,
+    steps,
+    tags,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CtaType.md

@@ -0,0 +1,9 @@
+# CtaType
+
+CTA (Call to Action) type for in-app notification buttons.
+
+## Enum
+
+* `Redirect` (value: `'redirect'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CursorMeta.md

@@ -0,0 +1,27 @@
+# CursorMeta
+
+Metadata about the current page in a cursor-paginated response.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **boolean** | Whether more items exist beyond this page. | [default to undefined]
+**limit** | **number** | Current page size. | [default to undefined]
+**next_cursor** | **string** | Cursor to pass as `after` to fetch the next page. | [optional] [default to undefined]
+**prev_cursor** | **string** | Cursor to pass as `before` to fetch the previous page. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CursorMeta } from '@enbbox/api';
+
+const instance: CursorMeta = {
+    has_more,
+    limit,
+    next_cursor,
+    prev_cursor,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CursorPaginatedFeedItem.md

@@ -0,0 +1,23 @@
+# CursorPaginatedFeedItem
+
+A cursor-paginated response containing a `data` array and `meta` with cursors for navigation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<CursorPaginatedFeedItemDataInner>**](CursorPaginatedFeedItemDataInner.md) | Array of items for this page. | [default to undefined]
+**meta** | [**CursorMeta**](CursorMeta.md) | Cursor pagination metadata. | [default to undefined]
+
+## Example
+
+```typescript
+import { CursorPaginatedFeedItem } from '@enbbox/api';
+
+const instance: CursorPaginatedFeedItem = {
+    data,
+    meta,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CursorPaginatedFeedItemDataInner.md

@@ -0,0 +1,37 @@
+# CursorPaginatedFeedItemDataInner
+
+A notification feed item for subscriber-facing display.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channel** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**data** | **any** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**is_read** | **boolean** |  | [default to undefined]
+**is_seen** | **boolean** |  | [default to undefined]
+**subject** | **string** |  | [optional] [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+
+## Example
+
+```typescript
+import { CursorPaginatedFeedItemDataInner } from '@enbbox/api';
+
+const instance: CursorPaginatedFeedItemDataInner = {
+    channel,
+    content,
+    created_at,
+    data,
+    id,
+    is_read,
+    is_seen,
+    subject,
+    subscriber_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CursorPaginatedMessageRecord.md

@@ -0,0 +1,23 @@
+# CursorPaginatedMessageRecord
+
+A cursor-paginated response containing a `data` array and `meta` with cursors for navigation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<CursorPaginatedMessageRecordDataInner>**](CursorPaginatedMessageRecordDataInner.md) | Array of items for this page. | [default to undefined]
+**meta** | [**CursorMeta**](CursorMeta.md) | Cursor pagination metadata. | [default to undefined]
+
+## Example
+
+```typescript
+import { CursorPaginatedMessageRecord } from '@enbbox/api';
+
+const instance: CursorPaginatedMessageRecord = {
+    data,
+    meta,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CursorPaginatedMessageRecordDataInner.md

@@ -0,0 +1,41 @@
+# CursorPaginatedMessageRecordDataInner
+
+A sent message with content, channel, and delivery metadata.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channel** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**data** | **any** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**is_archived** | **boolean** |  | [default to undefined]
+**is_read** | **boolean** |  | [default to undefined]
+**is_seen** | **boolean** |  | [default to undefined]
+**provider_id** | **string** | Provider identifier. | [optional] [default to undefined]
+**subject** | **string** |  | [optional] [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+
+## Example
+
+```typescript
+import { CursorPaginatedMessageRecordDataInner } from '@enbbox/api';
+
+const instance: CursorPaginatedMessageRecordDataInner = {
+    channel,
+    content,
+    created_at,
+    data,
+    id,
+    is_archived,
+    is_read,
+    is_seen,
+    provider_id,
+    subject,
+    subscriber_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CursorPagination.md

@@ -0,0 +1,25 @@
+# CursorPagination
+
+Cursor-based pagination for time-ordered streams. Use `after`/`before` cursors returned in previous responses.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**after** | **string** | Cursor for next page (ISO 8601 timestamp or opaque ID from previous response). | [optional] [default to undefined]
+**before** | **string** | Cursor for previous page. | [optional] [default to undefined]
+**limit** | **number** | Maximum number of items to return (1–100, default: 25). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CursorPagination } from '@enbbox/api';
+
+const instance: CursorPagination = {
+    after,
+    before,
+    limit,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeleteSubscription.md

@@ -0,0 +1,20 @@
+# DeleteSubscription
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscribers** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteSubscription } from '@enbbox/api';
+
+const instance: DeleteSubscription = {
+    subscribers,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeliveryAck.md

@@ -0,0 +1,21 @@
+# DeliveryAck
+
+Acknowledge message delivery from a provider.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acknowledged** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeliveryAck } from '@enbbox/api';
+
+const instance: DeliveryAck = {
+    acknowledged,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeliveryStatusWebhook.md

@@ -0,0 +1,27 @@
+# DeliveryStatusWebhook
+
+Inbound webhook payload for delivery status updates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **object** |  | [optional] [default to undefined]
+**message_id** | **string** |  | [default to undefined]
+**provider** | **string** |  | [default to undefined]
+**status** | **string** | Current status. | [default to undefined]
+
+## Example
+
+```typescript
+import { DeliveryStatusWebhook } from '@enbbox/api';
+
+const instance: DeliveryStatusWebhook = {
+    detail,
+    message_id,
+    provider,
+    status,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DnsSettings.md

@@ -0,0 +1,23 @@
+# DnsSettings
+
+DNS configuration for receiving inbound emails via MX records.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inbound_parse_domain** | **string** | Domain used for inbound email parsing. | [optional] [default to undefined]
+**mx_record_configured** | **boolean** | Whether the MX record has been verified. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DnsSettings } from '@enbbox/api';
+
+const instance: DnsSettings = {
+    inbound_parse_domain,
+    mx_record_configured,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EngagementStatsResponse.md

@@ -0,0 +1,27 @@
+# EngagementStatsResponse
+
+Aggregate statistics for subscriber engagement events.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_bounced** | **number** | Total bounced events. | [default to undefined]
+**total_clicked** | **number** | Total clicked events. | [default to undefined]
+**total_complained** | **number** | Total complained / spam-reported events. | [default to undefined]
+**total_opened** | **number** | Total opened events. | [default to undefined]
+
+## Example
+
+```typescript
+import { EngagementStatsResponse } from '@enbbox/api';
+
+const instance: EngagementStatsResponse = {
+    total_bounced,
+    total_clicked,
+    total_complained,
+    total_opened,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EntitlementItem.md

@@ -0,0 +1,25 @@
+# EntitlementItem
+
+Single entitlement entry.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**feature_key** | **string** | Feature key (e.g., \"digest_step\", \"remove_branding\"). | [default to undefined]
+**is_active** | **boolean** | Whether the feature is active. | [default to undefined]
+**value** | **number** | Numeric limit value, if applicable. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EntitlementItem } from '@enbbox/api';
+
+const instance: EntitlementItem = {
+    feature_key,
+    is_active,
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Entitlements.md

@@ -0,0 +1,21 @@
+# Entitlements
+
+List of active entitlements for the project.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entitlements** | [**Array<EntitlementItem>**](EntitlementItem.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Entitlements } from '@enbbox/api';
+
+const instance: Entitlements = {
+    entitlements,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ErrorDetail.md

@@ -0,0 +1,27 @@
+# ErrorDetail
+
+RFC 7807 Problem Details — a machine-readable error response with a URI type, human-readable title, and optional detail.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **string** | A detailed, human-readable explanation specific to this error occurrence. | [optional] [default to undefined]
+**instance** | **string** | A unique URI identifying this specific occurrence (e.g. trace ID), useful for support. | [optional] [default to undefined]
+**title** | **string** | A short, human-readable summary of the error type. | [default to undefined]
+**type** | **string** | A URI identifier for the error type, linking to documentation. | [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorDetail } from '@enbbox/api';
+
+const instance: ErrorDetail = {
+    detail,
+    instance,
+    title,
+    type,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EventsApi.md

@@ -0,0 +1,214 @@
+# EventsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cancelEvent**](#cancelevent) | **DELETE** /v1/events/{transaction_id}/ | DELETE /v1/events/:transaction_id|
+|[**triggerBroadcast**](#triggerbroadcast) | **POST** /v1/events/trigger/broadcast/ | POST /v1/events/trigger/broadcast — broadcast to all subscribers|
+|[**triggerBulk**](#triggerbulk) | **POST** /v1/events/trigger/bulk/ | POST /v1/events/trigger/bulk|
+|[**triggerEvent**](#triggerevent) | **POST** /v1/events/trigger/ | POST /v1/events/trigger|
+
+# **cancelEvent**
+> cancelEvent()
+
+
+### Example
+
+```typescript
+import {
+    EventsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new EventsApi(configuration);
+
+let transactionId: string; //Transaction ID (default to undefined)
+
+const { status, data } = await apiInstance.cancelEvent(
+    transactionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **transactionId** | [**string**] | Transaction ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Cancelled |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **triggerBroadcast**
+> TriggerResult triggerBroadcast(broadcastTrigger)
+
+
+### Example
+
+```typescript
+import {
+    EventsApi,
+    Configuration,
+    BroadcastTrigger
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new EventsApi(configuration);
+
+let broadcastTrigger: BroadcastTrigger; //
+
+const { status, data } = await apiInstance.triggerBroadcast(
+    broadcastTrigger
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **broadcastTrigger** | **BroadcastTrigger**|  | |
+
+
+### Return type
+
+**TriggerResult**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **triggerBulk**
+> Array<TriggerResult> triggerBulk(bulkTrigger)
+
+
+### Example
+
+```typescript
+import {
+    EventsApi,
+    Configuration,
+    BulkTrigger
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new EventsApi(configuration);
+
+let bulkTrigger: BulkTrigger; //
+
+const { status, data } = await apiInstance.triggerBulk(
+    bulkTrigger
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bulkTrigger** | **BulkTrigger**|  | |
+
+
+### Return type
+
+**Array<TriggerResult>**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **triggerEvent**
+> TriggerResult triggerEvent(triggerEvent)
+
+
+### Example
+
+```typescript
+import {
+    EventsApi,
+    Configuration,
+    TriggerEvent
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new EventsApi(configuration);
+
+let triggerEvent: TriggerEvent; //
+
+const { status, data } = await apiInstance.triggerEvent(
+    triggerEvent
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **triggerEvent** | **TriggerEvent**|  | |
+
+
+### Return type
+
+**TriggerResult**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/EventsUsage.md

@@ -0,0 +1,23 @@
+# EventsUsage
+
+Events usage within a billing period (embedded in Subscription).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current** | **number** | Events consumed so far. | [default to undefined]
+**included** | **number** | Events included in the plan. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventsUsage } from '@enbbox/api';
+
+const instance: EventsUsage = {
+    current,
+    included,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)