@enbbox/api 1.0.0 → 1.1.0

package/docs/BillingApi.md

@@ -0,0 +1,375 @@
+# BillingApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createCheckoutSession**](#createcheckoutsession) | **POST** /v1/billing/checkout-session/ | Create a Stripe Checkout Session for upgrading a plan.|
+|[**getBillingLimits**](#getbillinglimits) | **GET** /v1/billing/limits/ | Get plan limits and current usage for the project.|
+|[**getBillingSubscription**](#getbillingsubscription) | **GET** /v1/billing/subscription/ | Get the current subscription for the authed project.|
+|[**getEntitlements**](#getentitlements) | **GET** /v1/billing/entitlements/ | Get active entitlements for the project.|
+|[**getPortalUrl**](#getportalurl) | **GET** /v1/billing/portal/ | Get a Stripe Customer Portal URL for managing the subscription.|
+|[**getPrices**](#getprices) | **GET** /v1/billing/prices/ | Get available plan prices.|
+|[**getUsage**](#getusage) | **GET** /v1/billing/usage/ | Get current usage data for the project.|
+|[**stripeWebhook**](#stripewebhook) | **POST** /v1/billing/webhooks/stripe/ | Handle Stripe webhook events.|
+
+# **createCheckoutSession**
+> CheckoutSession createCheckoutSession(createCheckout)
+
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration,
+    CreateCheckout
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let createCheckout: CreateCheckout; //
+
+const { status, data } = await apiInstance.createCheckoutSession(
+    createCheckout
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCheckout** | **CreateCheckout**|  | |
+
+
+### Return type
+
+**CheckoutSession**
+
+### 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)
+
+# **getBillingLimits**
+> PlanLimitsResponse getBillingLimits()
+
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getBillingLimits();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**PlanLimitsResponse**
+
+### 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)
+
+# **getBillingSubscription**
+> Subscription getBillingSubscription()
+
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getBillingSubscription();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Subscription**
+
+### 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)
+
+# **getEntitlements**
+> Entitlements getEntitlements()
+
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getEntitlements();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Entitlements**
+
+### 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)
+
+# **getPortalUrl**
+> PortalUrl getPortalUrl()
+
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getPortalUrl();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**PortalUrl**
+
+### 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)
+
+# **getPrices**
+> Prices getPrices()
+
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getPrices();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Prices**
+
+### 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)
+
+# **getUsage**
+> Usage getUsage()
+
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getUsage();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Usage**
+
+### 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)
+
+# **stripeWebhook**
+> stripeWebhook(body)
+
+This endpoint is NOT authenticated via JWT — it\'s verified via Stripe webhook signature (HMAC-SHA256). Stripe expects a 2xx with an empty body.
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let body: string; //
+
+const { status, data } = await apiInstance.stripeWebhook(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Event processed |  -  |
+
+[[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/BillingInterval.md

@@ -0,0 +1,11 @@
+# BillingInterval
+
+Billing interval for paid plans.
+
+## Enum
+
+* `Month` (value: `'month'`)
+
+* `Year` (value: `'year'`)
+
+[[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/Branding.md

@@ -0,0 +1,31 @@
+# Branding
+
+White-label branding for notification center and email templates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**color** | **string** | Primary brand color (hex). | [default to undefined]
+**content_background** | **string** | Background color for content area (hex). | [optional] [default to undefined]
+**direction** | **string** | Text direction: `ltr` or `rtl`. | [optional] [default to undefined]
+**font_color** | **string** | Text color override (hex). | [optional] [default to undefined]
+**font_family** | **string** | Font family for notification UI. | [optional] [default to undefined]
+**logo** | **string** | URL of the brand logo. | [default to undefined]
+
+## Example
+
+```typescript
+import { Branding } from '@enbbox/api';
+
+const instance: Branding = {
+    color,
+    content_background,
+    direction,
+    font_color,
+    font_family,
+    logo,
+};
+```
+
+[[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/BroadcastTrigger.md

@@ -0,0 +1,27 @@
+# BroadcastTrigger
+
+Trigger a broadcast notification to a topic or segment.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Display name. | [default to undefined]
+**overrides** | **object** |  | [default to undefined]
+**payload** | **object** |  | [default to undefined]
+**transaction_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BroadcastTrigger } from '@enbbox/api';
+
+const instance: BroadcastTrigger = {
+    name,
+    overrides,
+    payload,
+    transaction_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/BulkCreateSubscribers.md

@@ -0,0 +1,21 @@
+# BulkCreateSubscribers
+
+Batch-create multiple subscribers in one request.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscribers** | [**Array<CreateSubscriber>**](CreateSubscriber.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkCreateSubscribers } from '@enbbox/api';
+
+const instance: BulkCreateSubscribers = {
+    subscribers,
+};
+```
+
+[[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/BulkPreferenceItem.md

@@ -0,0 +1,24 @@
+# BulkPreferenceItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channels** | [**PreferenceChannels**](PreferenceChannels.md) |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**workflow_id** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkPreferenceItem } from '@enbbox/api';
+
+const instance: BulkPreferenceItem = {
+    channels,
+    enabled,
+    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/BulkPreferences.md

@@ -0,0 +1,21 @@
+# BulkPreferences
+
+Bulk-update subscriber notification preferences.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preferences** | [**Array<BulkPreferenceItem>**](BulkPreferenceItem.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkPreferences } from '@enbbox/api';
+
+const instance: BulkPreferences = {
+    preferences,
+};
+```
+
+[[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/BulkResult.md

@@ -0,0 +1,22 @@
+# BulkResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | [**Array<SubscriberRecord>**](SubscriberRecord.md) |  | [default to undefined]
+**failed** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkResult } from '@enbbox/api';
+
+const instance: BulkResult = {
+    created,
+    failed,
+};
+```
+
+[[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/BulkTrigger.md

@@ -0,0 +1,21 @@
+# BulkTrigger
+
+Batch multiple trigger events into one API call for efficient bulk processing.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<TriggerEvent>**](TriggerEvent.md) | Array of trigger events to process. | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkTrigger } from '@enbbox/api';
+
+const instance: BulkTrigger = {
+    events,
+};
+```
+
+[[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/ChannelConnectionRecord.md

@@ -0,0 +1,31 @@
+# ChannelConnectionRecord
+
+A channel connection linking a subscriber to a provider with stored credentials.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**credentials** | **object** |  | [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**identifier** | **string** | Unique slug identifier. | [default to undefined]
+**provider_id** | **string** | Provider identifier. | [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+
+## Example
+
+```typescript
+import { ChannelConnectionRecord } from '@enbbox/api';
+
+const instance: ChannelConnectionRecord = {
+    created_at,
+    credentials,
+    id,
+    identifier,
+    provider_id,
+    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)