@enbbox/api 1.0.0 → 1.1.0

package/docs/ChannelConnectionsApi.md

@@ -0,0 +1,276 @@
+# ChannelConnectionsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createConnection**](#createconnection) | **POST** /v1/channel-connections/ | POST /v1/channel-connections|
+|[**deleteConnection**](#deleteconnection) | **DELETE** /v1/channel-connections/{id}/ | DELETE /v1/channel-connections/:identifier|
+|[**getConnection**](#getconnection) | **GET** /v1/channel-connections/{id}/ | GET /v1/channel-connections/:identifier|
+|[**listConnections**](#listconnections) | **GET** /v1/channel-connections/ | GET /v1/channel-connections|
+|[**updateConnection**](#updateconnection) | **PATCH** /v1/channel-connections/{id}/ | PATCH /v1/channel-connections/:identifier|
+
+# **createConnection**
+> ChannelConnectionRecord createConnection(createChannelConnection)
+
+
+### Example
+
+```typescript
+import {
+    ChannelConnectionsApi,
+    Configuration,
+    CreateChannelConnection
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelConnectionsApi(configuration);
+
+let createChannelConnection: CreateChannelConnection; //
+
+const { status, data } = await apiInstance.createConnection(
+    createChannelConnection
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createChannelConnection** | **CreateChannelConnection**|  | |
+
+
+### Return type
+
+**ChannelConnectionRecord**
+
+### 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)
+
+# **deleteConnection**
+> deleteConnection()
+
+
+### Example
+
+```typescript
+import {
+    ChannelConnectionsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelConnectionsApi(configuration);
+
+let id: string; //Channel connection ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteConnection(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Channel connection 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)
+
+# **getConnection**
+> ChannelConnectionRecord getConnection()
+
+
+### Example
+
+```typescript
+import {
+    ChannelConnectionsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelConnectionsApi(configuration);
+
+let id: string; //Channel connection ID (default to undefined)
+
+const { status, data } = await apiInstance.getConnection(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Channel connection ID | defaults to undefined|
+
+
+### Return type
+
+**ChannelConnectionRecord**
+
+### 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)
+
+# **listConnections**
+> PaginatedChannelConnectionRecord listConnections()
+
+
+### Example
+
+```typescript
+import {
+    ChannelConnectionsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelConnectionsApi(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.listConnections(
+    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
+
+**PaginatedChannelConnectionRecord**
+
+### 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)
+
+# **updateConnection**
+> ChannelConnectionRecord updateConnection(updateChannelConnection)
+
+
+### Example
+
+```typescript
+import {
+    ChannelConnectionsApi,
+    Configuration,
+    UpdateChannelConnection
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelConnectionsApi(configuration);
+
+let id: string; //Channel connection ID (default to undefined)
+let updateChannelConnection: UpdateChannelConnection; //
+
+const { status, data } = await apiInstance.updateConnection(
+    id,
+    updateChannelConnection
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateChannelConnection** | **UpdateChannelConnection**|  | |
+| **id** | [**string**] | Channel connection ID | defaults to undefined|
+
+
+### Return type
+
+**ChannelConnectionRecord**
+
+### 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/ChannelEndpointRecord.md

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

@@ -0,0 +1,276 @@
+# ChannelEndpointsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEndpoint**](#createendpoint) | **POST** /v1/channel-endpoints/ | POST /v1/channel-endpoints|
+|[**deleteEndpoint**](#deleteendpoint) | **DELETE** /v1/channel-endpoints/{id}/ | DELETE /v1/channel-endpoints/:identifier|
+|[**getEndpoint**](#getendpoint) | **GET** /v1/channel-endpoints/{id}/ | GET /v1/channel-endpoints/:identifier|
+|[**listEndpoints**](#listendpoints) | **GET** /v1/channel-endpoints/ | GET /v1/channel-endpoints|
+|[**updateEndpoint**](#updateendpoint) | **PATCH** /v1/channel-endpoints/{id}/ | PATCH /v1/channel-endpoints/:identifier|
+
+# **createEndpoint**
+> ChannelEndpointRecord createEndpoint(createChannelEndpoint)
+
+
+### Example
+
+```typescript
+import {
+    ChannelEndpointsApi,
+    Configuration,
+    CreateChannelEndpoint
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelEndpointsApi(configuration);
+
+let createChannelEndpoint: CreateChannelEndpoint; //
+
+const { status, data } = await apiInstance.createEndpoint(
+    createChannelEndpoint
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createChannelEndpoint** | **CreateChannelEndpoint**|  | |
+
+
+### Return type
+
+**ChannelEndpointRecord**
+
+### 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)
+
+# **deleteEndpoint**
+> deleteEndpoint()
+
+
+### Example
+
+```typescript
+import {
+    ChannelEndpointsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelEndpointsApi(configuration);
+
+let id: string; //Channel endpoint ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteEndpoint(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Channel endpoint 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)
+
+# **getEndpoint**
+> ChannelEndpointRecord getEndpoint()
+
+
+### Example
+
+```typescript
+import {
+    ChannelEndpointsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelEndpointsApi(configuration);
+
+let id: string; //Channel endpoint ID (default to undefined)
+
+const { status, data } = await apiInstance.getEndpoint(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Channel endpoint ID | defaults to undefined|
+
+
+### Return type
+
+**ChannelEndpointRecord**
+
+### 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)
+
+# **listEndpoints**
+> PaginatedChannelEndpointRecord listEndpoints()
+
+
+### Example
+
+```typescript
+import {
+    ChannelEndpointsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelEndpointsApi(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.listEndpoints(
+    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
+
+**PaginatedChannelEndpointRecord**
+
+### 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)
+
+# **updateEndpoint**
+> ChannelEndpointRecord updateEndpoint(updateChannelEndpoint)
+
+
+### Example
+
+```typescript
+import {
+    ChannelEndpointsApi,
+    Configuration,
+    UpdateChannelEndpoint
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelEndpointsApi(configuration);
+
+let id: string; //Channel endpoint ID (default to undefined)
+let updateChannelEndpoint: UpdateChannelEndpoint; //
+
+const { status, data } = await apiInstance.updateEndpoint(
+    id,
+    updateChannelEndpoint
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateChannelEndpoint** | **UpdateChannelEndpoint**|  | |
+| **id** | [**string**] | Channel endpoint ID | defaults to undefined|
+
+
+### Return type
+
+**ChannelEndpointRecord**
+
+### 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/ChannelPreferences.md

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

@@ -0,0 +1,17 @@
+# ChannelType
+
+Notification delivery channels (from Novu ChannelTypeEnum).
+
+## Enum
+
+* `InApp` (value: `'in_app'`)
+
+* `Email` (value: `'email'`)
+
+* `Sms` (value: `'sms'`)
+
+* `Chat` (value: `'chat'`)
+
+* `Push` (value: `'push'`)
+
+[[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/ChartQuery.md

@@ -0,0 +1,21 @@
+# ChartQuery
+
+Query parameters for the activity chart endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days** | **number** | Number of days to include in the chart (1–365, default: 30). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ChartQuery } from '@enbbox/api';
+
+const instance: ChartQuery = {
+    days,
+};
+```
+
+[[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/ChatOauth.md

@@ -0,0 +1,21 @@
+# ChatOauth
+
+OAuth authorization URL for a chat provider.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**oauth_url** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChatOauth } from '@enbbox/api';
+
+const instance: ChatOauth = {
+    oauth_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/ChatOauthRequest.md

@@ -0,0 +1,22 @@
+# ChatOauthRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** |  | [default to undefined]
+**redirect_uri** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChatOauthRequest } from '@enbbox/api';
+
+const instance: ChatOauthRequest = {
+    provider,
+    redirect_uri,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)