@enbbox/api 1.0.0 → 1.1.0

package/docs/ProjectsApi.md

@@ -0,0 +1,638 @@
+# ProjectsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createProject**](#createproject) | **POST** /v1/projects/ | POST /v1/projects/ — create a new project|
+|[**deleteApiKey**](#deleteapikey) | **DELETE** /v1/projects/{id}/api-keys/{key_id}/ | DELETE /v1/projects/{id}/api-keys/{key_id}/ — revoke an API key by ID|
+|[**deleteProject**](#deleteproject) | **DELETE** /v1/projects/{id}/ | DELETE /v1/projects/{id}/ — delete a project (owner only)|
+|[**generateApiKey**](#generateapikey) | **POST** /v1/projects/{id}/api-keys/ | POST /v1/projects/{id}/api-keys/ — generate a new API key|
+|[**getProject**](#getproject) | **GET** /v1/projects/{id}/ | GET /v1/projects/{id}/ — get a project by ID|
+|[**inviteMember**](#invitemember) | **POST** /v1/projects/{id}/members/ | POST /v1/projects/{id}/members/ — invite a member|
+|[**listApiKeys**](#listapikeys) | **GET** /v1/projects/{id}/api-keys/ | GET /v1/projects/{id}/api-keys/ — list API keys for a project|
+|[**listMembers**](#listmembers) | **GET** /v1/projects/{id}/members/ | GET /v1/projects/{id}/members/ — list project members|
+|[**listProjects**](#listprojects) | **GET** /v1/projects/ | GET /v1/projects/ — list all projects the user is a member of|
+|[**projectTags**](#projecttags) | **GET** /v1/projects/{id}/tags/ | GET /v1/projects/{id}/tags/ — returns unique tags from all workflows in the project|
+|[**removeMember**](#removemember) | **DELETE** /v1/projects/{id}/members/{member_id}/ | DELETE /v1/projects/{id}/members/{member_id}/ — remove a member|
+|[**updateProject**](#updateproject) | **PATCH** /v1/projects/{id}/ | PATCH /v1/projects/{id}/ — update a project|
+
+# **createProject**
+> ProjectRecord createProject(createProject)
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration,
+    CreateProject
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let createProject: CreateProject; //
+
+const { status, data } = await apiInstance.createProject(
+    createProject
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createProject** | **CreateProject**|  | |
+
+
+### Return type
+
+**ProjectRecord**
+
+### 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)
+
+# **deleteApiKey**
+> deleteApiKey()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+let keyId: string; //API Key ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteApiKey(
+    id,
+    keyId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project ID | defaults to undefined|
+| **keyId** | [**string**] | API Key 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**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Key revoked |  -  |
+|**403** |  |  -  |
+|**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)
+
+# **deleteProject**
+> deleteProject()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteProject(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project 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**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Deleted |  -  |
+|**403** |  |  -  |
+
+[[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)
+
+# **generateApiKey**
+> ApiKeyCreated generateApiKey()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+
+const { status, data } = await apiInstance.generateApiKey(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project ID | defaults to undefined|
+
+
+### Return type
+
+**ApiKeyCreated**
+
+### 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** |  |  -  |
+|**403** |  |  -  |
+
+[[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)
+
+# **getProject**
+> ProjectRecord getProject()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+
+const { status, data } = await apiInstance.getProject(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project ID | defaults to undefined|
+
+
+### Return type
+
+**ProjectRecord**
+
+### 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** |  |  -  |
+|**403** |  |  -  |
+|**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)
+
+# **inviteMember**
+> MemberRecord inviteMember(inviteMemberBody)
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration,
+    InviteMemberBody
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+let inviteMemberBody: InviteMemberBody; //
+
+const { status, data } = await apiInstance.inviteMember(
+    id,
+    inviteMemberBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **inviteMemberBody** | **InviteMemberBody**|  | |
+| **id** | [**string**] | Project ID | defaults to undefined|
+
+
+### Return type
+
+**MemberRecord**
+
+### 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** |  |  -  |
+|**403** |  |  -  |
+
+[[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)
+
+# **listApiKeys**
+> Array<ApiKeyInfo> listApiKeys()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+
+const { status, data } = await apiInstance.listApiKeys(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project ID | defaults to undefined|
+
+
+### Return type
+
+**Array<ApiKeyInfo>**
+
+### 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** |  |  -  |
+|**403** |  |  -  |
+
+[[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)
+
+# **listMembers**
+> Array<MemberRecord> listMembers()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+
+const { status, data } = await apiInstance.listMembers(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project ID | defaults to undefined|
+
+
+### Return type
+
+**Array<MemberRecord>**
+
+### 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)
+
+# **listProjects**
+> Array<ProjectRecord> listProjects()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+const { status, data } = await apiInstance.listProjects();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ProjectRecord>**
+
+### 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)
+
+# **projectTags**
+> Array<string> projectTags()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+
+const { status, data } = await apiInstance.projectTags(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project ID | defaults to undefined|
+
+
+### Return type
+
+**Array<string>**
+
+### 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)
+
+# **removeMember**
+> removeMember()
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+let memberId: string; //Member ID (default to undefined)
+
+const { status, data } = await apiInstance.removeMember(
+    id,
+    memberId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Project ID | defaults to undefined|
+| **memberId** | [**string**] | Member 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**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Removed |  -  |
+|**403** |  |  -  |
+|**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)
+
+# **updateProject**
+> ProjectRecord updateProject(updateProject)
+
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration,
+    UpdateProject
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let id: string; //Project ID (default to undefined)
+let updateProject: UpdateProject; //
+
+const { status, data } = await apiInstance.updateProject(
+    id,
+    updateProject
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateProject** | **UpdateProject**|  | |
+| **id** | [**string**] | Project ID | defaults to undefined|
+
+
+### Return type
+
+**ProjectRecord**
+
+### 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** |  |  -  |
+|**403** |  |  -  |
+
+[[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/SetCredentials.md

@@ -0,0 +1,27 @@
+# SetCredentials
+
+Set provider credentials on a subscriber (e.g. FCM token).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credentials** | **object** |  | [default to undefined]
+**device_tokens** | **Array<string>** |  | [optional] [default to undefined]
+**provider_id** | **string** | Provider identifier. | [default to undefined]
+**webhook_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SetCredentials } from '@enbbox/api';
+
+const instance: SetCredentials = {
+    credentials,
+    device_tokens,
+    provider_id,
+    webhook_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/StepPreview.md

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

@@ -0,0 +1,29 @@
+# StepRecord
+
+A workflow step with its template and active status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **boolean** | Whether this resource is active. | [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**name** | **string** | Display name. | [optional] [default to undefined]
+**step_type** | **string** |  | [default to undefined]
+**template** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StepRecord } from '@enbbox/api';
+
+const instance: StepRecord = {
+    active,
+    id,
+    name,
+    step_type,
+    template,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)