@enbbox/api 1.0.0 → 1.1.0

package/docs/WorkflowsApi.md

@@ -0,0 +1,550 @@
+# WorkflowsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createWorkflow**](#createworkflow) | **POST** /v1/workflows/ | POST /v1/workflows|
+|[**deleteWorkflow**](#deleteworkflow) | **DELETE** /v1/workflows/{id}/ | DELETE /v1/workflows/:id|
+|[**duplicateWorkflow**](#duplicateworkflow) | **POST** /v1/workflows/{id}/duplicate/ | POST /v1/workflows/:id/duplicate — clone workflow|
+|[**getStep**](#getstep) | **GET** /v1/workflows/{id}/steps/{step_id}/ | GET /v1/workflows/:id/steps/:step_id — get step details|
+|[**getWorkflow**](#getworkflow) | **GET** /v1/workflows/{id}/ | GET /v1/workflows/:id|
+|[**listWorkflows**](#listworkflows) | **GET** /v1/workflows/ | GET /v1/workflows|
+|[**stepPreview**](#steppreview) | **POST** /v1/workflows/{id}/step/{step_id}/preview/ | POST /v1/workflows/:id/step/:step_id/preview — render step template|
+|[**syncWorkflow**](#syncworkflow) | **PUT** /v1/workflows/{id}/sync/ | PUT /v1/workflows/:id/sync — sync from code-first workflow definition|
+|[**updateWorkflow**](#updateworkflow) | **PUT** /v1/workflows/{id}/ | PUT /v1/workflows/:id|
+|[**updateWorkflowStatus**](#updateworkflowstatus) | **PUT** /v1/workflows/{id}/status/ | PUT /v1/workflows/:id/status|
+
+# **createWorkflow**
+> WorkflowRecord createWorkflow(createWorkflow)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    CreateWorkflow
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let createWorkflow: CreateWorkflow; //
+
+const { status, data } = await apiInstance.createWorkflow(
+    createWorkflow
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createWorkflow** | **CreateWorkflow**|  | |
+
+
+### Return type
+
+**WorkflowRecord**
+
+### 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)
+
+# **deleteWorkflow**
+> deleteWorkflow()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; //Workflow ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteWorkflow(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Workflow 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)
+
+# **duplicateWorkflow**
+> WorkflowRecord duplicateWorkflow()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.duplicateWorkflow(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowRecord**
+
+### 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)
+
+# **getStep**
+> StepRecord getStep()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+let stepId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getStep(
+    id,
+    stepId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+| **stepId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**StepRecord**
+
+### 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)
+
+# **getWorkflow**
+> WorkflowRecord getWorkflow()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; //Workflow ID (default to undefined)
+
+const { status, data } = await apiInstance.getWorkflow(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Workflow ID | defaults to undefined|
+
+
+### Return type
+
+**WorkflowRecord**
+
+### 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)
+
+# **listWorkflows**
+> PaginatedWorkflowRecord listWorkflows()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(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.listWorkflows(
+    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
+
+**PaginatedWorkflowRecord**
+
+### 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)
+
+# **stepPreview**
+> PreviewResult stepPreview(stepPreview)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    StepPreview
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+let stepId: string; // (default to undefined)
+let stepPreview: StepPreview; //
+
+const { status, data } = await apiInstance.stepPreview(
+    id,
+    stepId,
+    stepPreview
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stepPreview** | **StepPreview**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+| **stepId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PreviewResult**
+
+### 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)
+
+# **syncWorkflow**
+> WorkflowRecord syncWorkflow(syncWorkflow)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    SyncWorkflow
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+let syncWorkflow: SyncWorkflow; //
+
+const { status, data } = await apiInstance.syncWorkflow(
+    id,
+    syncWorkflow
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **syncWorkflow** | **SyncWorkflow**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowRecord**
+
+### 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)
+
+# **updateWorkflow**
+> WorkflowRecord updateWorkflow(updateWorkflow)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    UpdateWorkflow
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; //Workflow ID (default to undefined)
+let updateWorkflow: UpdateWorkflow; //
+
+const { status, data } = await apiInstance.updateWorkflow(
+    id,
+    updateWorkflow
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateWorkflow** | **UpdateWorkflow**|  | |
+| **id** | [**string**] | Workflow ID | defaults to undefined|
+
+
+### Return type
+
+**WorkflowRecord**
+
+### 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)
+
+# **updateWorkflowStatus**
+> WorkflowRecord updateWorkflowStatus(workflowStatus)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    WorkflowStatus
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; //Workflow ID (default to undefined)
+let workflowStatus: WorkflowStatus; //
+
+const { status, data } = await apiInstance.updateWorkflowStatus(
+    id,
+    workflowStatus
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **workflowStatus** | **WorkflowStatus**|  | |
+| **id** | [**string**] | Workflow ID | defaults to undefined|
+
+
+### Return type
+
+**WorkflowRecord**
+
+### 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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="enbbox"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="api-client-ts"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/models/action-body.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Request body for performing an inbox action (CTA button click).
+ */
+export interface ActionBody {
+    /**
+     * Action result data (e.g. button click payload).
+     */
+    'data'?: object;
+}
+

package/models/action-record.ts

@@ -0,0 +1,28 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * An action (CTA button) attached to an inbox notification.
+ */
+export interface ActionRecord {
+    'action_type': string;
+    'message_id': string;
+    /**
+     * Current status.
+     */
+    'status': string;
+}
+

package/models/action-type.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Action step types (non-channel workflow steps).
+ */
+
+export const ActionType = {
+    Trigger: 'trigger',
+    Digest: 'digest',
+    Delay: 'delay',
+    Throttle: 'throttle',
+    Custom: 'custom'
+} as const;
+
+export type ActionType = typeof ActionType[keyof typeof ActionType];
+
+
+