@enbbox/api 1.0.0 → 1.1.0

package/docs/UpdateSubscriber.md

@@ -0,0 +1,35 @@
+# UpdateSubscriber
+
+Partial update of an existing subscriber\'s profile. Only provided fields are updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**avatar** | **string** | Updated avatar URL. | [optional] [default to undefined]
+**data** | **object** | Updated metadata (replaces existing data). | [default to undefined]
+**email** | **string** | Updated email address. | [optional] [default to undefined]
+**first_name** | **string** | Updated first name. | [optional] [default to undefined]
+**last_name** | **string** | Updated last name. | [optional] [default to undefined]
+**locale** | **string** | Updated locale tag. | [optional] [default to undefined]
+**phone** | **string** | Updated phone number in E.164 format. | [optional] [default to undefined]
+**timezone** | **string** | Updated timezone. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateSubscriber } from '@enbbox/api';
+
+const instance: UpdateSubscriber = {
+    avatar,
+    data,
+    email,
+    first_name,
+    last_name,
+    locale,
+    phone,
+    timezone,
+};
+```
+
+[[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/UpdateSubscriptionMeta.md

@@ -0,0 +1,21 @@
+# UpdateSubscriptionMeta
+
+Update topic subscription metadata.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **object** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateSubscriptionMeta } from '@enbbox/api';
+
+const instance: UpdateSubscriptionMeta = {
+    metadata,
+};
+```
+
+[[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/UpdateTopic.md

@@ -0,0 +1,21 @@
+# UpdateTopic
+
+Update a topic name or key.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Display name. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateTopic } from '@enbbox/api';
+
+const instance: UpdateTopic = {
+    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/UpdateWorkflow.md

@@ -0,0 +1,31 @@
+# UpdateWorkflow
+
+Partial update of an existing workflow. Only provided fields are changed.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Updated active status. | [optional] [default to undefined]
+**description** | **string** | Updated description. | [optional] [default to undefined]
+**name** | **string** | Updated workflow name. | [optional] [default to undefined]
+**preference_settings** | [**PreferenceChannels**](PreferenceChannels.md) | Updated preference settings. | [optional] [default to undefined]
+**steps** | [**Array<WorkflowStepCreate>**](WorkflowStepCreate.md) | Updated steps (replaces all existing steps). | [optional] [default to undefined]
+**tags** | **Array<string>** | Updated tags. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateWorkflow } from '@enbbox/api';
+
+const instance: UpdateWorkflow = {
+    active,
+    description,
+    name,
+    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/Usage.md

@@ -0,0 +1,35 @@
+# Usage
+
+Detailed usage data for the current billing period.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events_current** | **number** | Events consumed in the current billing period. | [default to undefined]
+**events_included** | **number** | Events included in the plan (null = unlimited). | [optional] [default to undefined]
+**events_overage** | **number** | Overage event count beyond the included quota. | [default to undefined]
+**overage_cost** | **number** | Total overage cost in dollars for this period. | [default to undefined]
+**overage_rate** | **number** | Cost per 1,000 overage events in dollars. | [default to undefined]
+**period_end** | **string** | Billing period end (ISO 8601). | [optional] [default to undefined]
+**period_start** | **string** | Billing period start (ISO 8601). | [optional] [default to undefined]
+**plan** | [**Plan**](Plan.md) | Plan the usage applies to. | [default to undefined]
+
+## Example
+
+```typescript
+import { Usage } from '@enbbox/api';
+
+const instance: Usage = {
+    events_current,
+    events_included,
+    events_overage,
+    overage_cost,
+    overage_rate,
+    period_end,
+    period_start,
+    plan,
+};
+```
+
+[[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/WebhookRecord.md

@@ -0,0 +1,31 @@
+# WebhookRecord
+
+A registered webhook endpoint that receives event callbacks.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Whether this resource is active. | [default to undefined]
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**events** | **Array<string>** | Event types this webhook subscribes to. | [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**signing_key** | **string** | HMAC signing key for verifying webhook payloads. | [default to undefined]
+**url** | **string** | Webhook callback URL. | [default to undefined]
+
+## Example
+
+```typescript
+import { WebhookRecord } from '@enbbox/api';
+
+const instance: WebhookRecord = {
+    active,
+    created_at,
+    events,
+    id,
+    signing_key,
+    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)

package/docs/WebhooksApi.md

@@ -0,0 +1,212 @@
+# WebhooksApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteWebhook**](#deletewebhook) | **DELETE** /v1/webhooks/{id}/ | DELETE /v1/webhooks/:id|
+|[**inboundDeliveryWebhook**](#inbounddeliverywebhook) | **POST** /v1/inbound-webhooks/delivery-providers/{project_id}/{integration_id}/ | POST /v1/inbound-webhooks/delivery-providers/:project_id/:integration_id|
+|[**listWebhooks**](#listwebhooks) | **GET** /v1/webhooks/ | GET /v1/webhooks|
+|[**registerWebhook**](#registerwebhook) | **POST** /v1/webhooks/ | POST /v1/webhooks|
+
+# **deleteWebhook**
+> deleteWebhook()
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let id: string; //Webhook ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteWebhook(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Webhook 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** | 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)
+
+# **inboundDeliveryWebhook**
+> DeliveryAck inboundDeliveryWebhook(deliveryStatusWebhook)
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration,
+    DeliveryStatusWebhook
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let projectId: string; // (default to undefined)
+let integrationId: string; // (default to undefined)
+let deliveryStatusWebhook: DeliveryStatusWebhook; //
+
+const { status, data } = await apiInstance.inboundDeliveryWebhook(
+    projectId,
+    integrationId,
+    deliveryStatusWebhook
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deliveryStatusWebhook** | **DeliveryStatusWebhook**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+| **integrationId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeliveryAck**
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+# **listWebhooks**
+> Array<WebhookRecord> listWebhooks()
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+const { status, data } = await apiInstance.listWebhooks();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<WebhookRecord>**
+
+### 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)
+
+# **registerWebhook**
+> WebhookRecord registerWebhook(createWebhook)
+
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration,
+    CreateWebhook
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let createWebhook: CreateWebhook; //
+
+const { status, data } = await apiInstance.registerWebhook(
+    createWebhook
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createWebhook** | **CreateWebhook**|  | |
+
+
+### Return type
+
+**WebhookRecord**
+
+### 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/WidgetSettings.md

@@ -0,0 +1,21 @@
+# WidgetSettings
+
+Configuration for the embeddable notification center widget.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification_center_encryption** | **boolean** | Whether to encrypt the HMAC subscriber token for the widget. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WidgetSettings } from '@enbbox/api';
+
+const instance: WidgetSettings = {
+    notification_center_encryption,
+};
+```
+
+[[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/WorkflowRecord.md

@@ -0,0 +1,37 @@
+# WorkflowRecord
+
+A notification workflow with its steps, status, and configuration.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Whether the workflow is active. | [default to undefined]
+**critical** | **boolean** | Whether this workflow is critical (bypasses preferences). | [default to undefined]
+**description** | **string** | Description. | [optional] [default to undefined]
+**id** | **string** | Workflow UUID. | [default to undefined]
+**identifier** | **string** | Unique slug identifier used in trigger calls. | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+**notification_group_id** | **string** | Associated notification group UUID. | [default to undefined]
+**steps** | **Array<any>** | Serialized step definitions. | [default to undefined]
+**tags** | **Array<string>** | Tags for filtering. | [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowRecord } from '@enbbox/api';
+
+const instance: WorkflowRecord = {
+    active,
+    critical,
+    description,
+    id,
+    identifier,
+    name,
+    notification_group_id,
+    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/WorkflowRunRecord.md

@@ -0,0 +1,31 @@
+# WorkflowRunRecord
+
+A single execution run of a workflow — tracks start/end time and completion status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**completed_at** | **string** | ISO 8601 timestamp when the run completed (null if still running). | [optional] [default to undefined]
+**id** | **string** | Run UUID. | [default to undefined]
+**project_id** | **string** | Project where the run executed. | [default to undefined]
+**started_at** | **string** | ISO 8601 timestamp when the run started. | [default to undefined]
+**status** | **string** | Run status: `running`, `completed`, `failed`. | [default to undefined]
+**workflow_id** | **string** | Workflow UUID that was executed. | [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowRunRecord } from '@enbbox/api';
+
+const instance: WorkflowRunRecord = {
+    completed_at,
+    id,
+    project_id,
+    started_at,
+    status,
+    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/WorkflowStatsResponse.md

@@ -0,0 +1,27 @@
+# WorkflowStatsResponse
+
+Aggregate statistics for workflow executions.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**avg_duration_ms** | **number** | Average duration in milliseconds. | [default to undefined]
+**completed** | **number** | Completed runs. | [default to undefined]
+**failed** | **number** | Failed runs. | [default to undefined]
+**total_runs** | **number** | Total workflow runs. | [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowStatsResponse } from '@enbbox/api';
+
+const instance: WorkflowStatsResponse = {
+    avg_duration_ms,
+    completed,
+    failed,
+    total_runs,
+};
+```
+
+[[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/WorkflowStatus.md

@@ -0,0 +1,21 @@
+# WorkflowStatus
+
+Toggle a workflow on or off.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | New active status. | [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowStatus } from '@enbbox/api';
+
+const instance: WorkflowStatus = {
+    active,
+};
+```
+
+[[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/WorkflowStepCreate.md

@@ -0,0 +1,31 @@
+# WorkflowStepCreate
+
+Defines one step of a workflow — the channel type, template, and conditions.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Whether this step is active. Inactive steps are skipped. | [optional] [default to undefined]
+**filters** | **object** | Step execution filters/conditions. | [default to undefined]
+**metadata** | **object** | Arbitrary step metadata. | [default to undefined]
+**name** | **string** | Human-readable step name. | [optional] [default to undefined]
+**step_type** | [**StepType**](StepType.md) | Delivery channel/type for this step. | [default to undefined]
+**template** | **object** | Content template with {{handlebar}} placeholders. | [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowStepCreate } from '@enbbox/api';
+
+const instance: WorkflowStepCreate = {
+    active,
+    filters,
+    metadata,
+    name,
+    step_type,
+    template,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)