@enbbox/api 1.0.0 → 1.0.1

package/docs/TranslationsApi.md

@@ -0,0 +1,258 @@
+# TranslationsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createTranslationGroup**](#createtranslationgroup) | **POST** /v1/translations/groups/ | POST /v1/translations/groups — create a translation group.|
+|[**deleteTranslationGroup**](#deletetranslationgroup) | **DELETE** /v1/translations/groups/{id}/ | DELETE /v1/translations/groups/:id — soft-delete a translation group.|
+|[**getTranslationGroup**](#gettranslationgroup) | **GET** /v1/translations/groups/{id}/ | GET /v1/translations/groups/:id — get a translation group.|
+|[**listTranslationGroups**](#listtranslationgroups) | **GET** /v1/translations/groups/ | GET /v1/translations/groups — list translation groups.|
+|[**updateTranslationGroup**](#updatetranslationgroup) | **PATCH** /v1/translations/groups/{id}/ | PATCH /v1/translations/groups/:id — update a translation group.|
+
+# **createTranslationGroup**
+> createTranslationGroup(body)
+
+
+### Example
+
+```typescript
+import {
+    TranslationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TranslationsApi(configuration);
+
+let body: any; //
+
+const { status, data } = await apiInstance.createTranslationGroup(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+
+[[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)
+
+# **deleteTranslationGroup**
+> deleteTranslationGroup()
+
+
+### Example
+
+```typescript
+import {
+    TranslationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TranslationsApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteTranslationGroup(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getTranslationGroup**
+> getTranslationGroup()
+
+
+### Example
+
+```typescript
+import {
+    TranslationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TranslationsApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+
+const { status, data } = await apiInstance.getTranslationGroup(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group 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** | OK |  -  |
+
+[[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)
+
+# **listTranslationGroups**
+> listTranslationGroups()
+
+
+### Example
+
+```typescript
+import {
+    TranslationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TranslationsApi(configuration);
+
+const { status, data } = await apiInstance.listTranslationGroups();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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** | OK |  -  |
+
+[[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)
+
+# **updateTranslationGroup**
+> updateTranslationGroup(body)
+
+
+### Example
+
+```typescript
+import {
+    TranslationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TranslationsApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+let body: any; //
+
+const { status, data } = await apiInstance.updateTranslationGroup(
+    id,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**|  | |
+| **id** | [**string**] | Group ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Updated |  -  |
+
+[[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/TrialInfo.md

@@ -0,0 +1,27 @@
+# TrialInfo
+
+Trial status information.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days_total** | **number** | Days remaining in the trial. | [default to undefined]
+**end** | **string** | Trial end date (ISO 8601). | [optional] [default to undefined]
+**is_active** | **boolean** | Whether the trial is currently active. | [default to undefined]
+**start** | **string** | Trial start date (ISO 8601). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TrialInfo } from '@enbbox/api';
+
+const instance: TrialInfo = {
+    days_total,
+    end,
+    is_active,
+    start,
+};
+```
+
+[[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/TriggerEvent.md

@@ -0,0 +1,31 @@
+# TriggerEvent
+
+Trigger a notification workflow. Sends notifications through the configured channels (email, SMS, push, etc.) to the specified recipients.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**context** | **object** | Context data for template personalization. Keys are context types (e.g. `tenant`, `region`). Values can be a string ID (resolved from store) or an object with `id` and optional `data`. Available in templates as `{{ context.type.data.field }}`. | [default to undefined]
+**name** | **string** | Workflow identifier — must match the `identifier` field of an existing workflow. | [default to undefined]
+**overrides** | **object** | Per-provider overrides (e.g. custom sender, priority). Keys are provider IDs. | [default to undefined]
+**payload** | **object** | Template variables available inside {{handlebar}} expressions. | [default to undefined]
+**to** | [**TriggerRecipients**](TriggerRecipients.md) | Recipient specification — a single subscriber ID, multiple IDs, inline subscriber data, or a topic key. | [default to undefined]
+**transaction_id** | **string** | Client-generated idempotency key. Duplicate `transaction_id` values within 24 h are silently ignored. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TriggerEvent } from '@enbbox/api';
+
+const instance: TriggerEvent = {
+    context,
+    name,
+    overrides,
+    payload,
+    to,
+    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/TriggerRecipients.md

@@ -0,0 +1,39 @@
+# TriggerRecipients
+
+Flexible recipient targeting: a subscriber ID string, an array of IDs, an inline subscriber object, or a topic fan-out key.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic_key** | **string** |  | [default to undefined]
+**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 { TriggerRecipients } from '@enbbox/api';
+
+const instance: TriggerRecipients = {
+    topic_key,
+    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/TriggerRecipientsOneOf.md

@@ -0,0 +1,21 @@
+# TriggerRecipientsOneOf
+
+Topic fan-out: `{\"topic_key\": \"my-topic\"}`
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic_key** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TriggerRecipientsOneOf } from '@enbbox/api';
+
+const instance: TriggerRecipientsOneOf = {
+    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/TriggerResult.md

@@ -0,0 +1,25 @@
+# TriggerResult
+
+Acknowledgement returned after a trigger event is accepted by the system.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acknowledged** | **boolean** | Whether the event was accepted for processing. | [default to undefined]
+**status** | [**TriggerStatus**](TriggerStatus.md) | Processing status of the trigger. | [default to undefined]
+**transaction_id** | **string** | Unique transaction identifier for tracking this trigger. | [default to undefined]
+
+## Example
+
+```typescript
+import { TriggerResult } from '@enbbox/api';
+
+const instance: TriggerResult = {
+    acknowledged,
+    status,
+    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/TriggerStatus.md

@@ -0,0 +1,21 @@
+# TriggerStatus
+
+Status of a trigger event processing.
+
+## Enum
+
+* `Processed` (value: `'processed'`)
+
+* `Error` (value: `'error'`)
+
+* `TriggerNotActive` (value: `'trigger_not_active'`)
+
+* `NoWorkflowActiveSteps` (value: `'no_workflow_active_steps'`)
+
+* `NoWorkflowSteps` (value: `'no_workflow_steps'`)
+
+* `TenantMissing` (value: `'tenant_missing'`)
+
+* `InvalidRecipients` (value: `'invalid_recipients'`)
+
+[[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/UnseenCount.md

@@ -0,0 +1,21 @@
+# UnseenCount
+
+Count of unseen inbox notifications.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UnseenCount } from '@enbbox/api';
+
+const instance: UnseenCount = {
+    count,
+};
+```
+
+[[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/UpdateChannelConnection.md

@@ -0,0 +1,21 @@
+# UpdateChannelConnection
+
+Partial update of a channel connection.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credentials** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateChannelConnection } from '@enbbox/api';
+
+const instance: UpdateChannelConnection = {
+    credentials,
+};
+```
+
+[[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/UpdateChannelEndpoint.md

@@ -0,0 +1,23 @@
+# UpdateChannelEndpoint
+
+Partial update of a channel endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **object** |  | [optional] [default to undefined]
+**target** | **string** | Delivery target (token, URL, address). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateChannelEndpoint } from '@enbbox/api';
+
+const instance: UpdateChannelEndpoint = {
+    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/UpdateContext.md

@@ -0,0 +1,21 @@
+# UpdateContext
+
+Partial update of a context\'s data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **object** | Updated context data (replaces existing data). | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateContext } from '@enbbox/api';
+
+const instance: UpdateContext = {
+    data,
+};
+```
+
+[[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/UpdateInboxPreferences.md

@@ -0,0 +1,29 @@
+# UpdateInboxPreferences
+
+Update subscriber inbox preferences.
+
+## 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 { UpdateInboxPreferences } from '@enbbox/api';
+
+const instance: UpdateInboxPreferences = {
+    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/UpdateIntegration.md

@@ -0,0 +1,27 @@
+# UpdateIntegration
+
+Partial update of an existing provider integration. Only provided fields are changed.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Updated active status. | [optional] [default to undefined]
+**conditions** | **object** | Updated routing conditions. | [default to undefined]
+**credentials** | **object** | Updated credentials. | [default to undefined]
+**name** | **string** | Updated display name. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateIntegration } from '@enbbox/api';
+
+const instance: UpdateIntegration = {
+    active,
+    conditions,
+    credentials,
+    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/UpdateLayout.md

@@ -0,0 +1,27 @@
+# UpdateLayout
+
+Update a layout template.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** | Display name. | [optional] [default to undefined]
+**variables** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateLayout } from '@enbbox/api';
+
+const instance: UpdateLayout = {
+    content,
+    description,
+    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/UpdateNotificationGroup.md

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

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

@@ -0,0 +1,23 @@
+# UpdateProject
+
+Partial update of a project\'s name or branding settings.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branding** | [**Branding**](Branding.md) | Branding configuration (logo, colors, fonts) for white-label notification UIs. | [optional] [default to undefined]
+**name** | **string** | Updated project display name. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProject } from '@enbbox/api';
+
+const instance: UpdateProject = {
+    branding,
+    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)