@enbbox/api 1.0.0 → 1.1.0

package/docs/InboxPreference.md

@@ -0,0 +1,23 @@
+# InboxPreference
+
+Subscriber inbox notification preference settings.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channels** | [**ChannelPreferences**](ChannelPreferences.md) |  | [default to undefined]
+**workflow_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InboxPreference } from '@enbbox/api';
+
+const instance: InboxPreference = {
+    channels,
+    workflow_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/InboxQuery.md

@@ -0,0 +1,27 @@
+# InboxQuery
+
+Query parameters for listing inbox notifications.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**after** | **string** |  | [optional] [default to undefined]
+**archived** | **boolean** |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**read** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InboxQuery } from '@enbbox/api';
+
+const instance: InboxQuery = {
+    after,
+    archived,
+    limit,
+    read,
+};
+```
+
+[[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/InitSessionRequest.md

@@ -0,0 +1,23 @@
+# InitSessionRequest
+
+Initialize a subscriber inbox session.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscriber_hash** | **string** | Optional HMAC-SHA256 hash of the subscriber_id for production security. | [optional] [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier (e.g. user ID from your system). | [default to undefined]
+
+## Example
+
+```typescript
+import { InitSessionRequest } from '@enbbox/api';
+
+const instance: InitSessionRequest = {
+    subscriber_hash,
+    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/InitSessionResponse.md

@@ -0,0 +1,25 @@
+# InitSessionResponse
+
+Subscriber session token and initial counts.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remove_branding** | **boolean** | Whether the project\'s plan allows removing Enbbox branding. `true` for Pro+ plans, `false` for Free. | [default to undefined]
+**token** | **string** | Short-lived JWT for authenticating subsequent inbox requests. | [default to undefined]
+**total_unread_count** | **number** | Current total unread notification count. | [default to undefined]
+
+## Example
+
+```typescript
+import { InitSessionResponse } from '@enbbox/api';
+
+const instance: InitSessionResponse = {
+    remove_branding,
+    token,
+    total_unread_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/IntegrationRecord.md

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

@@ -0,0 +1,475 @@
+# IntegrationsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**autoConfigure**](#autoconfigure) | **POST** /v1/integrations/{id}/auto-configure/ | POST /v1/integrations/:id/auto-configure — auto-configure integration webhooks|
+|[**chatOauth**](#chatoauth) | **POST** /v1/integrations/chat/oauth/ | POST /v1/integrations/chat/oauth — generate OAuth URL for chat providers|
+|[**createIntegration**](#createintegration) | **POST** /v1/integrations/ | POST /v1/integrations|
+|[**deleteIntegration**](#deleteintegration) | **DELETE** /v1/integrations/{id}/ | DELETE /v1/integrations/:id|
+|[**getIntegration**](#getintegration) | **GET** /v1/integrations/{id}/ | GET /v1/integrations/:id|
+|[**listActiveIntegrations**](#listactiveintegrations) | **GET** /v1/integrations/active/ | GET /v1/integrations/active — list only active integrations|
+|[**listIntegrations**](#listintegrations) | **GET** /v1/integrations/ | GET /v1/integrations|
+|[**setPrimary**](#setprimary) | **PUT** /v1/integrations/{id}/set-primary/ | PUT /v1/integrations/:id/set-primary|
+|[**updateIntegration**](#updateintegration) | **PUT** /v1/integrations/{id}/ | PUT /v1/integrations/:id|
+
+# **autoConfigure**
+> IntegrationRecord autoConfigure()
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.autoConfigure(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**IntegrationRecord**
+
+### 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)
+
+# **chatOauth**
+> ChatOauth chatOauth(chatOauthRequest)
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration,
+    ChatOauthRequest
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let chatOauthRequest: ChatOauthRequest; //
+
+const { status, data } = await apiInstance.chatOauth(
+    chatOauthRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **chatOauthRequest** | **ChatOauthRequest**|  | |
+
+
+### Return type
+
+**ChatOauth**
+
+### 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)
+
+# **createIntegration**
+> IntegrationRecord createIntegration(createIntegration)
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration,
+    CreateIntegration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let createIntegration: CreateIntegration; //
+
+const { status, data } = await apiInstance.createIntegration(
+    createIntegration
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createIntegration** | **CreateIntegration**|  | |
+
+
+### Return type
+
+**IntegrationRecord**
+
+### 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)
+
+# **deleteIntegration**
+> deleteIntegration()
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let id: string; //Integration ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteIntegration(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Integration 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)
+
+# **getIntegration**
+> IntegrationRecord getIntegration()
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let id: string; //Integration ID (default to undefined)
+
+const { status, data } = await apiInstance.getIntegration(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Integration ID | defaults to undefined|
+
+
+### Return type
+
+**IntegrationRecord**
+
+### 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** |  |  -  |
+|**404** |  |  -  |
+
+[[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)
+
+# **listActiveIntegrations**
+> Array<IntegrationRecord> listActiveIntegrations()
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+const { status, data } = await apiInstance.listActiveIntegrations();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<IntegrationRecord>**
+
+### 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)
+
+# **listIntegrations**
+> PaginatedIntegrationRecord listIntegrations()
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(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.listIntegrations(
+    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: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedIntegrationRecord**
+
+### 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)
+
+# **setPrimary**
+> IntegrationRecord setPrimary()
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let id: string; //Integration ID (default to undefined)
+
+const { status, data } = await apiInstance.setPrimary(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Integration ID | defaults to undefined|
+
+
+### Return type
+
+**IntegrationRecord**
+
+### 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)
+
+# **updateIntegration**
+> IntegrationRecord updateIntegration(updateIntegration)
+
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration,
+    UpdateIntegration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let id: string; //Integration ID (default to undefined)
+let updateIntegration: UpdateIntegration; //
+
+const { status, data } = await apiInstance.updateIntegration(
+    id,
+    updateIntegration
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateIntegration** | **UpdateIntegration**|  | |
+| **id** | [**string**] | Integration ID | defaults to undefined|
+
+
+### Return type
+
+**IntegrationRecord**
+
+### 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/InviteMember.md

@@ -0,0 +1,23 @@
+# InviteMember
+
+Invite a user to join the project by email.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email address of the user to invite. | [default to undefined]
+**role** | **string** | Role to assign: `admin` or `member`. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InviteMember } from '@enbbox/api';
+
+const instance: InviteMember = {
+    email,
+    role,
+};
+```
+
+[[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/InviteMemberBody.md

@@ -0,0 +1,23 @@
+# InviteMemberBody
+
+Invite a user to join the project by email.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email address of the user to invite. | [default to undefined]
+**role** | **string** | Role to assign: `admin`, `member`, or `viewer`. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InviteMemberBody } from '@enbbox/api';
+
+const instance: InviteMemberBody = {
+    email,
+    role,
+};
+```
+
+[[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/JobLog.md

@@ -0,0 +1,33 @@
+# JobLog
+
+A job processing log entry with timing and status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**error** | **string** | Error type. | [optional] [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**provider_id** | **string** | Provider identifier. | [optional] [default to undefined]
+**status** | **string** | Current status. | [default to undefined]
+**step_type** | **string** |  | [default to undefined]
+**updated_at** | **string** | ISO 8601 last-modified timestamp. | [default to undefined]
+
+## Example
+
+```typescript
+import { JobLog } from '@enbbox/api';
+
+const instance: JobLog = {
+    created_at,
+    error,
+    id,
+    provider_id,
+    status,
+    step_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)