norbelys 0.1.0

data/docs/MessagesApi.md

@@ -0,0 +1,543 @@
+# Norbelys::MessagesApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**messages_attachment**](MessagesApi.md#messages_attachment) | **GET** /messages/{id}/attachments/{attachmentId} | Download a message attachment |
+| [**messages_attachments**](MessagesApi.md#messages_attachments) | **GET** /messages/{id}/attachments | List a message's attachments |
+| [**messages_create**](MessagesApi.md#messages_create) | **POST** /messages | Send a message |
+| [**messages_find**](MessagesApi.md#messages_find) | **GET** /messages/{id} | Get a message |
+| [**messages_list**](MessagesApi.md#messages_list) | **GET** /messages | List messages |
+| [**messages_source**](MessagesApi.md#messages_source) | **GET** /messages/{id}/source | Get a sent message's source |
+| [**messages_update**](MessagesApi.md#messages_update) | **PATCH** /messages/{id} | Triage an inbound message |
+
+
+## messages_attachment
+
+> <MessageAttachmentDownload> messages_attachment(id, attachment_id)
+
+Download a message attachment
+
+Download one attachment's Base64 content by its id from the attachments list — works for both sent (read from the immutable R2 source) and received (saved at ingest) messages.
+
+### Examples
+
+```ruby
+require 'time'
+require 'norbelys'
+# setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Norbelys::MessagesApi.new
+id = 'id_example' # String | 
+attachment_id = 'attachment_id_example' # String | 
+
+begin
+  # Download a message attachment
+  result = api_instance.messages_attachment(id, attachment_id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_attachment: #{e}"
+end
+```
+
+#### Using the messages_attachment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageAttachmentDownload>, Integer, Hash)> messages_attachment_with_http_info(id, attachment_id)
+
+```ruby
+begin
+  # Download a message attachment
+  data, status_code, headers = api_instance.messages_attachment_with_http_info(id, attachment_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageAttachmentDownload>
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_attachment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **attachment_id** | **String** |  |  |
+
+### Return type
+
+[**MessageAttachmentDownload**](MessageAttachmentDownload.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## messages_attachments
+
+> <MessageAttachmentList> messages_attachments(id)
+
+List a message's attachments
+
+List every file carried on a sent or received message — metadata only; fetch each file's content with messages.attachment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'norbelys'
+# setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Norbelys::MessagesApi.new
+id = 'id_example' # String | 
+
+begin
+  # List a message's attachments
+  result = api_instance.messages_attachments(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_attachments: #{e}"
+end
+```
+
+#### Using the messages_attachments_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageAttachmentList>, Integer, Hash)> messages_attachments_with_http_info(id)
+
+```ruby
+begin
+  # List a message's attachments
+  data, status_code, headers = api_instance.messages_attachments_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageAttachmentList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_attachments_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**MessageAttachmentList**](MessageAttachmentList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## messages_create
+
+> <Message> messages_create(message_create_params, opts)
+
+Send a message
+
+Send a real email — the one send door for all outbound mail. `from` is a sender id (snd_…) or any address on a provisioned sending domain (e.g. \"david@hola.com\" or \"Acme <david@hola.com>\"; the identity is created on first use). Provide content inline (subject + html/text) or render a stored template with variantId + data. Reply to an inbound message by passing inReplyTo (the send threads to that conversation); set test:true for a one-off preview that is excluded from campaign stats. For a paced (cold) sender, pass sequence to enroll the person instead of sending now.
+
+### Examples
+
+```ruby
+require 'time'
+require 'norbelys'
+# setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Norbelys::MessagesApi.new
+message_create_params = Norbelys::MessageCreateParams.new({from: 'from_example', to: 'to_example', sequence: 'sequence_example', in_reply_to: 'in_reply_to_example', test: 3.56}) # MessageCreateParams | 
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+}
+
+begin
+  # Send a message
+  result = api_instance.messages_create(message_create_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_create: #{e}"
+end
+```
+
+#### Using the messages_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Message>, Integer, Hash)> messages_create_with_http_info(message_create_params, opts)
+
+```ruby
+begin
+  # Send a message
+  data, status_code, headers = api_instance.messages_create_with_http_info(message_create_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Message>
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_create_params** | [**MessageCreateParams**](MessageCreateParams.md) |  |  |
+| **idempotency_key** | **String** | Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST. | [optional] |
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## messages_find
+
+> <Message> messages_find(id)
+
+Get a message
+
+Read one message by id — an outbound send or an inbound reply.
+
+### Examples
+
+```ruby
+require 'time'
+require 'norbelys'
+# setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Norbelys::MessagesApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a message
+  result = api_instance.messages_find(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_find: #{e}"
+end
+```
+
+#### Using the messages_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Message>, Integer, Hash)> messages_find_with_http_info(id)
+
+```ruby
+begin
+  # Get a message
+  data, status_code, headers = api_instance.messages_find_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Message>
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## messages_list
+
+> <MessageList> messages_list(opts)
+
+List messages
+
+List the unified message log — outbound and inbound interleaved by time, newest first. Pass direction=inbound for the unibox (replies only), senderId for one mailbox's full history, or programId / personId / threadId to scope; filter by status, classification, isRead, or channel.
+
+### Examples
+
+```ruby
+require 'time'
+require 'norbelys'
+# setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Norbelys::MessagesApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  include_archived: true, # Boolean | 
+  channel: 'email', # String | 
+  classification: 'interested', # String | 
+  dir: 'asc', # String | 
+  direction: 'outbound', # String | 
+  email: 'email_example', # String | 
+  is_read: true, # Boolean | 
+  limit: 56, # Integer | 
+  order_by: 'occurredAt', # String | 
+  page: 56, # Integer | 
+  person_id: 'person_id_example', # String | 
+  program_id: 'program_id_example', # String | 
+  search: 'search_example', # String | 
+  sender_id: 'sender_id_example', # String | 
+  status: 'queued', # String | 
+  step_id: 'step_id_example', # String | 
+  thread_id: 'thread_id_example' # String | 
+}
+
+begin
+  # List messages
+  result = api_instance.messages_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_list: #{e}"
+end
+```
+
+#### Using the messages_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageList>, Integer, Hash)> messages_list_with_http_info(opts)
+
+```ruby
+begin
+  # List messages
+  data, status_code, headers = api_instance.messages_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **include_archived** | **Boolean** |  | [optional] |
+| **channel** | **String** |  | [optional] |
+| **classification** | **String** |  | [optional] |
+| **dir** | **String** |  | [optional] |
+| **direction** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **is_read** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **order_by** | **String** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **person_id** | **String** |  | [optional] |
+| **program_id** | **String** |  | [optional] |
+| **search** | **String** |  | [optional] |
+| **sender_id** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **step_id** | **String** |  | [optional] |
+| **thread_id** | **String** |  | [optional] |
+
+### Return type
+
+[**MessageList**](MessageList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## messages_source
+
+> <MessageSource> messages_source(id)
+
+Get a sent message's source
+
+Return the exact bytes that left — the fully personalized email (final subject, HTML and text, with tracking and footer applied) as persisted to R2 at send time. Outbound messages only; inbound bodies ride on the message itself.
+
+### Examples
+
+```ruby
+require 'time'
+require 'norbelys'
+# setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Norbelys::MessagesApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a sent message's source
+  result = api_instance.messages_source(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_source: #{e}"
+end
+```
+
+#### Using the messages_source_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageSource>, Integer, Hash)> messages_source_with_http_info(id)
+
+```ruby
+begin
+  # Get a sent message's source
+  data, status_code, headers = api_instance.messages_source_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageSource>
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_source_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**MessageSource**](MessageSource.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## messages_update
+
+> <Message> messages_update(id, opts)
+
+Triage an inbound message
+
+Triage an inbound reply: mark it read or unread, re-classify its intent, and/or assign it to a teammate. Inbound messages only.
+
+### Examples
+
+```ruby
+require 'time'
+require 'norbelys'
+# setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Norbelys::MessagesApi.new
+id = 'id_example' # String | 
+opts = {
+  message_update_params: Norbelys::MessageUpdateParams.new # MessageUpdateParams | 
+}
+
+begin
+  # Triage an inbound message
+  result = api_instance.messages_update(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_update: #{e}"
+end
+```
+
+#### Using the messages_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Message>, Integer, Hash)> messages_update_with_http_info(id, opts)
+
+```ruby
+begin
+  # Triage an inbound message
+  data, status_code, headers = api_instance.messages_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Message>
+rescue Norbelys::ApiError => e
+  puts "Error when calling MessagesApi->messages_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **message_update_params** | [**MessageUpdateParams**](MessageUpdateParams.md) |  | [optional] |
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MonthlyEmailUsageMeter.md

@@ -0,0 +1,24 @@
+# Norbelys::MonthlyEmailUsageMeter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **level** | **String** | `ok`, `near` (~80% of the cap used) or `reached` (at/over the cap). Example: `near`. |  |
+| **limit** | **Integer** |  |  |
+| **used** | **Integer** | Current usage against the cap. Example: 4. |  |
+| **month** | **String** | UTC calendar month being counted. Example: \"2026-07\". |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MonthlyEmailUsageMeter.new(
+  level: null,
+  limit: null,
+  used: null,
+  month: null
+)
+```
+

data/docs/Organization.md

@@ -0,0 +1,30 @@
+# Norbelys::Organization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alerts** | [**OrganizationAlerts**](OrganizationAlerts.md) |  |  |
+| **bounce_policy** | [**OrganizationBouncePolicy**](OrganizationBouncePolicy.md) |  |  |
+| **name** | **String** | The organization display name. |  |
+| **onboarding** | [**OrganizationOnboarding**](OrganizationOnboarding.md) |  |  |
+| **org_id** | **String** | The organization id. |  |
+| **profile** | [**OrganizationProfile**](OrganizationProfile.md) |  |  |
+| **tenant_ready** | **Boolean** | Whether the organization is fully provisioned and active. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Organization.new(
+  alerts: null,
+  bounce_policy: null,
+  name: null,
+  onboarding: null,
+  org_id: null,
+  profile: null,
+  tenant_ready: null
+)
+```
+

data/docs/OrganizationAlerts.md

@@ -0,0 +1,18 @@
+# Norbelys::OrganizationAlerts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deliverability** | **Boolean** | Email the org admin when a domain starts failing DMARC, DNS verification breaks, or a mailbox's reputation goes bad. Default: true. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationAlerts.new(
+  deliverability: null
+)
+```
+

data/docs/OrganizationAlertsParams.md

@@ -0,0 +1,18 @@
+# Norbelys::OrganizationAlertsParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deliverability** | **Boolean** | Turn the deliverability alert email on/off. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationAlertsParams.new(
+  deliverability: null
+)
+```
+