@enbbox/api 1.0.0 → 1.0.1

package/docs/PaginatedTopicSubscriptionRecordDataInner.md

@@ -0,0 +1,29 @@
+# PaginatedTopicSubscriptionRecordDataInner
+
+A subscription linking a subscriber to a topic.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**metadata** | **object** |  | [optional] [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+**topic_key** | **string** | Topic key for fan-out. | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedTopicSubscriptionRecordDataInner } from '@enbbox/api';
+
+const instance: PaginatedTopicSubscriptionRecordDataInner = {
+    created_at,
+    id,
+    metadata,
+    subscriber_id,
+    topic_key,
+};
+```
+
+[[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/PaginatedWorkflowRecord.md

@@ -0,0 +1,23 @@
+# PaginatedWorkflowRecord
+
+A paginated response containing a `data` array and `meta` pagination info.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<PaginatedWorkflowRecordDataInner>**](PaginatedWorkflowRecordDataInner.md) | Array of items for this page. | [default to undefined]
+**meta** | [**OffsetMeta**](OffsetMeta.md) | Pagination metadata. | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedWorkflowRecord } from '@enbbox/api';
+
+const instance: PaginatedWorkflowRecord = {
+    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/PaginatedWorkflowRecordDataInner.md

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

@@ -0,0 +1,25 @@
+# PaginationQuery
+
+Page-based pagination parameters.
+
+## 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. detail text, provider_id, workflow_identifier). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationQuery } from '@enbbox/api';
+
+const instance: PaginationQuery = {
+    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)

package/docs/PatchCredentials.md

@@ -0,0 +1,27 @@
+# PatchCredentials
+
+Partially update subscriber provider credentials.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credentials** | **object** |  | [default to undefined]
+**device_tokens** | **Array<string>** |  | [optional] [default to undefined]
+**provider_id** | **string** | Provider identifier. | [default to undefined]
+**webhook_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchCredentials } from '@enbbox/api';
+
+const instance: PatchCredentials = {
+    credentials,
+    device_tokens,
+    provider_id,
+    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)

package/docs/Plan.md

@@ -0,0 +1,17 @@
+# Plan
+
+Billing plan that determines API rate limits and feature access.
+
+## Enum
+
+* `Free` (value: `'free'`)
+
+* `Pro` (value: `'pro'`)
+
+* `Business` (value: `'business'`)
+
+* `Enterprise` (value: `'enterprise'`)
+
+* `Unlimited` (value: `'unlimited'`)
+
+[[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/PlanLimitsResponse.md

@@ -0,0 +1,33 @@
+# PlanLimitsResponse
+
+Plan limits + current usage for the project.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_events** | **number** | Events consumed this period. | [default to undefined]
+**current_members** | **number** | Current team member count. | [default to undefined]
+**current_workflows** | **number** | Current workflow count. | [default to undefined]
+**max_events** | **number** | Max events/month (null = unlimited). | [optional] [default to undefined]
+**max_team_members** | **number** | Max team members (null = unlimited). | [optional] [default to undefined]
+**max_workflows** | **number** | Max workflows (null = unlimited). | [optional] [default to undefined]
+**plan** | [**Plan**](Plan.md) | Current plan tier. | [default to undefined]
+
+## Example
+
+```typescript
+import { PlanLimitsResponse } from '@enbbox/api';
+
+const instance: PlanLimitsResponse = {
+    current_events,
+    current_members,
+    current_workflows,
+    max_events,
+    max_team_members,
+    max_workflows,
+    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/PortalUrl.md

@@ -0,0 +1,21 @@
+# PortalUrl
+
+Billing portal URL.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | URL to redirect the user to the Stripe Customer Portal. | [default to undefined]
+
+## Example
+
+```typescript
+import { PortalUrl } from '@enbbox/api';
+
+const instance: PortalUrl = {
+    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/PreferenceChannels.md

@@ -0,0 +1,29 @@
+# PreferenceChannels
+
+Per-channel preference toggles.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chat** | **boolean** |  | [optional] [default to undefined]
+**email** | **boolean** |  | [optional] [default to undefined]
+**in_app** | **boolean** |  | [optional] [default to undefined]
+**push** | **boolean** |  | [optional] [default to undefined]
+**sms** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PreferenceChannels } from '@enbbox/api';
+
+const instance: PreferenceChannels = {
+    chat,
+    email,
+    in_app,
+    push,
+    sms,
+};
+```
+
+[[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/PreferenceRecord.md

@@ -0,0 +1,27 @@
+# PreferenceRecord
+
+A subscriber preference for a specific workflow or channel.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channels** | [**PreferenceChannels**](PreferenceChannels.md) |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+**workflow_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PreferenceRecord } from '@enbbox/api';
+
+const instance: PreferenceRecord = {
+    channels,
+    enabled,
+    subscriber_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/PreferencesApi.md

@@ -0,0 +1,171 @@
+# PreferencesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**listPreferences**](#listpreferences) | **GET** /v1/subscribers/{id}/preferences/ | GET /v1/subscribers/:id/preferences|
+|[**updateGlobalPreference**](#updateglobalpreference) | **PATCH** /v1/subscribers/{id}/preferences/ | PATCH /v1/subscribers/:id/preferences|
+|[**updateWorkflowPreference**](#updateworkflowpreference) | **PATCH** /v1/subscribers/{id}/preferences/{workflow_id}/ | PATCH /v1/subscribers/:id/preferences/:workflowId|
+
+# **listPreferences**
+> Array<PreferenceRecord> listPreferences()
+
+
+### Example
+
+```typescript
+import {
+    PreferencesApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new PreferencesApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+
+const { status, data } = await apiInstance.listPreferences(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**Array<PreferenceRecord>**
+
+### 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)
+
+# **updateGlobalPreference**
+> PreferenceRecord updateGlobalPreference(updatePreference)
+
+
+### Example
+
+```typescript
+import {
+    PreferencesApi,
+    Configuration,
+    UpdatePreference
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new PreferencesApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let updatePreference: UpdatePreference; //
+
+const { status, data } = await apiInstance.updateGlobalPreference(
+    id,
+    updatePreference
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updatePreference** | **UpdatePreference**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**PreferenceRecord**
+
+### 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)
+
+# **updateWorkflowPreference**
+> PreferenceRecord updateWorkflowPreference(updatePreference)
+
+
+### Example
+
+```typescript
+import {
+    PreferencesApi,
+    Configuration,
+    UpdatePreference
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new PreferencesApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let workflowId: string; //Workflow ID (default to undefined)
+let updatePreference: UpdatePreference; //
+
+const { status, data } = await apiInstance.updateWorkflowPreference(
+    id,
+    workflowId,
+    updatePreference
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updatePreference** | **UpdatePreference**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+| **workflowId** | [**string**] | Workflow ID | defaults to undefined|
+
+
+### Return type
+
+**PreferenceRecord**
+
+### 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/PreviewResult.md

@@ -0,0 +1,20 @@
+# PreviewResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rendered** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PreviewResult } from '@enbbox/api';
+
+const instance: PreviewResult = {
+    rendered,
+};
+```
+
+[[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/PriceInfo.md

@@ -0,0 +1,27 @@
+# PriceInfo
+
+Price info for a plan tier.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annual_price** | **number** | Annual price in cents (null for free/enterprise). | [optional] [default to undefined]
+**currency** | **string** | Currency code (e.g., \"usd\"). | [default to undefined]
+**monthly_price** | **number** | Monthly price in cents (null for free/enterprise). | [optional] [default to undefined]
+**tier** | **string** | Plan tier label. | [default to undefined]
+
+## Example
+
+```typescript
+import { PriceInfo } from '@enbbox/api';
+
+const instance: PriceInfo = {
+    annual_price,
+    currency,
+    monthly_price,
+    tier,
+};
+```
+
+[[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/Prices.md

@@ -0,0 +1,21 @@
+# Prices
+
+Available plan prices.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prices** | [**Array<PriceInfo>**](PriceInfo.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Prices } from '@enbbox/api';
+
+const instance: Prices = {
+    prices,
+};
+```
+
+[[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/ProjectRecord.md

@@ -0,0 +1,27 @@
+# ProjectRecord
+
+Full project record with branding and service tier info.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branding** | [**Branding**](Branding.md) | Branding configuration. | [optional] [default to undefined]
+**id** | **string** | Project UUID. | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+**plan** | [**Plan**](Plan.md) | Billing plan. | [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectRecord } from '@enbbox/api';
+
+const instance: ProjectRecord = {
+    branding,
+    id,
+    name,
+    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)