@enbbox/api 1.0.0 → 1.1.0

package/docs/StepType.md

@@ -0,0 +1,27 @@
+# StepType
+
+Combined step type used in workflow step definitions.
+
+## Enum
+
+* `InApp` (value: `'in_app'`)
+
+* `Email` (value: `'email'`)
+
+* `Sms` (value: `'sms'`)
+
+* `Chat` (value: `'chat'`)
+
+* `Push` (value: `'push'`)
+
+* `Digest` (value: `'digest'`)
+
+* `Trigger` (value: `'trigger'`)
+
+* `Delay` (value: `'delay'`)
+
+* `Throttle` (value: `'throttle'`)
+
+* `Custom` (value: `'custom'`)
+
+[[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/SubscriberCredential.md

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

@@ -0,0 +1,37 @@
+# SubscriberPayload
+
+Either a subscriber ID string (e.g. \"user_123\") or a full inline subscriber object with profile data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**avatar** | **string** | URL to the subscriber\'s avatar image. | [optional] [default to undefined]
+**data** | **object** | Arbitrary key-value metadata attached to this subscriber. | [default to undefined]
+**email** | **string** | Subscriber\'s email address, used for email channel delivery. | [optional] [default to undefined]
+**first_name** | **string** | Subscriber\'s first (given) name. | [optional] [default to undefined]
+**last_name** | **string** | Subscriber\'s last (family) name. | [optional] [default to undefined]
+**locale** | **string** | IETF BCP 47 locale tag for localized content delivery. | [optional] [default to undefined]
+**phone** | **string** | Subscriber\'s phone number in E.164 format, used for SMS channel delivery. | [optional] [default to undefined]
+**subscriber_id** | **string** | Unique identifier for this subscriber in your system (e.g. user ID). | [default to undefined]
+**timezone** | **string** | IANA timezone identifier for time-aware scheduling. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SubscriberPayload } from '@enbbox/api';
+
+const instance: SubscriberPayload = {
+    avatar,
+    data,
+    email,
+    first_name,
+    last_name,
+    locale,
+    phone,
+    subscriber_id,
+    timezone,
+};
+```
+
+[[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/SubscriberRecord.md

@@ -0,0 +1,41 @@
+# SubscriberRecord
+
+Full subscriber profile as stored in the system.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**avatar** | **string** | Avatar URL. | [optional] [default to undefined]
+**credentials** | [**Array<SubscriberCredential>**](SubscriberCredential.md) | Push/chat provider credentials for this subscriber. | [optional] [default to undefined]
+**email** | **string** | Email address. | [optional] [default to undefined]
+**first_name** | **string** | First name. | [optional] [default to undefined]
+**id** | **string** | Internal UUID assigned by the system. | [default to undefined]
+**is_online** | **boolean** | Whether the subscriber is currently connected via SSE/WebSocket. | [optional] [default to undefined]
+**last_name** | **string** | Last name. | [optional] [default to undefined]
+**last_online_at** | **string** | ISO 8601 timestamp of when the subscriber was last seen online. | [optional] [default to undefined]
+**locale** | **string** | Locale tag. | [optional] [default to undefined]
+**phone** | **string** | Phone number. | [optional] [default to undefined]
+**subscriber_id** | **string** | Your unique subscriber identifier. | [default to undefined]
+
+## Example
+
+```typescript
+import { SubscriberRecord } from '@enbbox/api';
+
+const instance: SubscriberRecord = {
+    avatar,
+    credentials,
+    email,
+    first_name,
+    id,
+    is_online,
+    last_name,
+    last_online_at,
+    locale,
+    phone,
+    subscriber_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)