@enbbox/api 1.0.0 → 1.1.0

package/docs/LayoutPreview.md

@@ -0,0 +1,21 @@
+# LayoutPreview
+
+Request body for previewing a rendered layout.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LayoutPreview } from '@enbbox/api';
+
+const instance: LayoutPreview = {
+    content,
+};
+```
+
+[[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/LayoutPreviewResult.md

@@ -0,0 +1,21 @@
+# LayoutPreviewResult
+
+Result of a layout preview rendering.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rendered** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LayoutPreviewResult } from '@enbbox/api';
+
+const instance: LayoutPreviewResult = {
+    rendered,
+};
+```
+
+[[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/LayoutRecord.md

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

@@ -0,0 +1,23 @@
+# LayoutUsageItem
+
+A workflow that references this layout.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**workflow_id** | **string** |  | [default to undefined]
+**workflow_name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LayoutUsageItem } from '@enbbox/api';
+
+const instance: LayoutUsageItem = {
+    workflow_id,
+    workflow_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/LayoutsApi.md

@@ -0,0 +1,484 @@
+# LayoutsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createLayout**](#createlayout) | **POST** /v1/layouts/ | POST /v1/layouts|
+|[**deleteLayout**](#deletelayout) | **DELETE** /v1/layouts/{id}/ | DELETE /v1/layouts/:id|
+|[**duplicateLayout**](#duplicatelayout) | **POST** /v1/layouts/{id}/duplicate/ | POST /v1/layouts/:id/duplicate — clone layout|
+|[**getLayout**](#getlayout) | **GET** /v1/layouts/{id}/ | GET /v1/layouts/:id|
+|[**layoutUsage**](#layoutusage) | **GET** /v1/layouts/{id}/usage/ | GET /v1/layouts/:id/usage — list workflows using this layout|
+|[**listLayouts**](#listlayouts) | **GET** /v1/layouts/ | GET /v1/layouts|
+|[**previewLayout**](#previewlayout) | **POST** /v1/layouts/{id}/preview/ | POST /v1/layouts/:id/preview — render layout with sample content|
+|[**setDefault**](#setdefault) | **POST** /v1/layouts/{id}/default/ | POST /v1/layouts/:id/default|
+|[**updateLayout**](#updatelayout) | **PATCH** /v1/layouts/{id}/ | PATCH /v1/layouts/:id|
+
+# **createLayout**
+> LayoutRecord createLayout(createLayout)
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration,
+    CreateLayout
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let createLayout: CreateLayout; //
+
+const { status, data } = await apiInstance.createLayout(
+    createLayout
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createLayout** | **CreateLayout**|  | |
+
+
+### Return type
+
+**LayoutRecord**
+
+### 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)
+
+# **deleteLayout**
+> deleteLayout()
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let id: string; //Layout ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteLayout(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Layout 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)
+
+# **duplicateLayout**
+> LayoutRecord duplicateLayout()
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.duplicateLayout(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**LayoutRecord**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getLayout**
+> LayoutRecord getLayout()
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let id: string; //Layout ID (default to undefined)
+
+const { status, data } = await apiInstance.getLayout(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Layout ID | defaults to undefined|
+
+
+### Return type
+
+**LayoutRecord**
+
+### 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)
+
+# **layoutUsage**
+> Array<LayoutUsageItem> layoutUsage()
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.layoutUsage(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<LayoutUsageItem>**
+
+### 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)
+
+# **listLayouts**
+> PaginatedLayoutRecord listLayouts()
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(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.listLayouts(
+    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
+
+**PaginatedLayoutRecord**
+
+### 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)
+
+# **previewLayout**
+> LayoutPreviewResult previewLayout(layoutPreview)
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration,
+    LayoutPreview
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let id: string; // (default to undefined)
+let layoutPreview: LayoutPreview; //
+
+const { status, data } = await apiInstance.previewLayout(
+    id,
+    layoutPreview
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **layoutPreview** | **LayoutPreview**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**LayoutPreviewResult**
+
+### 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)
+
+# **setDefault**
+> LayoutRecord setDefault()
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let id: string; //Layout ID (default to undefined)
+
+const { status, data } = await apiInstance.setDefault(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Layout ID | defaults to undefined|
+
+
+### Return type
+
+**LayoutRecord**
+
+### 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)
+
+# **updateLayout**
+> LayoutRecord updateLayout(updateLayout)
+
+
+### Example
+
+```typescript
+import {
+    LayoutsApi,
+    Configuration,
+    UpdateLayout
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new LayoutsApi(configuration);
+
+let id: string; //Layout ID (default to undefined)
+let updateLayout: UpdateLayout; //
+
+const { status, data } = await apiInstance.updateLayout(
+    id,
+    updateLayout
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateLayout** | **UpdateLayout**|  | |
+| **id** | [**string**] | Layout ID | defaults to undefined|
+
+
+### Return type
+
+**LayoutRecord**
+
+### 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/MarkAll.md

@@ -0,0 +1,21 @@
+# MarkAll
+
+Mark all inbox messages as read.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mark** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MarkAll } from '@enbbox/api';
+
+const instance: MarkAll = {
+    mark,
+};
+```
+
+[[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/MarkMessages.md

@@ -0,0 +1,23 @@
+# MarkMessages
+
+Mark specific message(s) as read or seen.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mark** | **string** |  | [default to undefined]
+**message_ids** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MarkMessages } from '@enbbox/api';
+
+const instance: MarkMessages = {
+    mark,
+    message_ids,
+};
+```
+
+[[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/MarkResult.md

@@ -0,0 +1,21 @@
+# MarkResult
+
+Result of a mark-as-read/seen operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**updated** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MarkResult } from '@enbbox/api';
+
+const instance: MarkResult = {
+    updated,
+};
+```
+
+[[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/MemberRecord.md

@@ -0,0 +1,27 @@
+# MemberRecord
+
+A member of the project with their assigned roles and invitation status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Member UUID. | [default to undefined]
+**roles** | **Array<string>** | Assigned roles. | [default to undefined]
+**status** | **string** | Membership status: `invited`, `active`, or `disabled`. | [default to undefined]
+**user_id** | **string** | Associated user ID (null if invitation is still pending). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MemberRecord } from '@enbbox/api';
+
+const instance: MemberRecord = {
+    id,
+    roles,
+    status,
+    user_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/MemberRole.md

@@ -0,0 +1,15 @@
+# MemberRole
+
+Role assigned to a project member. Determines permission level.
+
+## Enum
+
+* `Owner` (value: `'owner'`)
+
+* `Admin` (value: `'admin'`)
+
+* `Member` (value: `'member'`)
+
+* `Viewer` (value: `'viewer'`)
+
+[[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/MemberStatus.md

@@ -0,0 +1,13 @@
+# MemberStatus
+
+Current status of a project membership.
+
+## Enum
+
+* `New` (value: `'new'`)
+
+* `Active` (value: `'active'`)
+
+* `Invited` (value: `'invited'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)