mirror of
https://github.com/hanzo-kt/sdk.git
synced 2026-10-30 20:43:57 +00:00
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and Android. Generated with openapi-generator kotlin (library=jvm-okhttp4, useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai. Co-authored-by: Hanzo Dev <[email protected]>
2.2 KiB
2.2 KiB
NotifySendRequest
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| to | kotlin.collections.List<kotlin.String> | Destination address(es). Phone number for SMS, email for email. Multiple recipients fan out into one provider call each and produce one response entry per recipient. | |
| channel | NotifyChannel | [optional] | |
| provider | kotlin.String | Pins a specific provider service name (e.g. `twilio`, `plivo`, `twilio_email`, `mail`). When omitted the fold picks the org's default for the channel from configured KMS credentials. | [optional] |
| subject | kotlin.String | Raw subject; used verbatim when `body` is set (no-template path). | [optional] |
| body | kotlin.String | Raw message body. When non-empty it wins verbatim and no template is rendered. | [optional] |
| templateId | kotlin.String | Built-in template identifier. When `body` is empty, the template is resolved from `template_id` or, failing that, `event`. | [optional] |
| templateVars | kotlin.collections.Map<kotlin.String, kotlin.Any> | Free-form variables the template is rendered against (e.g. `otp`, `app`, `recipient`). A missing `app` defaults to `Hanzo`. | [optional] |
| event | kotlin.String | Event-catalog identifier. Also used as a fallback template id when `template_id` is unset (the IAM OTP path sends `event: iam.otp_sent` with no `template_id`). | [optional] |
| idempotencyKey | kotlin.String | Per-tenant deduplication key. Accepted on the wire; the sync fold does not persist a Message row. | [optional] |
| sendAt | kotlin.String | RFC3339 schedule time for async dispatch. Async is not available in the fold, so a set value has no effect on the sync path. | [optional] |
| options | kotlin.collections.Map<kotlin.String, kotlin.Any> | Free-form per-provider knob bag. | [optional] |