@enbbox/api 1.0.0 → 1.1.0

package/docs/CheckoutSession.md

@@ -0,0 +1,23 @@
+# CheckoutSession
+
+Stripe Checkout session created for an upgrade.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plan** | [**Plan**](Plan.md) | The plan being subscribed to. | [default to undefined]
+**stripe_checkout_url** | **string** | URL to redirect the user to for Stripe Checkout. | [default to undefined]
+
+## Example
+
+```typescript
+import { CheckoutSession } from '@enbbox/api';
+
+const instance: CheckoutSession = {
+    plan,
+    stripe_checkout_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/ContextRecord.md

@@ -0,0 +1,29 @@
+# ContextRecord
+
+A context providing typed data to notification templates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**data** | **object** | Context data. | [default to undefined]
+**id** | **string** | Context identifier. | [default to undefined]
+**type** | **string** | Context type. | [default to undefined]
+**updated_at** | **string** | ISO 8601 last-modified timestamp. | [default to undefined]
+
+## Example
+
+```typescript
+import { ContextRecord } from '@enbbox/api';
+
+const instance: ContextRecord = {
+    created_at,
+    data,
+    id,
+    type,
+    updated_at,
+};
+```
+
+[[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/ContextsApi.md

@@ -0,0 +1,285 @@
+# ContextsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createContext**](#createcontext) | **POST** /v1/contexts/ | POST /v1/contexts|
+|[**deleteContext**](#deletecontext) | **DELETE** /v1/contexts/{type}/{id}/ | DELETE /v1/contexts/:type/:id|
+|[**getContext**](#getcontext) | **GET** /v1/contexts/{type}/{id}/ | GET /v1/contexts/:type/:id|
+|[**listContexts**](#listcontexts) | **GET** /v1/contexts/ | GET /v1/contexts — list contexts|
+|[**updateContext**](#updatecontext) | **PATCH** /v1/contexts/{type}/{id}/ | PATCH /v1/contexts/:type/:id|
+
+# **createContext**
+> ContextRecord createContext(createContext)
+
+
+### Example
+
+```typescript
+import {
+    ContextsApi,
+    Configuration,
+    CreateContext
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ContextsApi(configuration);
+
+let createContext: CreateContext; //
+
+const { status, data } = await apiInstance.createContext(
+    createContext
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createContext** | **CreateContext**|  | |
+
+
+### Return type
+
+**ContextRecord**
+
+### 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)
+
+# **deleteContext**
+> deleteContext()
+
+
+### Example
+
+```typescript
+import {
+    ContextsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ContextsApi(configuration);
+
+let type: string; // (default to undefined)
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteContext(
+    type,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **type** | [**string**] |  | defaults to undefined|
+| **id** | [**string**] |  | 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 |
+|-------------|-------------|------------------|
+|**204** | 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)
+
+# **getContext**
+> ContextRecord getContext()
+
+
+### Example
+
+```typescript
+import {
+    ContextsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ContextsApi(configuration);
+
+let type: string; //Context type (default to undefined)
+let id: string; //Context ID (default to undefined)
+
+const { status, data } = await apiInstance.getContext(
+    type,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **type** | [**string**] | Context type | defaults to undefined|
+| **id** | [**string**] | Context ID | defaults to undefined|
+
+
+### Return type
+
+**ContextRecord**
+
+### 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)
+
+# **listContexts**
+> PaginatedContextRecord listContexts()
+
+
+### Example
+
+```typescript
+import {
+    ContextsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ContextsApi(configuration);
+
+let limit: number; //Maximum number of items to return (1–100, default: 10). (optional) (default to undefined)
+let offset: number; //Number of items to skip before returning results (default: 0). (optional) (default to undefined)
+let q: string; //Optional full-text search query. When present, listing is powered by Typesense full-text search. (optional) (default to undefined)
+let filterBy: string; //Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listContexts(
+    limit,
+    offset,
+    q,
+    filterBy
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of items to return (1–100, default: 10). | (optional) defaults to undefined|
+| **offset** | [**number**] | Number of items to skip before returning results (default: 0). | (optional) defaults to undefined|
+| **q** | [**string**] | Optional full-text search query. When present, listing is powered by Typesense full-text search. | (optional) defaults to undefined|
+| **filterBy** | [**string**] | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedContextRecord**
+
+### 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)
+
+# **updateContext**
+> ContextRecord updateContext(updateContext)
+
+
+### Example
+
+```typescript
+import {
+    ContextsApi,
+    Configuration,
+    UpdateContext
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ContextsApi(configuration);
+
+let type: string; // (default to undefined)
+let id: string; // (default to undefined)
+let updateContext: UpdateContext; //
+
+const { status, data } = await apiInstance.updateContext(
+    type,
+    id,
+    updateContext
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateContext** | **UpdateContext**|  | |
+| **type** | [**string**] |  | defaults to undefined|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ContextRecord**
+
+### 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/CreateChannelConnection.md

@@ -0,0 +1,27 @@
+# CreateChannelConnection
+
+Create a channel connection linking a subscriber to a delivery provider.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credentials** | **object** |  | [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 { CreateChannelConnection } from '@enbbox/api';
+
+const instance: CreateChannelConnection = {
+    credentials,
+    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)

package/docs/CreateChannelEndpoint.md

@@ -0,0 +1,29 @@
+# CreateChannelEndpoint
+
+Register a channel endpoint (device token, webhook URL) for delivery.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channel_connection_id** | **string** | Parent channel connection UUID. | [default to undefined]
+**endpoint_type** | **string** | Endpoint type (e.g. device_token, webhook_url). | [default to undefined]
+**identifier** | **string** | Unique slug identifier. | [default to undefined]
+**metadata** | **object** |  | [optional] [default to undefined]
+**target** | **string** | Delivery target (token, URL, address). | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateChannelEndpoint } from '@enbbox/api';
+
+const instance: CreateChannelEndpoint = {
+    channel_connection_id,
+    endpoint_type,
+    identifier,
+    metadata,
+    target,
+};
+```
+
+[[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/CreateCheckout.md

@@ -0,0 +1,23 @@
+# CreateCheckout
+
+Request to create a Stripe Checkout session.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billing_interval** | **string** | Billing interval: \"month\" or \"year\". | [default to undefined]
+**plan** | [**Plan**](Plan.md) | The plan to subscribe to. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCheckout } from '@enbbox/api';
+
+const instance: CreateCheckout = {
+    billing_interval,
+    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/CreateContext.md

@@ -0,0 +1,25 @@
+# CreateContext
+
+Create a context — typed key-value data available inside notification templates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **object** | Context data accessible in templates via `{{context.type.data.field}}`. | [default to undefined]
+**id** | **string** | Unique context ID within the type (e.g. `acme-corp`). | [default to undefined]
+**type** | **string** | Context type/category (e.g. `tenant`, `app`, `region`). | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateContext } from '@enbbox/api';
+
+const instance: CreateContext = {
+    data,
+    id,
+    type,
+};
+```
+
+[[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/CreateIntegration.md

@@ -0,0 +1,31 @@
+# CreateIntegration
+
+Register a delivery provider integration. Each integration connects a provider (e.g. SendGrid) to a channel (e.g. email).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Whether this integration is active and available for routing. Defaults to `true`. | [optional] [default to undefined]
+**channel** | [**ChannelType**](ChannelType.md) | Channel this integration serves. | [default to undefined]
+**conditions** | **object** | Routing conditions — JSON rules that control when this integration is selected. | [default to undefined]
+**credentials** | **object** | Provider-specific credentials (API keys, tokens, secrets). | [default to undefined]
+**name** | **string** | Human-readable display name for this integration. | [default to undefined]
+**provider_id** | **string** | Provider identifier string (e.g. `sendgrid`, `twilio`, `fcm`). | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateIntegration } from '@enbbox/api';
+
+const instance: CreateIntegration = {
+    active,
+    channel,
+    conditions,
+    credentials,
+    name,
+    provider_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/CreateLayout.md

@@ -0,0 +1,31 @@
+# CreateLayout
+
+Create a notification layout template (e.g. email wrapper).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**identifier** | **string** | Unique slug identifier. | [default to undefined]
+**is_default** | **boolean** |  | [optional] [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+**variables** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateLayout } from '@enbbox/api';
+
+const instance: CreateLayout = {
+    content,
+    description,
+    identifier,
+    is_default,
+    name,
+    variables,
+};
+```
+
+[[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/CreateNotificationGroup.md

@@ -0,0 +1,21 @@
+# CreateNotificationGroup
+
+Create a notification group to categorize workflows.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Display name. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateNotificationGroup } from '@enbbox/api';
+
+const instance: CreateNotificationGroup = {
+    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/CreateProject.md

@@ -0,0 +1,21 @@
+# CreateProject
+
+Create a new project.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Project display name. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateProject } from '@enbbox/api';
+
+const instance: CreateProject = {
+    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/CreateSubscriber.md

@@ -0,0 +1,37 @@
+# CreateSubscriber
+
+Create or upsert a subscriber (notification recipient). The `subscriber_id` is your unique key for this user.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**avatar** | **string** | URL to the subscriber\'s avatar image. | [optional] [default to undefined]
+**data** | **object** | Arbitrary key-value metadata attached to this subscriber. | [default to undefined]
+**email** | **string** | Subscriber\'s email address, used for email channel delivery. | [optional] [default to undefined]
+**first_name** | **string** | Subscriber\'s first (given) name. | [optional] [default to undefined]
+**last_name** | **string** | Subscriber\'s last (family) name. | [optional] [default to undefined]
+**locale** | **string** | IETF BCP 47 locale tag for localized content delivery. | [optional] [default to undefined]
+**phone** | **string** | Subscriber\'s phone number in E.164 format, used for SMS channel delivery. | [optional] [default to undefined]
+**subscriber_id** | **string** | Unique identifier for this subscriber in your system (e.g. user ID). | [default to undefined]
+**timezone** | **string** | IANA timezone identifier for time-aware scheduling. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateSubscriber } from '@enbbox/api';
+
+const instance: CreateSubscriber = {
+    avatar,
+    data,
+    email,
+    first_name,
+    last_name,
+    locale,
+    phone,
+    subscriber_id,
+    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/CreateSubscription.md

@@ -0,0 +1,21 @@
+# CreateSubscription
+
+Subscribe a subscriber to a topic.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscribers** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateSubscription } from '@enbbox/api';
+
+const instance: CreateSubscription = {
+    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/CreateTopic.md

@@ -0,0 +1,23 @@
+# CreateTopic
+
+Create a topic for subscriber fan-out notifications.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Topic key. | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateTopic } from '@enbbox/api';
+
+const instance: CreateTopic = {
+    key,
+    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/CreateWebhook.md

@@ -0,0 +1,23 @@
+# CreateWebhook
+
+Register a new webhook endpoint to receive event callbacks.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | **Array<string>** | Event types this webhook subscribes to. | [optional] [default to undefined]
+**url** | **string** | Webhook callback URL. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateWebhook } from '@enbbox/api';
+
+const instance: CreateWebhook = {
+    events,
+    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)