@enbbox/api 1.0.0 → 1.1.0

package/docs/ActivityApi.md

@@ -0,0 +1,412 @@
+# ActivityApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**activityChart**](#activitychart) | **GET** /v1/activity/chart/ | GET /v1/activity/chart — activity chart data|
+|[**activityStats**](#activitystats) | **GET** /v1/activity/stats/ | GET /v1/activity/stats|
+|[**engagementStats**](#engagementstats) | **GET** /v1/activity/engagement/ | GET /v1/activity/engagement — subscriber engagement stats|
+|[**getActivityByNotification**](#getactivitybynotification) | **GET** /v1/activity/{notification_id}/ | GET /v1/activity/:notificationId|
+|[**listActivity**](#listactivity) | **GET** /v1/activity/ | GET /v1/activity|
+|[**listActivityRequests**](#listactivityrequests) | **GET** /v1/activity/requests/ | GET /v1/activity/requests — list trigger requests|
+|[**listWorkflowRuns**](#listworkflowruns) | **GET** /v1/activity/workflow-runs/ | GET /v1/activity/workflow-runs — list workflow executions|
+|[**workflowStats**](#workflowstats) | **GET** /v1/activity/workflows/stats/ | GET /v1/activity/workflows/stats — workflow execution stats|
+
+# **activityChart**
+> Array<ActivityChartPoint> activityChart()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+let days: number; //Number of days to include in the chart (1–365, default: 30). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.activityChart(
+    days
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **days** | [**number**] | Number of days to include in the chart (1–365, default: 30). | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<ActivityChartPoint>**
+
+### 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)
+
+# **activityStats**
+> ActivityStats activityStats()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+const { status, data } = await apiInstance.activityStats();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ActivityStats**
+
+### 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)
+
+# **engagementStats**
+> EngagementStatsResponse engagementStats()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+const { status, data } = await apiInstance.engagementStats();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**EngagementStatsResponse**
+
+### 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)
+
+# **getActivityByNotification**
+> Array<ActivityRecord> getActivityByNotification()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+let notificationId: string; //Notification ID (default to undefined)
+
+const { status, data } = await apiInstance.getActivityByNotification(
+    notificationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | [**string**] | Notification ID | defaults to undefined|
+
+
+### Return type
+
+**Array<ActivityRecord>**
+
+### 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)
+
+# **listActivity**
+> Array<ActivityRecord> listActivity()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+let limit: number; //Maximum number of items per page (1–100, default: 10). (optional) (default to undefined)
+let page: number; //Zero-based page index (default: 0). (optional) (default to undefined)
+let q: string; //Optional full-text search query (e.g. detail text, provider_id, workflow_identifier). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listActivity(
+    limit,
+    page,
+    q
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of items per page (1–100, default: 10). | (optional) defaults to undefined|
+| **page** | [**number**] | Zero-based page index (default: 0). | (optional) defaults to undefined|
+| **q** | [**string**] | Optional full-text search query (e.g. detail text, provider_id, workflow_identifier). | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<ActivityRecord>**
+
+### 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)
+
+# **listActivityRequests**
+> Array<ActivityRequestRecord> listActivityRequests()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+let limit: number; //Maximum number of items per page (1–100, default: 10). (optional) (default to undefined)
+let page: number; //Zero-based page index (default: 0). (optional) (default to undefined)
+let q: string; //Optional full-text search query (e.g. detail text, provider_id, workflow_identifier). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listActivityRequests(
+    limit,
+    page,
+    q
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of items per page (1–100, default: 10). | (optional) defaults to undefined|
+| **page** | [**number**] | Zero-based page index (default: 0). | (optional) defaults to undefined|
+| **q** | [**string**] | Optional full-text search query (e.g. detail text, provider_id, workflow_identifier). | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<ActivityRequestRecord>**
+
+### 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)
+
+# **listWorkflowRuns**
+> Array<WorkflowRunRecord> listWorkflowRuns()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+let limit: number; //Maximum number of items per page (1–100, default: 10). (optional) (default to undefined)
+let page: number; //Zero-based page index (default: 0). (optional) (default to undefined)
+let q: string; //Optional full-text search query (e.g. detail text, provider_id, workflow_identifier). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listWorkflowRuns(
+    limit,
+    page,
+    q
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of items per page (1–100, default: 10). | (optional) defaults to undefined|
+| **page** | [**number**] | Zero-based page index (default: 0). | (optional) defaults to undefined|
+| **q** | [**string**] | Optional full-text search query (e.g. detail text, provider_id, workflow_identifier). | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<WorkflowRunRecord>**
+
+### 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)
+
+# **workflowStats**
+> WorkflowStatsResponse workflowStats()
+
+
+### Example
+
+```typescript
+import {
+    ActivityApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ActivityApi(configuration);
+
+const { status, data } = await apiInstance.workflowStats();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**WorkflowStatsResponse**
+
+### 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/ActivityChartPoint.md

@@ -0,0 +1,31 @@
+# ActivityChartPoint
+
+A single data point in the activity timeline chart.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **string** | Date string (YYYY-MM-DD). | [default to undefined]
+**email** | **number** | Email channel count. | [default to undefined]
+**in_app** | **number** | In-app notification count. | [default to undefined]
+**push** | **number** | Push notification count. | [default to undefined]
+**sms** | **number** | SMS channel count. | [default to undefined]
+**total** | **number** | Total notifications on this date. | [default to undefined]
+
+## Example
+
+```typescript
+import { ActivityChartPoint } from '@enbbox/api';
+
+const instance: ActivityChartPoint = {
+    date,
+    email,
+    in_app,
+    push,
+    sms,
+    total,
+};
+```
+
+[[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/ActivityRecord.md

@@ -0,0 +1,39 @@
+# ActivityRecord
+
+An activity log entry recording one execution step of a notification delivery.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | ISO 8601 timestamp when this activity was recorded. | [default to undefined]
+**detail** | **string** | Human-readable detail of this execution step. | [default to undefined]
+**id** | **string** | Execution detail UUID. | [default to undefined]
+**is_retry** | **boolean** | Whether this was an automatic retry. | [default to undefined]
+**is_test** | **boolean** | Whether this was a test-mode execution. | [default to undefined]
+**job_id** | **string** | Parent job UUID. | [default to undefined]
+**notification_id** | **string** | Parent notification UUID. | [default to undefined]
+**provider_id** | **string** | Provider that handled delivery (null if not yet assigned). | [optional] [default to undefined]
+**source** | **string** | Originating source: `api`, `worker`, `webhook`. | [default to undefined]
+**status** | **string** | Execution status: `success`, `failed`, `pending`. | [default to undefined]
+
+## Example
+
+```typescript
+import { ActivityRecord } from '@enbbox/api';
+
+const instance: ActivityRecord = {
+    created_at,
+    detail,
+    id,
+    is_retry,
+    is_test,
+    job_id,
+    notification_id,
+    provider_id,
+    source,
+    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/ActivityRequestRecord.md

@@ -0,0 +1,31 @@
+# ActivityRequestRecord
+
+A record of a trigger API request — which workflow was triggered for which subscribers.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | ISO 8601 timestamp. | [default to undefined]
+**id** | **string** | Request UUID. | [default to undefined]
+**status** | **string** | Processing status. | [default to undefined]
+**subscriber_ids** | **Array<string>** | List of targeted subscriber IDs. | [default to undefined]
+**transaction_id** | **string** | Client-provided transaction ID for idempotency. | [default to undefined]
+**workflow_identifier** | **string** | The workflow that was triggered. | [default to undefined]
+
+## Example
+
+```typescript
+import { ActivityRequestRecord } from '@enbbox/api';
+
+const instance: ActivityRequestRecord = {
+    created_at,
+    id,
+    status,
+    subscriber_ids,
+    transaction_id,
+    workflow_identifier,
+};
+```
+
+[[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/ActivityStats.md

@@ -0,0 +1,31 @@
+# ActivityStats
+
+Summary statistics of notification delivery activity.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**monthly_sent** | **number** | Notifications sent in the last 30 days. | [default to undefined]
+**total_delivered** | **number** | Total successful deliveries. | [default to undefined]
+**total_failed** | **number** | Total failed deliveries. | [default to undefined]
+**total_pending** | **number** | Total pending deliveries. | [default to undefined]
+**total_sent** | **number** | Total notifications sent. | [default to undefined]
+**weekly_sent** | **number** | Notifications sent in the last 7 days. | [default to undefined]
+
+## Example
+
+```typescript
+import { ActivityStats } from '@enbbox/api';
+
+const instance: ActivityStats = {
+    monthly_sent,
+    total_delivered,
+    total_failed,
+    total_pending,
+    total_sent,
+    weekly_sent,
+};
+```
+
+[[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/ActorType.md

@@ -0,0 +1,15 @@
+# ActorType
+
+Actor type for notification attribution.
+
+## Enum
+
+* `None` (value: `'none'`)
+
+* `User` (value: `'user'`)
+
+* `SystemIcon` (value: `'system_icon'`)
+
+* `SystemCustom` (value: `'system_custom'`)
+
+[[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/ApiKeyCreated.md

@@ -0,0 +1,27 @@
+# ApiKeyCreated
+
+Newly created API key. The raw key is shown only at creation time.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for this API key. | [default to undefined]
+**key** | **string** | The raw API key value. Save this — it will not be shown again. | [default to undefined]
+**masked_key** | **string** | The masked display version. | [default to undefined]
+**user_id** | **string** | ID of the user who created this key. | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiKeyCreated } from '@enbbox/api';
+
+const instance: ApiKeyCreated = {
+    id,
+    key,
+    masked_key,
+    user_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/ApiKeyInfo.md

@@ -0,0 +1,27 @@
+# ApiKeyInfo
+
+API key metadata. The full key is only shown at creation time.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | When the key was created. | [optional] [default to undefined]
+**id** | **string** | Unique identifier for this API key. | [default to undefined]
+**masked_key** | **string** | Masked API key (first 12 chars + `...`). | [default to undefined]
+**user_id** | **string** | ID of the user who created this key. | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiKeyInfo } from '@enbbox/api';
+
+const instance: ApiKeyInfo = {
+    created_at,
+    id,
+    masked_key,
+    user_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/AutoConfigureResult.md

@@ -0,0 +1,21 @@
+# AutoConfigureResult
+
+Result of auto-configuring a provider integration.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook_url** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AutoConfigureResult } from '@enbbox/api';
+
+const instance: AutoConfigureResult = {
+    webhook_url,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)