@enbbox/api 1.0.0 → 1.0.1

package/docs/Subscription.md

@@ -0,0 +1,39 @@
+# Subscription
+
+Current subscription details.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billing_interval** | **string** | Billing interval (month or year). | [optional] [default to undefined]
+**cancel_at** | **string** | Cancellation date (ISO 8601), if scheduled. | [optional] [default to undefined]
+**current_period_end** | **string** | Billing period end (ISO 8601). | [optional] [default to undefined]
+**current_period_start** | **string** | Billing period start (ISO 8601). | [optional] [default to undefined]
+**events** | [**EventsUsage**](EventsUsage.md) | Events usage in the current period. | [default to undefined]
+**has_payment_method** | **boolean** | Whether the customer has a payment method on file. | [default to undefined]
+**is_active** | **boolean** | Whether the subscription is active. | [default to undefined]
+**plan** | [**Plan**](Plan.md) | Current plan. | [default to undefined]
+**status** | **string** | Stripe subscription status (active, past_due, canceled, etc.). | [default to undefined]
+**trial** | [**TrialInfo**](TrialInfo.md) | Trial information. | [default to undefined]
+
+## Example
+
+```typescript
+import { Subscription } from '@enbbox/api';
+
+const instance: Subscription = {
+    billing_interval,
+    cancel_at,
+    current_period_end,
+    current_period_start,
+    events,
+    has_payment_method,
+    is_active,
+    plan,
+    status,
+    trial,
+};
+```
+
+[[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/SyncWorkflow.md

@@ -0,0 +1,21 @@
+# SyncWorkflow
+
+Sync a workflow from code-first definitions.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**steps** | [**Array<WorkflowStepCreate>**](WorkflowStepCreate.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SyncWorkflow } from '@enbbox/api';
+
+const instance: SyncWorkflow = {
+    steps,
+};
+```
+
+[[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/SystemAvatarIcon.md

@@ -0,0 +1,19 @@
+# SystemAvatarIcon
+
+System avatar icons.
+
+## Enum
+
+* `Warning` (value: `'warning'`)
+
+* `Info` (value: `'info'`)
+
+* `Error` (value: `'error'`)
+
+* `Success` (value: `'success'`)
+
+* `Up` (value: `'up'`)
+
+* `Question` (value: `'question'`)
+
+[[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/TopicRecord.md

@@ -0,0 +1,24 @@
+# TopicRecord
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Topic key. | [default to undefined]
+**name** | **string** | Display name. | [default to undefined]
+**subscribers** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TopicRecord } from '@enbbox/api';
+
+const instance: TopicRecord = {
+    key,
+    name,
+    subscribers,
+};
+```
+
+[[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/TopicSubscribers.md

@@ -0,0 +1,21 @@
+# TopicSubscribers
+
+Manage subscribers on a topic (add/remove).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscribers** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TopicSubscribers } from '@enbbox/api';
+
+const instance: TopicSubscribers = {
+    subscribers,
+};
+```
+
+[[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/TopicSubscription.md

@@ -0,0 +1,23 @@
+# TopicSubscription
+
+A topic subscription with metadata.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic_key** | **string** | Topic key for fan-out. | [default to undefined]
+**topic_name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TopicSubscription } from '@enbbox/api';
+
+const instance: TopicSubscription = {
+    topic_key,
+    topic_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/TopicSubscriptionRecord.md

@@ -0,0 +1,29 @@
+# TopicSubscriptionRecord
+
+A subscription linking a subscriber to a topic.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | ISO 8601 creation timestamp. | [default to undefined]
+**id** | **string** | Unique identifier. | [default to undefined]
+**metadata** | **object** |  | [optional] [default to undefined]
+**subscriber_id** | **string** | Subscriber identifier. | [default to undefined]
+**topic_key** | **string** | Topic key for fan-out. | [default to undefined]
+
+## Example
+
+```typescript
+import { TopicSubscriptionRecord } from '@enbbox/api';
+
+const instance: TopicSubscriptionRecord = {
+    created_at,
+    id,
+    metadata,
+    subscriber_id,
+    topic_key,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)