@enbbox/api 1.0.0 → 1.0.1

package/docs/NotificationsApi.md

@@ -0,0 +1,166 @@
+# NotificationsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getNotification**](#getnotification) | **GET** /v1/notifications/{id}/ | GET /v1/notifications/:id|
+|[**getNotificationJobs**](#getnotificationjobs) | **GET** /v1/notifications/{id}/jobs/ | GET /v1/notifications/:id/jobs|
+|[**listNotifications**](#listnotifications) | **GET** /v1/notifications/ | GET /v1/notifications|
+
+# **getNotification**
+> NotificationLog getNotification()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let id: string; //Notification ID (default to undefined)
+
+const { status, data } = await apiInstance.getNotification(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Notification ID | defaults to undefined|
+
+
+### Return type
+
+**NotificationLog**
+
+### 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)
+
+# **getNotificationJobs**
+> Array<JobLog> getNotificationJobs()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let id: string; //Notification ID (default to undefined)
+
+const { status, data } = await apiInstance.getNotificationJobs(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Notification ID | defaults to undefined|
+
+
+### Return type
+
+**Array<JobLog>**
+
+### 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)
+
+# **listNotifications**
+> Array<NotificationLog> listNotifications()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let limit: number; //Maximum number of items per page (1–100, default: 10). (optional) (default to undefined)
+let page: number; //Zero-based page index (default: 0). (optional) (default to undefined)
+let q: string; //Optional full-text search query (e.g. subscriber_id, transaction_id). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listNotifications(
+    limit,
+    page,
+    q
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of items per page (1–100, default: 10). | (optional) defaults to undefined|
+| **page** | [**number**] | Zero-based page index (default: 0). | (optional) defaults to undefined|
+| **q** | [**string**] | Optional full-text search query (e.g. subscriber_id, transaction_id). | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<NotificationLog>**
+
+### 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)
+

package/docs/OffsetMeta.md

@@ -0,0 +1,27 @@
+# OffsetMeta
+
+Metadata about the current page in an offset-paginated response.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **boolean** | Whether more items exist beyond this page. | [default to undefined]
+**limit** | **number** | Current page size. | [default to undefined]
+**offset** | **number** | Current offset. | [default to undefined]
+**total** | **number** | Total number of items across all pages. | [default to undefined]
+
+## Example
+
+```typescript
+import { OffsetMeta } from '@enbbox/api';
+
+const instance: OffsetMeta = {
+    has_more,
+    limit,
+    offset,
+    total,
+};
+```
+
+[[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/OffsetPagination.md

@@ -0,0 +1,27 @@
+# OffsetPagination
+
+Standard offset-based pagination for countable resources.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter_by** | **string** | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. | [optional] [default to undefined]
+**limit** | **number** | Maximum number of items to return (1–100, default: 10). | [optional] [default to undefined]
+**offset** | **number** | Number of items to skip before returning results (default: 0). | [optional] [default to undefined]
+**q** | **string** | Optional full-text search query. When present, listing is powered by Typesense full-text search. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OffsetPagination } from '@enbbox/api';
+
+const instance: OffsetPagination = {
+    filter_by,
+    limit,
+    offset,
+    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/OnlineStatus.md

@@ -0,0 +1,21 @@
+# OnlineStatus
+
+Subscriber online/offline presence status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_online** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { OnlineStatus } from '@enbbox/api';
+
+const instance: OnlineStatus = {
+    is_online,
+};
+```
+
+[[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/PaginatedChannelConnectionRecord.md

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

@@ -0,0 +1,31 @@
+# PaginatedChannelConnectionRecordDataInner
+
+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 { PaginatedChannelConnectionRecordDataInner } from '@enbbox/api';
+
+const instance: PaginatedChannelConnectionRecordDataInner = {
+    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)

package/docs/PaginatedChannelEndpointRecord.md

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

@@ -0,0 +1,33 @@
+# PaginatedChannelEndpointRecordDataInner
+
+A channel endpoint for push/chat/webhook delivery.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channel_connection_id** | **string** | Parent channel connection UUID. | [default to undefined]
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**endpoint_type** | **string** | Endpoint type (e.g. device_token, webhook_url). | [default to undefined]
+**id** | **string** | Unique identifier. | [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 { PaginatedChannelEndpointRecordDataInner } from '@enbbox/api';
+
+const instance: PaginatedChannelEndpointRecordDataInner = {
+    channel_connection_id,
+    created_at,
+    endpoint_type,
+    id,
+    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/PaginatedContextRecord.md

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

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

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

@@ -0,0 +1,35 @@
+# PaginatedIntegrationRecordDataInner
+
+A configured provider integration with its routing priority and status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Whether the integration is active and available for routing. | [default to undefined]
+**channel** | [**ChannelType**](ChannelType.md) | Channel this integration serves. | [default to undefined]
+**id** | **string** | Integration UUID. | [default to undefined]
+**identifier** | **string** | Unique slug identifier for API references. | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+**primary** | **boolean** | Whether this is the primary integration for its channel. | [default to undefined]
+**priority** | **number** | Routing priority (lower = higher priority). | [default to undefined]
+**provider_id** | **string** | Provider identifier. | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedIntegrationRecordDataInner } from '@enbbox/api';
+
+const instance: PaginatedIntegrationRecordDataInner = {
+    active,
+    channel,
+    id,
+    identifier,
+    name,
+    primary,
+    priority,
+    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/PaginatedLayoutRecord.md

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

@@ -0,0 +1,31 @@
+# PaginatedLayoutRecordDataInner
+
+A layout template wrapping notification content.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**identifier** | **string** | Unique slug identifier. | [default to undefined]
+**is_default** | **boolean** |  | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedLayoutRecordDataInner } from '@enbbox/api';
+
+const instance: PaginatedLayoutRecordDataInner = {
+    content,
+    description,
+    id,
+    identifier,
+    is_default,
+    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/PaginatedSubscriberRecord.md

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

@@ -0,0 +1,41 @@
+# PaginatedSubscriberRecordDataInner
+
+Full subscriber profile as stored in the system.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**avatar** | **string** | Avatar URL. | [optional] [default to undefined]
+**credentials** | [**Array<SubscriberCredential>**](SubscriberCredential.md) | Push/chat provider credentials for this subscriber. | [optional] [default to undefined]
+**email** | **string** | Email address. | [optional] [default to undefined]
+**first_name** | **string** | First name. | [optional] [default to undefined]
+**id** | **string** | Internal UUID assigned by the system. | [default to undefined]
+**is_online** | **boolean** | Whether the subscriber is currently connected via SSE/WebSocket. | [optional] [default to undefined]
+**last_name** | **string** | Last name. | [optional] [default to undefined]
+**last_online_at** | **string** | ISO 8601 timestamp of when the subscriber was last seen online. | [optional] [default to undefined]
+**locale** | **string** | Locale tag. | [optional] [default to undefined]
+**phone** | **string** | Phone number. | [optional] [default to undefined]
+**subscriber_id** | **string** | Your unique subscriber identifier. | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedSubscriberRecordDataInner } from '@enbbox/api';
+
+const instance: PaginatedSubscriberRecordDataInner = {
+    avatar,
+    credentials,
+    email,
+    first_name,
+    id,
+    is_online,
+    last_name,
+    last_online_at,
+    locale,
+    phone,
+    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/PaginatedTopicRecord.md

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

@@ -0,0 +1,24 @@
+# PaginatedTopicRecordDataInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Topic key. | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+**subscribers** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedTopicRecordDataInner } from '@enbbox/api';
+
+const instance: PaginatedTopicRecordDataInner = {
+    key,
+    name,
+    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/PaginatedTopicSubscriptionRecord.md

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