@enbbox/api 1.0.0 → 1.1.0

package/docs/MessageQuery.md

@@ -0,0 +1,31 @@
+# MessageQuery
+
+Query parameters for filtering sent messages.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**after** | **string** | Cursor for next page (ISO 8601 timestamp from previous response). | [optional] [default to undefined]
+**before** | **string** | Cursor for previous page. | [optional] [default to undefined]
+**channel** | **string** | Filter by channel type. | [optional] [default to undefined]
+**limit** | **number** | Maximum number of items to return (1–100, default: 25). | [optional] [default to undefined]
+**q** | **string** | Optional full-text search query (e.g. content, subject, subscriber_id). | [optional] [default to undefined]
+**subscriber_id** | **string** | Filter by subscriber identifier. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MessageQuery } from '@enbbox/api';
+
+const instance: MessageQuery = {
+    after,
+    before,
+    channel,
+    limit,
+    q,
+    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/MessageRecord.md

@@ -0,0 +1,41 @@
+# MessageRecord
+
+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 { MessageRecord } from '@enbbox/api';
+
+const instance: MessageRecord = {
+    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/MessagesApi.md

@@ -0,0 +1,175 @@
+# MessagesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteByTransaction**](#deletebytransaction) | **DELETE** /v1/messages/transaction/{transaction_id}/ | DELETE /v1/messages/transaction/:transaction_id — delete all messages by transaction|
+|[**deleteMessage**](#deletemessage) | **DELETE** /v1/messages/{id}/ | DELETE /v1/messages/:id — soft-delete a single message|
+|[**listMessages**](#listmessages) | **GET** /v1/messages/ | GET /v1/messages — list all messages with cursor pagination|
+
+# **deleteByTransaction**
+> deleteByTransaction()
+
+
+### Example
+
+```typescript
+import {
+    MessagesApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new MessagesApi(configuration);
+
+let transactionId: string; //Transaction ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteByTransaction(
+    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 |
+|-------------|-------------|------------------|
+|**204** | Deleted |  -  |
+
+[[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)
+
+# **deleteMessage**
+> deleteMessage()
+
+
+### Example
+
+```typescript
+import {
+    MessagesApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new MessagesApi(configuration);
+
+let id: string; //Message ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteMessage(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Message 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 |
+|-------------|-------------|------------------|
+|**204** | Deleted |  -  |
+
+[[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)
+
+# **listMessages**
+> CursorPaginatedMessageRecord listMessages()
+
+
+### Example
+
+```typescript
+import {
+    MessagesApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new MessagesApi(configuration);
+
+let limit: number; //Maximum number of items to return (1–100, default: 25). (optional) (default to undefined)
+let after: string; //Cursor for next page (ISO 8601 timestamp from previous response). (optional) (default to undefined)
+let before: string; //Cursor for previous page. (optional) (default to undefined)
+let channel: string; //Filter by channel type. (optional) (default to undefined)
+let subscriberId: string; //Filter by subscriber identifier. (optional) (default to undefined)
+let q: string; //Optional full-text search query (e.g. content, subject, subscriber_id). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listMessages(
+    limit,
+    after,
+    before,
+    channel,
+    subscriberId,
+    q
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of items to return (1–100, default: 25). | (optional) defaults to undefined|
+| **after** | [**string**] | Cursor for next page (ISO 8601 timestamp from previous response). | (optional) defaults to undefined|
+| **before** | [**string**] | Cursor for previous page. | (optional) defaults to undefined|
+| **channel** | [**string**] | Filter by channel type. | (optional) defaults to undefined|
+| **subscriberId** | [**string**] | Filter by subscriber identifier. | (optional) defaults to undefined|
+| **q** | [**string**] | Optional full-text search query (e.g. content, subject, subscriber_id). | (optional) defaults to undefined|
+
+
+### Return type
+
+**CursorPaginatedMessageRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+

package/docs/MetricsApi.md

@@ -0,0 +1,51 @@
+# MetricsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**metricsEndpoint**](#metricsendpoint) | **GET** /metrics/ | `GET /metrics` — Prometheus scrape endpoint.|
+
+# **metricsEndpoint**
+> metricsEndpoint()
+
+
+### Example
+
+```typescript
+import {
+    MetricsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new MetricsApi(configuration);
+
+const { status, data } = await apiInstance.metricsEndpoint();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prometheus metrics |  -  |
+
+[[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/NotificationCount.md

@@ -0,0 +1,25 @@
+# NotificationCount
+
+Count of unread and total inbox notifications.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_count** | **number** |  | [default to undefined]
+**unread_count** | **number** |  | [default to undefined]
+**unseen_count** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationCount } from '@enbbox/api';
+
+const instance: NotificationCount = {
+    total_count,
+    unread_count,
+    unseen_count,
+};
+```
+
+[[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/NotificationGroupRecord.md

@@ -0,0 +1,23 @@
+# NotificationGroupRecord
+
+A notification group used to categorize and organize workflows.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier. | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationGroupRecord } from '@enbbox/api';
+
+const instance: NotificationGroupRecord = {
+    id,
+    name,
+};
+```
+
+[[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/NotificationGroupsApi.md

@@ -0,0 +1,209 @@
+# NotificationGroupsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createNotificationGroup**](#createnotificationgroup) | **POST** /v1/notification-groups/ | POST /v1/notification-groups|
+|[**deleteNotificationGroup**](#deletenotificationgroup) | **DELETE** /v1/notification-groups/{id}/ | DELETE /v1/notification-groups/:id|
+|[**listNotificationGroups**](#listnotificationgroups) | **GET** /v1/notification-groups/ | GET /v1/notification-groups|
+|[**updateNotificationGroup**](#updatenotificationgroup) | **PATCH** /v1/notification-groups/{id}/ | PATCH /v1/notification-groups/:id|
+
+# **createNotificationGroup**
+> NotificationGroupRecord createNotificationGroup(createNotificationGroup)
+
+
+### Example
+
+```typescript
+import {
+    NotificationGroupsApi,
+    Configuration,
+    CreateNotificationGroup
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationGroupsApi(configuration);
+
+let createNotificationGroup: CreateNotificationGroup; //
+
+const { status, data } = await apiInstance.createNotificationGroup(
+    createNotificationGroup
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createNotificationGroup** | **CreateNotificationGroup**|  | |
+
+
+### Return type
+
+**NotificationGroupRecord**
+
+### 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)
+
+# **deleteNotificationGroup**
+> deleteNotificationGroup()
+
+
+### Example
+
+```typescript
+import {
+    NotificationGroupsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationGroupsApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteNotificationGroup(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group 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 |
+|-------------|-------------|------------------|
+|**204** | Deleted |  -  |
+
+[[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)
+
+# **listNotificationGroups**
+> Array<NotificationGroupRecord> listNotificationGroups()
+
+
+### Example
+
+```typescript
+import {
+    NotificationGroupsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationGroupsApi(configuration);
+
+const { status, data } = await apiInstance.listNotificationGroups();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<NotificationGroupRecord>**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **updateNotificationGroup**
+> NotificationGroupRecord updateNotificationGroup(updateNotificationGroup)
+
+
+### Example
+
+```typescript
+import {
+    NotificationGroupsApi,
+    Configuration,
+    UpdateNotificationGroup
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationGroupsApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+let updateNotificationGroup: UpdateNotificationGroup; //
+
+const { status, data } = await apiInstance.updateNotificationGroup(
+    id,
+    updateNotificationGroup
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateNotificationGroup** | **UpdateNotificationGroup**|  | |
+| **id** | [**string**] | Group ID | defaults to undefined|
+
+
+### Return type
+
+**NotificationGroupRecord**
+
+### 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)
+

package/docs/NotificationLog.md

@@ -0,0 +1,33 @@
+# NotificationLog
+
+A notification log entry with processing status and metadata.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channels** | **Array<string>** |  | [default to undefined]
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**jobs** | [**Array<JobLog>**](JobLog.md) |  | [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+**transaction_id** | **string** |  | [default to undefined]
+**workflow_id** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationLog } from '@enbbox/api';
+
+const instance: NotificationLog = {
+    channels,
+    created_at,
+    id,
+    jobs,
+    subscriber_id,
+    transaction_id,
+    workflow_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/NotificationQuery.md

@@ -0,0 +1,25 @@
+# NotificationQuery
+
+Query parameters for filtering notification logs.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **number** | Maximum number of items per page (1–100, default: 10). | [optional] [default to undefined]
+**page** | **number** | Zero-based page index (default: 0). | [optional] [default to undefined]
+**q** | **string** | Optional full-text search query (e.g. subscriber_id, transaction_id). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationQuery } from '@enbbox/api';
+
+const instance: NotificationQuery = {
+    limit,
+    page,
+    q,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)