@enbbox/api 1.0.0 → 1.1.0

package/docs/InboxApi.md

@@ -0,0 +1,673 @@
+# InboxApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**archive**](#archive) | **POST** /v1/inbox/notifications/{id}/archive/ | POST /v1/inbox/notifications/:id/archive|
+|[**archiveAll**](#archiveall) | **POST** /v1/inbox/notifications/archive/ | POST /v1/inbox/notifications/archive  (archive all)|
+|[**executeAction**](#executeaction) | **POST** /v1/inbox/notifications/{id}/actions/{action_type}/ | POST /v1/inbox/notifications/:id/actions/:actionType|
+|[**getInboxPreferences**](#getinboxpreferences) | **GET** /v1/inbox/preferences/ | GET /v1/inbox/preferences|
+|[**inboxListNotifications**](#inboxlistnotifications) | **GET** /v1/inbox/notifications/ | GET /v1/inbox/notifications/|
+|[**initInboxSession**](#initinboxsession) | **POST** /v1/inbox/session/ | POST /v1/inbox/session/|
+|[**markAllRead**](#markallread) | **POST** /v1/inbox/notifications/read/ | POST /v1/inbox/notifications/read  (mark all as read)|
+|[**markRead**](#markread) | **POST** /v1/inbox/notifications/{id}/read/ | POST /v1/inbox/notifications/:id/read|
+|[**markUnread**](#markunread) | **POST** /v1/inbox/notifications/{id}/unread/ | POST /v1/inbox/notifications/:id/unread|
+|[**notificationCount**](#notificationcount) | **GET** /v1/inbox/notifications/count/ | GET /v1/inbox/notifications/count|
+|[**unarchive**](#unarchive) | **POST** /v1/inbox/notifications/{id}/unarchive/ | POST /v1/inbox/notifications/:id/unarchive|
+|[**updateInboxGlobalPreference**](#updateinboxglobalpreference) | **PATCH** /v1/inbox/preferences/ | PATCH /v1/inbox/preferences|
+|[**updateInboxWorkflowPreference**](#updateinboxworkflowpreference) | **PATCH** /v1/inbox/preferences/{workflow_id}/ | PATCH /v1/inbox/preferences/:workflowId|
+
+# **archive**
+> archive()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let id: string; //Notification ID (default to undefined)
+
+const { status, data } = await apiInstance.archive(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Notification 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** | Archived |  -  |
+
+[[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)
+
+# **archiveAll**
+> archiveAll()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+const { status, data } = await apiInstance.archiveAll();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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** | All archived |  -  |
+
+[[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)
+
+# **executeAction**
+> ActionRecord executeAction(actionBody)
+
+Execute an action on a notification (e.g. primary/secondary button click). Sets the action result on the message and optionally publishes an SSE event.
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration,
+    ActionBody
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let id: string; //Notification ID (default to undefined)
+let actionType: string; //Action type (default to undefined)
+let actionBody: ActionBody; //
+
+const { status, data } = await apiInstance.executeAction(
+    id,
+    actionType,
+    actionBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **actionBody** | **ActionBody**|  | |
+| **id** | [**string**] | Notification ID | defaults to undefined|
+| **actionType** | [**string**] | Action type | defaults to undefined|
+
+
+### Return type
+
+**ActionRecord**
+
+### 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)
+
+# **getInboxPreferences**
+> Array<InboxPreference> getInboxPreferences()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+const { status, data } = await apiInstance.getInboxPreferences();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<InboxPreference>**
+
+### 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)
+
+# **inboxListNotifications**
+> Array<InboxNotification> inboxListNotifications()
+
+Content negotiation: - `Accept: application/json` (default) → paginated JSON list - `Accept: text/event-stream` → SSE real-time stream (authenticated via subscriber JWT)
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let limit: number; // (optional) (default to undefined)
+let after: string; // (optional) (default to undefined)
+let read: boolean; // (optional) (default to undefined)
+let archived: boolean; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.inboxListNotifications(
+    limit,
+    after,
+    read,
+    archived
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **after** | [**string**] |  | (optional) defaults to undefined|
+| **read** | [**boolean**] |  | (optional) defaults to undefined|
+| **archived** | [**boolean**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<InboxNotification>**
+
+### 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** | JSON list or SSE stream depending on Accept header |  -  |
+
+[[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)
+
+# **initInboxSession**
+> InitSessionResponse initInboxSession(initSessionRequest)
+
+Unauthenticated endpoint — this is the initial handshake for SDK subscribers. Project ID is provided via the `X-Project-Id` header (same as all project-aware endpoints). Validates the project, optionally verifies HMAC subscriber hash, auto-creates the subscriber if needed, and returns a short-lived JWT.
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration,
+    InitSessionRequest
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let xProjectId: string; //Project UUID (default to undefined)
+let initSessionRequest: InitSessionRequest; //
+
+const { status, data } = await apiInstance.initInboxSession(
+    xProjectId,
+    initSessionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **initSessionRequest** | **InitSessionRequest**|  | |
+| **xProjectId** | [**string**] | Project UUID | defaults to undefined|
+
+
+### Return type
+
+**InitSessionResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Session initialized |  -  |
+|**400** | Missing or invalid X-Project-Id header |  -  |
+|**401** | Invalid subscriber hash |  -  |
+|**404** | Project not found |  -  |
+
+[[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)
+
+# **markAllRead**
+> markAllRead()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+const { status, data } = await apiInstance.markAllRead();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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** | All marked as read |  -  |
+
+[[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)
+
+# **markRead**
+> markRead()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let id: string; //Notification ID (default to undefined)
+
+const { status, data } = await apiInstance.markRead(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Notification 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** | Marked as read |  -  |
+
+[[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)
+
+# **markUnread**
+> markUnread()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let id: string; //Notification ID (default to undefined)
+
+const { status, data } = await apiInstance.markUnread(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Notification 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** | Marked as unread |  -  |
+
+[[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)
+
+# **notificationCount**
+> NotificationCount notificationCount()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+const { status, data } = await apiInstance.notificationCount();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**NotificationCount**
+
+### 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)
+
+# **unarchive**
+> unarchive()
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let id: string; //Notification ID (default to undefined)
+
+const { status, data } = await apiInstance.unarchive(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Notification 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** | Unarchived |  -  |
+
+[[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)
+
+# **updateInboxGlobalPreference**
+> updateInboxGlobalPreference(updateInboxPreferences)
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration,
+    UpdateInboxPreferences
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let updateInboxPreferences: UpdateInboxPreferences; //
+
+const { status, data } = await apiInstance.updateInboxGlobalPreference(
+    updateInboxPreferences
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateInboxPreferences** | **UpdateInboxPreferences**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Updated |  -  |
+
+[[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)
+
+# **updateInboxWorkflowPreference**
+> updateInboxWorkflowPreference(updateInboxPreferences)
+
+
+### Example
+
+```typescript
+import {
+    InboxApi,
+    Configuration,
+    UpdateInboxPreferences
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboxApi(configuration);
+
+let workflowId: string; //Workflow ID (default to undefined)
+let updateInboxPreferences: UpdateInboxPreferences; //
+
+const { status, data } = await apiInstance.updateInboxWorkflowPreference(
+    workflowId,
+    updateInboxPreferences
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateInboxPreferences** | **UpdateInboxPreferences**|  | |
+| **workflowId** | [**string**] | Workflow ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Updated |  -  |
+
+[[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/InboxNotification.md

@@ -0,0 +1,41 @@
+# InboxNotification
+
+A notification item in a subscriber inbox feed.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **string** |  | [default to undefined]
+**channel_type** | **string** |  | [default to undefined]
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**data** | **object** |  | [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]
+**read_at** | **string** |  | [optional] [default to undefined]
+**seen_at** | **string** |  | [optional] [default to undefined]
+**subject** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InboxNotification } from '@enbbox/api';
+
+const instance: InboxNotification = {
+    body,
+    channel_type,
+    created_at,
+    data,
+    id,
+    is_archived,
+    is_read,
+    is_seen,
+    read_at,
+    seen_at,
+    subject,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)