@enbbox/api 1.0.0 → 1.0.1

package/docs/TopicsApi.md

@@ -0,0 +1,777 @@
+# TopicsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addSubscribers**](#addsubscribers) | **POST** /v1/topics/{key}/subscribers/ | POST /v1/topics/:topicKey/subscribers|
+|[**checkSubscriber**](#checksubscriber) | **GET** /v1/topics/{key}/subscribers/{subscriber_id}/ | GET /v1/topics/:key/subscribers/:subscriber_id — membership check|
+|[**createSubscriptions**](#createsubscriptions) | **POST** /v1/topics/{key}/subscriptions/ | POST /v1/topics/:key/subscriptions — create subscriptions|
+|[**createTopic**](#createtopic) | **POST** /v1/topics/ | POST /v1/topics|
+|[**deleteSubscriptions**](#deletesubscriptions) | **DELETE** /v1/topics/{key}/subscriptions/ | DELETE /v1/topics/:key/subscriptions — bulk delete|
+|[**deleteTopic**](#deletetopic) | **DELETE** /v1/topics/{key}/ | DELETE /v1/topics/:topicKey|
+|[**getSubscription**](#getsubscription) | **GET** /v1/topics/{key}/subscriptions/{id}/ | GET /v1/topics/:key/subscriptions/:id — get single subscription|
+|[**getTopic**](#gettopic) | **GET** /v1/topics/{key}/ | GET /v1/topics/:topicKey|
+|[**listSubscriptions**](#listsubscriptions) | **GET** /v1/topics/{key}/subscriptions/ | GET /v1/topics/:key/subscriptions — list subscriptions|
+|[**listTopicSubscribers**](#listtopicsubscribers) | **GET** /v1/topics/{key}/subscribers/ | GET /v1/topics/:topicKey/subscribers|
+|[**listTopics**](#listtopics) | **GET** /v1/topics/ | GET /v1/topics|
+|[**removeSubscribers**](#removesubscribers) | **POST** /v1/topics/{key}/subscribers/removal/ | POST /v1/topics/:topicKey/subscribers/removal|
+|[**updateSubscription**](#updatesubscription) | **PATCH** /v1/topics/{key}/subscriptions/{id}/ | PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata|
+|[**updateTopic**](#updatetopic) | **PATCH** /v1/topics/{key}/ | PATCH /v1/topics/:topicKey|
+
+# **addSubscribers**
+> addSubscribers(topicSubscribers)
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration,
+    TopicSubscribers
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; //Topic key (default to undefined)
+let topicSubscribers: TopicSubscribers; //
+
+const { status, data } = await apiInstance.addSubscribers(
+    key,
+    topicSubscribers
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **topicSubscribers** | **TopicSubscribers**|  | |
+| **key** | [**string**] | Topic key | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Added |  -  |
+
+[[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)
+
+# **checkSubscriber**
+> checkSubscriber()
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; // (default to undefined)
+let subscriberId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.checkSubscriber(
+    key,
+    subscriberId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] |  | defaults to undefined|
+| **subscriberId** | [**string**] |  | 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 |
+|-------------|-------------|------------------|
+|**200** | Is member |  -  |
+|**404** | Not member |  -  |
+
+[[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)
+
+# **createSubscriptions**
+> Array<TopicSubscriptionRecord> createSubscriptions(createSubscription)
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration,
+    CreateSubscription
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; // (default to undefined)
+let createSubscription: CreateSubscription; //
+
+const { status, data } = await apiInstance.createSubscriptions(
+    key,
+    createSubscription
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createSubscription** | **CreateSubscription**|  | |
+| **key** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<TopicSubscriptionRecord>**
+
+### 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)
+
+# **createTopic**
+> TopicRecord createTopic(createTopic)
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration,
+    CreateTopic
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let createTopic: CreateTopic; //
+
+const { status, data } = await apiInstance.createTopic(
+    createTopic
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createTopic** | **CreateTopic**|  | |
+
+
+### Return type
+
+**TopicRecord**
+
+### 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)
+
+# **deleteSubscriptions**
+> deleteSubscriptions(deleteSubscription)
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration,
+    DeleteSubscription
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; // (default to undefined)
+let deleteSubscription: DeleteSubscription; //
+
+const { status, data } = await apiInstance.deleteSubscriptions(
+    key,
+    deleteSubscription
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deleteSubscription** | **DeleteSubscription**|  | |
+| **key** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **deleteTopic**
+> deleteTopic()
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; //Topic key (default to undefined)
+
+const { status, data } = await apiInstance.deleteTopic(
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] | Topic key | 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)
+
+# **getSubscription**
+> TopicSubscriptionRecord getSubscription()
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; // (default to undefined)
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSubscription(
+    key,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] |  | defaults to undefined|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TopicSubscriptionRecord**
+
+### 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)
+
+# **getTopic**
+> TopicRecord getTopic()
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; //Topic key (default to undefined)
+
+const { status, data } = await apiInstance.getTopic(
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] | Topic key | defaults to undefined|
+
+
+### Return type
+
+**TopicRecord**
+
+### 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)
+
+# **listSubscriptions**
+> PaginatedTopicSubscriptionRecord listSubscriptions()
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; // (default to undefined)
+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.listSubscriptions(
+    key,
+    limit,
+    offset,
+    q,
+    filterBy
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] |  | defaults to undefined|
+| **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
+
+**PaginatedTopicSubscriptionRecord**
+
+### 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)
+
+# **listTopicSubscribers**
+> Array<string> listTopicSubscribers()
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; //Topic key (default to undefined)
+
+const { status, data } = await apiInstance.listTopicSubscribers(
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] | Topic key | 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)
+
+# **listTopics**
+> PaginatedTopicRecord listTopics()
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(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.listTopics(
+    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
+
+**PaginatedTopicRecord**
+
+### 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)
+
+# **removeSubscribers**
+> removeSubscribers(topicSubscribers)
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration,
+    TopicSubscribers
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; //Topic key (default to undefined)
+let topicSubscribers: TopicSubscribers; //
+
+const { status, data } = await apiInstance.removeSubscribers(
+    key,
+    topicSubscribers
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **topicSubscribers** | **TopicSubscribers**|  | |
+| **key** | [**string**] | Topic key | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Removed |  -  |
+
+[[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)
+
+# **updateSubscription**
+> TopicSubscriptionRecord updateSubscription(updateSubscriptionMeta)
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration,
+    UpdateSubscriptionMeta
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; // (default to undefined)
+let id: string; // (default to undefined)
+let updateSubscriptionMeta: UpdateSubscriptionMeta; //
+
+const { status, data } = await apiInstance.updateSubscription(
+    key,
+    id,
+    updateSubscriptionMeta
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateSubscriptionMeta** | **UpdateSubscriptionMeta**|  | |
+| **key** | [**string**] |  | defaults to undefined|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TopicSubscriptionRecord**
+
+### 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)
+
+# **updateTopic**
+> TopicRecord updateTopic(updateTopic)
+
+
+### Example
+
+```typescript
+import {
+    TopicsApi,
+    Configuration,
+    UpdateTopic
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new TopicsApi(configuration);
+
+let key: string; //Topic key (default to undefined)
+let updateTopic: UpdateTopic; //
+
+const { status, data } = await apiInstance.updateTopic(
+    key,
+    updateTopic
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateTopic** | **UpdateTopic**|  | |
+| **key** | [**string**] | Topic key | defaults to undefined|
+
+
+### Return type
+
+**TopicRecord**
+
+### 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)
+