@enbbox/api 1.0.0 → 1.0.1

package/docs/FeatureFlagsApi.md

@@ -0,0 +1,51 @@
+# FeatureFlagsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFeatureFlags**](#getfeatureflags) | **GET** /v1/feature-flags/ | GET /v1/feature-flags — returns enabled features for the current project.|
+
+# **getFeatureFlags**
+> getFeatureFlags()
+
+
+### Example
+
+```typescript
+import {
+    FeatureFlagsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new FeatureFlagsApi(configuration);
+
+const { status, data } = await apiInstance.getFeatureFlags();
+```
+
+### 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** | Feature flags |  -  |
+
+[[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/FeedItem.md

@@ -0,0 +1,37 @@
+# FeedItem
+
+A notification feed item for subscriber-facing display.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channel** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**data** | **any** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**is_read** | **boolean** |  | [default to undefined]
+**is_seen** | **boolean** |  | [default to undefined]
+**subject** | **string** |  | [optional] [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+
+## Example
+
+```typescript
+import { FeedItem } from '@enbbox/api';
+
+const instance: FeedItem = {
+    channel,
+    content,
+    created_at,
+    data,
+    id,
+    is_read,
+    is_seen,
+    subject,
+    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/FeedQuery.md

@@ -0,0 +1,31 @@
+# FeedQuery
+
+Query parameters for listing subscriber notification feed.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**after** | **string** |  | [optional] [default to undefined]
+**before** | **string** |  | [optional] [default to undefined]
+**channel** | **string** |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**read** | **boolean** |  | [optional] [default to undefined]
+**seen** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FeedQuery } from '@enbbox/api';
+
+const instance: FeedQuery = {
+    after,
+    before,
+    channel,
+    limit,
+    read,
+    seen,
+};
+```
+
+[[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/HealthApi.md

@@ -0,0 +1,140 @@
+# HealthApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**healthCheck**](#healthcheck) | **GET** /health/ | GET /health — basic health check (backward compat).|
+|[**liveness**](#liveness) | **GET** /health/live/ | GET /health/live — liveness probe: returns 200 if process is alive.|
+|[**readiness**](#readiness) | **GET** /health/ready/ | GET /health/ready — readiness probe: returns 200 if dependencies are connected.|
+
+# **healthCheck**
+> healthCheck()
+
+
+### Example
+
+```typescript
+import {
+    HealthApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new HealthApi(configuration);
+
+const { status, data } = await apiInstance.healthCheck();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+# **liveness**
+> liveness()
+
+
+### Example
+
+```typescript
+import {
+    HealthApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new HealthApi(configuration);
+
+const { status, data } = await apiInstance.liveness();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Alive |  -  |
+
+[[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)
+
+# **readiness**
+> readiness()
+
+
+### Example
+
+```typescript
+import {
+    HealthApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new HealthApi(configuration);
+
+const { status, data } = await apiInstance.readiness();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ready |  -  |
+|**503** | Not ready |  -  |
+
+[[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/InboundParseApi.md

@@ -0,0 +1,59 @@
+# InboundParseApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**inboundParseWebhook**](#inboundparsewebhook) | **POST** /v1/inbound-parse/webhook/ | POST /v1/inbound-parse/webhook — receive parsed email from provider.|
+
+# **inboundParseWebhook**
+> inboundParseWebhook(body)
+
+This endpoint receives inbound emails (e.g., replies to notification threads) from email service providers like SendGrid, Postmark, etc.
+
+### Example
+
+```typescript
+import {
+    InboundParseApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new InboundParseApi(configuration);
+
+let body: any; //
+
+const { status, data } = await apiInstance.inboundParseWebhook(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Received |  -  |
+
+[[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)
+