unione 1.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 966428a227c0701201a9efb14fb683d891df950a2cc1e446fda99113eca0b2b6
+  data.tar.gz: 9664b54ea7723c2172e47fdd062468610505fcc24f040d5fae1e5f8e1e364697
+SHA512:
+  metadata.gz: 8f1a2f280c5d7066e0b033c8ab86de1e647540e3a73c9232b189c83e2d8798cb3ad55134b2c276ed3898dfa5e956592cb8ac233c660631dab7452881bc9afed3
+  data.tar.gz: f36d07366d6b07d739d0f91268e2ef0a9e5dffe7f60bc99006aade3a926983b52f378d3a44e3fc23f43911d47e1b673094d0f378ca77ab260cb19fdb154b33fa

data/AGENTS.md

@@ -0,0 +1,99 @@
+# AGENTS.md
+
+UniOne Ruby SDK — client for the UniOne transactional email Web API (Web API 1.90).
+
+## Working on this repository
+
+- **Generated code.** The whole package is generated by the UniOne team from the UniOne Web API OpenAPI spec (Web API 1.90): sources, docs, README.md and this file. Do not hand-edit it: the next release replaces the content of this repository. Report problems and requests in the issues of this repository (https://github.com/unione-repo/unione-ruby-sdk).
+- **Build and check:**
+
+  ```bash
+  gem build *.gemspec
+  ```
+
+- **Source label.** Every request carries the query parameter `platform=ruby-sdk.1.1.3`, added in one place, the shared request client (`ApiClient`); a package built on this SDK puts its own label in front: `<package>.<version>,ruby-sdk.1.1.3`.
+- **Tests.** Before a release the generator builds and lints the package and runs every example of docs/ and of this file against a mock of the API: no real API key, no real sends.
+- **Release.** The version (1.1.3 in the gemspec) and the tag `v1.1.3` come from the generator; README.md states the Web API version the release was generated from.
+- **Secrets.** Never commit API keys; the examples read `UNIONE_API_KEY` from the environment.
+
+## Integrating UniOne with this SDK
+
+Full quickstart: [README.md](README.md). Install:
+
+```bash
+gem install unione
+```
+
+Requirements: Ruby 2.7+.
+
+If the project is built on one of these frameworks, install its package instead: it brings this SDK and plugs it into the framework (configuration, client in the container, mailer, webhooks).
+
+| Framework | Package | Guide |
+|---|---|---|
+| Ruby on Rails | `unione-rails` | [AGENTS.md](https://github.com/unione-repo/unione-rails/blob/HEAD/AGENTS.md) |
+
+Rules that generated code must follow:
+
+- Server-side only. Read the API key from `UNIONE_API_KEY`; never put it in browser or mobile code, never commit it.
+- Base URL `https://api.unione.io/en/transactional/api/v1` (an account registered on another host uses that one: `eu1.unione.io`, `us1.unione.io`); every method is POST with a JSON body; auth header `X-API-KEY`. The SDK does all of it.
+- First email without DNS: `domain/get-sandbox-domain` → `confirmed-email/create` (the user clicks the link within 48 hours) → `email/send` from `noreply@<sandbox-domain>` to the confirmed address. Account API key only; up to 10 confirmed addresses, 100 emails a day; the domain expires after 31 days.
+- Never ship a sandbox domain as the production sender (it is not in `domain/list`); read `from_email` from config. Production needs a verified domain: `domain/get-dns-records` → DNS records → `domain/validate-verification-record`, `domain/validate-dkim` → `domain/list`.
+- Set `message.idempotence_key` on retryable sends; retry network errors, `429` and `5xx` with backoff, not other errors unchanged. Up to 500 recipients and 10 MB per request, each attachment up to 7 MB; always `body.html` or `body.plaintext`.
+- Delivery events via webhook (`webhook/set`) with a fast, idempotent HTTPS handler, not polling; check the `auth` field of every notification: the MD5 of the request body with the `auth` value replaced by the API key.
+- Keep the default unsubscribe and tracking behaviour; changes go through UniOne support.
+- Do not invent methods or fields. Check [docs/](docs/) of this package, the [API reference](https://docs.unione.io/en/web-api-ref) or [llms.txt](https://docs.unione.io/llms.txt).
+
+### Send an email
+
+The client reads the API key from `UNIONE_API_KEY`:
+
+```ruby
+require 'unione'
+
+Common = UniOne::Common::Model
+Email = UniOne::Api::Email::Model
+
+client = UniOne.client(ENV.fetch('UNIONE_API_KEY'))
+
+response = client.email.send_email(Email::EmailSendRequest.new(
+  message: Email::MessageObject.new(
+    recipients: [
+      Email::MessageObjectRecipientsItem.new(
+        email: 'user@example.com',
+        substitutions: {
+          'CustomerId' => '12452',
+          'to_name' => 'John Smith',
+        }
+      )
+    ],
+    body: Common::BodyObject.new(
+      html: '<b>Hello, {{to_name}}</b>',
+      plaintext: 'Hello, {{to_name}}'
+    ),
+    subject: 'UniOne test email ',
+    from_email: 'email@example.com',
+    from_name: 'John Smith'
+  )
+))
+p response.job_id
+```
+
+### Errors
+
+Every method throws `ApiError` when the request fails: the HTTP status (0 for a network error or a timeout), the [API error code](https://docs.unione.io/en/web-api-ref#api-errors) and the message.
+
+```ruby
+# client created as above
+begin
+  client.system.ping
+rescue UniOne::Client::ApiError => e
+  # http_status is 0 for a network error or a timeout
+  warn "#{e.http_status} #{e.error_code} #{e.message}"
+end
+```
+
+### Reference
+
+- Methods and models of every section: [Email](docs/Email.md), [EmailValidation](docs/EmailValidation.md), [ConfirmedEmail](docs/ConfirmedEmail.md), [Template](docs/Template.md), [Webhook](docs/Webhook.md), [Suppression](docs/Suppression.md), [Domain](docs/Domain.md), [EventDump](docs/EventDump.md), [Tag](docs/Tag.md), [Project](docs/Project.md), [System](docs/System.md), [Obsolete](docs/Obsolete.md)
+- [API reference](https://docs.unione.io/en/web-api-ref)
+- [Full API reference for LLMs](https://docs.unione.io/llms-full.txt)

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 UniOne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,270 @@
+# UniOne Ruby SDK 1.1.3
+
+Web API 1.90
+
+Official Ruby library for the [UniOne](https://unione.io) transactional email API.
+
+Quickstart guide: [Send emails with Ruby](https://docs.unione.io/en/send-with-ruby) · Docs for LLMs: [llms.txt](https://docs.unione.io/llms.txt) · [API reference](https://docs.unione.io/en/web-api-ref)
+
+## Install
+
+```bash
+gem install unione
+```
+
+Requirements: Ruby 2.7+. No third-party dependencies.
+
+## Get an API key
+
+1. Sign up at [cp.unione.io](https://cp.unione.io/en/user/registration/).
+2. Copy your API key from [Settings → Security → API](https://cp.unione.io/en/settings/security/api).
+3. Put it in an environment variable:
+
+```bash
+export UNIONE_API_KEY="your-api-key"
+```
+
+> **Server-side only.** Use this SDK in backend code: API routes, server functions, workers.
+> Never ship the API key to a browser or a mobile app, and never commit it.
+
+## Send your first email — no DNS setup
+
+Every account can send test email right away from a **sandbox domain**: pre-verified, DKIM and SPF already set.
+It delivers only to addresses you confirm.
+
+<!-- checked examples -->
+
+**1. Get your sandbox domain** (`domain/get-sandbox-domain`). The call creates the domain on first use and returns the same one afterwards.
+
+```ruby
+require 'unione'
+
+client = UniOne.client(ENV.fetch('UNIONE_API_KEY'))
+
+response = client.domain.get_sandbox_domain
+p response.domain
+```
+
+**2. Confirm your inbox** (`confirmed-email/create`). UniOne sends a confirmation email; click the link in it within 48 hours.
+
+```ruby
+require 'unione'
+
+ConfirmedEmail = UniOne::Api::ConfirmedEmail::Model
+
+client = UniOne.client(ENV.fetch('UNIONE_API_KEY'))
+
+response = client.confirmed_email.create(ConfirmedEmail::ConfirmedEmailRequest.new(
+  email: 'you@example.com'
+))
+p response.confirmed_email
+```
+
+Check the status with `confirmed-email/list` — your address should show `"status": "confirmed"`.
+
+**3. Send the email** (`email/send`) from any address on the sandbox domain to the confirmed address.
+
+```ruby
+require 'unione'
+
+Common = UniOne::Common::Model
+Email = UniOne::Api::Email::Model
+
+client = UniOne.client(ENV.fetch('UNIONE_API_KEY'))
+
+response = client.email.send_email(Email::EmailSendRequest.new(
+  message: Email::MessageObject.new(
+    recipients: [
+      Email::MessageObjectRecipientsItem.new(
+        email: 'you@example.com'
+      )
+    ],
+    body: Common::BodyObject.new(
+      html: '<p>It works!</p>'
+    ),
+    subject: 'Hello from UniOne',
+    from_email: 'noreply@<sandbox-domain>'
+  )
+))
+p response.job_id
+```
+
+<!-- /checked examples -->
+
+### What you get back
+
+```json
+{
+  "status": "success",
+  "job_id": "1ZymBc-00041N-9X",
+  "emails": [
+    "you@example.com"
+  ]
+}
+```
+
+On error the API returns `status: "error"`, a `message` and a numeric `code`:
+
+```json
+{
+  "status": "error",
+  "code": 102,
+  "message": "Error ID:83274F98-C7D5-11F1-B221-6214FF8707B1. Can not decode key wrongkey"
+}
+```
+
+### Same flow with curl
+
+```bash
+BASE=https://api.unione.io/en/transactional/api/v1
+
+curl -s -X POST $BASE/domain/get-sandbox-domain.json \
+  -H "Content-Type: application/json" -H "X-API-KEY: $UNIONE_API_KEY" -d '{}'
+
+curl -s -X POST $BASE/confirmed-email/create.json \
+  -H "Content-Type: application/json" -H "X-API-KEY: $UNIONE_API_KEY" \
+  -d '{"email": "you@example.com"}'
+
+curl -s -X POST $BASE/email/send.json \
+  -H "Content-Type: application/json" -H "X-API-KEY: $UNIONE_API_KEY" \
+  -d '{
+        "message": {
+          "recipients": [
+            {
+              "email": "you@example.com"
+            }
+          ],
+          "from_email": "noreply@<sandbox-domain>",
+          "subject": "Hello from UniOne",
+          "body": {
+            "html": "<p>It works!</p>"
+          }
+        }
+      }'
+```
+
+## Sandbox limits
+
+- Sends only to confirmed addresses: up to 10 per account.
+- Up to 100 emails a day.
+- The sandbox domain expires after 31 days; call `domain/get-sandbox-domain` again to get a new one.
+- Works only with the account API key, not a project key.
+- Not listed in `domain/list`; the other `domain/*` methods do not apply to it.
+
+The sandbox is for development and testing. Do not use a sandbox domain as the sender in production.
+
+## Before production: verify your domain
+
+1. `domain/get-dns-records` — returns the values for your DNS records.
+2. Add these records at your DNS provider (the domain page of the control panel shows them too):
+
+   | Type | Host | Value |
+   |---|---|---|
+   | TXT | `@` | the `verification-record` value (`unione-validate-hash=…`) |
+   | TXT | `<selector>._domainkey` (the selector is on the domain page of the control panel, e.g. `us`) | `v=DKIM1; k=rsa; p=<dkim>` |
+   | TXT | `@` | `v=spf1 include:spf.unione.io ~all` |
+   | CNAME | `_dmarc` | the `dmarc` value |
+
+3. `domain/validate-verification-record`, then `domain/validate-dkim`.
+4. `domain/list` — wait until the verification record is confirmed and DKIM is active.
+5. Read `from_email` from your config, so switching from the sandbox needs no code change.
+
+## Sending reliably
+
+- **Retries:** set `message.idempotence_key` on sends that may be retried, so a repeated request does not send twice.
+- **Limits:** up to 500 recipients and 10 MB per request; each attachment up to 7 MB.
+- **Body:** always include `body.html` or `body.plaintext`.
+- **Delivery status:** register a webhook (`webhook/set`) with a fast, idempotent HTTPS handler instead of polling.
+- **Defaults:** keep the default unsubscribe footer and tracking; changing them requires UniOne support.
+- **Errors:** retry `429` and `5xx` with backoff; do not retry other errors unchanged.
+
+## Links
+
+- [Send emails with Ruby](https://docs.unione.io/en/send-with-ruby) and other [integration guides](https://docs.unione.io/en/integrations/)
+- [Web API reference](https://docs.unione.io/en/web-api-ref)
+- [llms.txt](https://docs.unione.io/llms.txt) for AI coding agents
+- [UniOne MCP server and agent setup](https://unione.io/en/agents)
+- [Support](https://cp.unione.io/en/support)
+
+## For SDK contributors
+
+See [AGENTS.md](AGENTS.md): how this SDK is generated from the OpenAPI spec, built, tested and released.
+
+---
+
+# SDK reference
+
+## API host
+
+The second argument selects the API host (datacenter) or a full base URL.
+
+```ruby
+require 'unione'
+
+client = UniOne.client('YOUR_API_KEY', 'us1.unione.io')
+client = UniOne.client('YOUR_API_KEY', UniOne::Client::Configuration::HOST_US1)
+```
+
+## Custom HTTP client / headers
+
+`headers:` adds HTTP headers to every request. `transport:` replaces the HTTP layer: any object responding to `call(method, uri, headers, body, timeout)` that returns `[status, body]` (a lambda works too). Wrap the default `Client::NetHttpTransport` for retries or logging, or call Faraday / HTTParty in your own one; an exception of the transport becomes `ApiError`.
+
+```ruby
+require 'unione'
+
+# Logs every request and retries network failures and HTTP 5xx.
+class RetryTransport
+  def initialize(inner = UniOne::Client::NetHttpTransport.new, attempts: 3)
+    @inner = inner
+    @attempts = attempts
+  end
+
+  def call(method, uri, headers, body, timeout)
+    (1..@attempts).each do |attempt|
+      puts "#{method} #{uri}"
+      begin
+        status, raw = @inner.call(method, uri, headers, body, timeout)
+        return [status, raw] if status < 500 || attempt == @attempts
+      rescue StandardError
+        raise if attempt == @attempts
+      end
+      sleep attempt
+    end
+  end
+end
+
+client = UniOne.client('YOUR_API_KEY', transport: RetryTransport.new, headers: { 'X-Request-Id' => '42' })
+```
+
+Models with free-form keys (`HeadersObject`) have an `extra` hash: its keys go next to the named fields.
+
+```ruby
+require 'unione'
+
+headers = UniOne::Common::Model::HeadersObject.new(extra: {
+  'X-MyHeader' => 'some data',
+  'CC' => 'copy@example.com',
+  'List-Unsubscribe' => '<mailto:unsubscribe@example.com>'
+})
+```
+
+## Error handling
+
+Every method raises `ApiError` when the API returns an error; it carries the [API error code](https://docs.unione.io/en/web-api-ref#api-errors) and the HTTP status.
+
+## Sections
+
+| Section | Methods | Description |
+|---|---|---|
+| [Email](docs/Email.md) | `send_email`, `subscribe` | This group of methods is related with email sending. |
+| [EmailValidation](docs/EmailValidation.md) | `single` | Email validation methods. As a result of the check, you’ll get detailed information on email validity. It will help eliminate nonexistent emails, decrease the number of complaints, clean up the subscribers list and eventually enhance your sender reputation score. For example, you may add validation to a subscription form on your site to let users know they’ve just entered an invalid address. |
+| [ConfirmedEmail](docs/ConfirmedEmail.md) | `create`, `list`, `delete` | Manage email addresses confirmed for sandbox-domain sending. These methods are available only with a main account API key. |
+| [Template](docs/Template.md) | `set`, `get`, `list`, `delete` | You have the option of storing a template on the UniOne side and then using it by id, which is highly recommended for sending repetitive messages or high volume traffic. UniOne supports two different [template engines](https://docs.unione.io/en/template-engines). |
+| [Webhook](docs/Webhook.md) | `set`, `get`, `list`, `delete` | UniOne lets you recieve notifications about email status changes or spam blocks. You provide an URL and every time a watched event occurs we will notify you by submitting a request with JSON data to this URL. |
+| [Suppression](docs/Suppression.md) | `set`, `get`, `list`, `delete` | Methods for managing suppression lists. An email can be added to suppression list because of unsubscription, bounce or complain. |
+| [Domain](docs/Domain.md) | `get_dns_records`, `validate_verification_record`, `validate_dkim`, `list`, `get_sandbox_domain`, `delete` | You can use these methods to setup sender domains and check their statuses. They might be useful in case you want to automate adding domains for your own clients. |
+| [EventDump](docs/EventDump.md) | `create`, `get`, `list`, `delete` | These methods are used to obtain a list of events for a given period of time. The data is stored for up to 45 days, depending on your tariff, i. e. you may fetch all event data starting from 00:00:00 31 days ago and up to current time. For custom tarifs with big sending volumes event dumps are available only for the last 7 days. |
+| [Tag](docs/Tag.md) | `list`, `delete` | This family of methods is used to manage user-defined tags. Tags are used to categorize letters based on your own criteria, e. g. to create a distinction between marketing and transactional letters or group together all notifications for a particular order type. UniOne allows you to assign tags to all outgoing emails, and the tags you’ve set may then be used to filter and analyze delivery statistics. |
+| [Project](docs/Project.md) | `create`, `update`, `list`, `delete` | Projects allow you to group several independent domains, webhooks, templates, and unsubscription lists together. It's very useful if you have your own clients and manage their data from a single UniOne account. Each project receives its own API key, and all API calls with that API key only deal with the data of that project. This way, you can assign a separate project for each client and be sure that they won't conflict; e.g. unsubscribing from one project won't affect another. |
+| [System](docs/System.md) | `ping`, `info` | System operations. |
+| [Obsolete](docs/Obsolete.md) | `unsubscribed_set`, `unsubscribed_check`, `unsubscribed_list` | Obsolete methods dealing with unsubscribes. We recommend using the more flexible [suppression](https://docs.unione.io/en/web-api-ref#suppression) methods instead. Note that you can't resubscribe an unsubscribed recipient using WebAPI, but you can send him an email with subscription link using email/subscribe method. |

data/docs/ConfirmedEmail.md

@@ -0,0 +1,109 @@
+# ConfirmedEmail
+
+[Back to the list of sections](../README.md)
+
+Manage email addresses confirmed for sandbox-domain sending. These methods are available only with a main account API key.
+
+`UniOne::Api::ConfirmedEmail::ConfirmedEmailApi`, `client.confirmed_email`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`create`](#create) | `POST /confirmed-email/create.json` | Adds an email address and sends a confirmation link. |
+| [`list`](#list) | `POST /confirmed-email/list.json` | Lists confirmed and unconfirmed email addresses for the account. |
+| [`delete`](#delete) | `POST /confirmed-email/delete.json` | Deletes an email address from the account's confirmed email list. |
+
+## create
+
+`POST /confirmed-email/create.json` · [Documentation](https://docs.unione.io/en/web-api-ref#confirmed-email-create)
+
+Adds an email address and sends a confirmation link.
+
+### Request: `ConfirmedEmailRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `String` | yes | Email address to add or delete. |
+
+### Response: `ConfirmedEmailCreateResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `confirmed_email` | `ConfirmedEmail` |  |
+
+### Example
+
+```ruby
+require 'unione'
+
+ConfirmedEmail = UniOne::Api::ConfirmedEmail::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.confirmed_email.create(ConfirmedEmail::ConfirmedEmailRequest.new(
+  email: 'dev@example.com'
+))
+p response.confirmed_email
+```
+
+## list
+
+`POST /confirmed-email/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#confirmed-email-list)
+
+Lists confirmed and unconfirmed email addresses for the account.
+
+### Request
+
+The method has no parameters.
+
+### Response: `ConfirmedEmailListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `confirmed_emails` | `Array<ConfirmedEmail>` |  |
+
+### Example
+
+```ruby
+require 'unione'
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.confirmed_email.list
+p response.confirmed_emails
+```
+
+## delete
+
+`POST /confirmed-email/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#confirmed-email-delete)
+
+Deletes an email address from the account's confirmed email list.
+
+### Request: `ConfirmedEmailRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `String` | yes | Email address to add or delete. |
+
+### Response: `ConfirmedEmailDeleteResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `message` | `String` |  |
+
+### Example
+
+```ruby
+require 'unione'
+
+ConfirmedEmail = UniOne::Api::ConfirmedEmail::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.confirmed_email.delete(ConfirmedEmail::ConfirmedEmailRequest.new(
+  email: 'dev@example.com'
+))
+p response.message
+```