norbelys 0.1.0

data/docs/SendersApi.md

@@ -0,0 +1,531 @@
+# Norbelys::SendersApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**senders_bulk**](SendersApi.md#senders_bulk) | **POST** /senders/bulk | Bulk-update senders |
+| [**senders_create**](SendersApi.md#senders_create) | **POST** /senders | Connect a sender |
+| [**senders_find**](SendersApi.md#senders_find) | **GET** /senders/{id} | Get a sender |
+| [**senders_list**](SendersApi.md#senders_list) | **GET** /senders | List senders |
+| [**senders_remove**](SendersApi.md#senders_remove) | **DELETE** /senders/{id} | Delete or archive a sender |
+| [**senders_restore**](SendersApi.md#senders_restore) | **POST** /senders/{id}/restore | Restore an archived sender |
+| [**senders_update**](SendersApi.md#senders_update) | **PATCH** /senders/{id} | Update a sender |
+
+
+## senders_bulk
+
+> <BulkUpdateSendersResult> senders_bulk(bulk_update_senders_input, opts)
+
+Bulk-update senders
+
+Apply ONE patch to MANY mailboxes at once, in a single call: pacing (dailyLimit, minGapMinutes), lifecycle (pause/resume via state), warmup, or operator labels. Use this whenever the same change goes to several senders (e.g. 'set every sender to 50/day', 'pause all senders') INSTEAD of calling update once per mailbox. It cannot change credentials or transport, so it never sends a verification email. Returns how many updated plus any per-mailbox errors. Note: a mailbox has NO per-mailbox clock-time send window for campaigns — the daily sending window and timezone belong to the CAMPAIGN (program), so 'make each sender send at a different hour' means splitting senders across campaigns with different windows, not a sender edit.
+
+### 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::SendersApi.new
+bulk_update_senders_input = Norbelys::BulkUpdateSendersInput.new({ids: ['ids_example'], patch: Norbelys::BulkUpdateSenderPatch.new}) # BulkUpdateSendersInput | 
+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
+  # Bulk-update senders
+  result = api_instance.senders_bulk(bulk_update_senders_input, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_bulk: #{e}"
+end
+```
+
+#### Using the senders_bulk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkUpdateSendersResult>, Integer, Hash)> senders_bulk_with_http_info(bulk_update_senders_input, opts)
+
+```ruby
+begin
+  # Bulk-update senders
+  data, status_code, headers = api_instance.senders_bulk_with_http_info(bulk_update_senders_input, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkUpdateSendersResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_bulk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_update_senders_input** | [**BulkUpdateSendersInput**](BulkUpdateSendersInput.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
+
+[**BulkUpdateSendersResult**](BulkUpdateSendersResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## senders_create
+
+> <Sender> senders_create(create_sender_input, opts)
+
+Connect a sender
+
+Connect a mailbox from its SMTP/IMAP (or managed-provider) credentials. The save auto-verifies by sending a real test email from the mailbox and is rejected if it cannot send — connecting is verifying, so there is no separate verify or test step. Omit sendingDomainId to get-or-create the sending domain from the fromEmail host.
+
+### 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::SendersApi.new
+create_sender_input = Norbelys::CreateSenderInput.new({from_email: 'from_email_example', from_name: 'from_name_example', smtp: Norbelys::SmtpConnectionSettings.new({host: 'host_example', port: 37}), transport_mode: 3.56, transport_provider: 'transport_provider_example'}) # CreateSenderInput | 
+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
+  # Connect a sender
+  result = api_instance.senders_create(create_sender_input, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_create: #{e}"
+end
+```
+
+#### Using the senders_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Sender>, Integer, Hash)> senders_create_with_http_info(create_sender_input, opts)
+
+```ruby
+begin
+  # Connect a sender
+  data, status_code, headers = api_instance.senders_create_with_http_info(create_sender_input, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Sender>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_sender_input** | [**CreateSenderInput**](CreateSenderInput.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
+
+[**Sender**](Sender.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## senders_find
+
+> <SenderDetail> senders_find(id, opts)
+
+Get a sender
+
+Return one mailbox. Use `expand[]=usage` to inline its send/receive/campaign history counts (the preview that drives delete-vs-archive) and `expand[]=warmup` for the warmup config plus today's slot tally.
+
+### 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::SendersApi.new
+id = 'id_example' # String | 
+opts = {
+  expand: [['usage']] # Array<String> | 
+}
+
+begin
+  # Get a sender
+  result = api_instance.senders_find(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_find: #{e}"
+end
+```
+
+#### Using the senders_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SenderDetail>, Integer, Hash)> senders_find_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get a sender
+  data, status_code, headers = api_instance.senders_find_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SenderDetail>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **expand** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+
+### Return type
+
+[**SenderDetail**](SenderDetail.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## senders_list
+
+> <SenderList> senders_list(opts)
+
+List senders
+
+List the mailboxes (senders) on this workspace. Filter by `search` (matches fromName, fromEmail and clientLabel), `state[]`, `reputation[]`, or `sendingDomainId`; the page carries `total` for page / totalPages.
+
+### 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::SendersApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  include_archived: true, # Boolean | 
+  limit: 56, # Integer | 
+  reputation: [['good']], # Array<String> | 
+  search: 'search_example', # String | 
+  sending_domain_id: 'sending_domain_id_example', # String | 
+  state: [['healthy']] # Array<String> | 
+}
+
+begin
+  # List senders
+  result = api_instance.senders_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_list: #{e}"
+end
+```
+
+#### Using the senders_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SenderList>, Integer, Hash)> senders_list_with_http_info(opts)
+
+```ruby
+begin
+  # List senders
+  data, status_code, headers = api_instance.senders_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SenderList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **include_archived** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **reputation** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **search** | **String** |  | [optional] |
+| **sending_domain_id** | **String** |  | [optional] |
+| **state** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+
+### Return type
+
+[**SenderList**](SenderList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## senders_remove
+
+> <SenderRemoveResult> senders_remove(id)
+
+Delete or archive a sender
+
+The smart delete: a mailbox with no history is hard-deleted, one with sends, replies, or campaigns is soft-archived instead — the response's outcome says which happened. Archived mailboxes can be restored.
+
+### 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::SendersApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete or archive a sender
+  result = api_instance.senders_remove(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_remove: #{e}"
+end
+```
+
+#### Using the senders_remove_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SenderRemoveResult>, Integer, Hash)> senders_remove_with_http_info(id)
+
+```ruby
+begin
+  # Delete or archive a sender
+  data, status_code, headers = api_instance.senders_remove_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SenderRemoveResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_remove_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**SenderRemoveResult**](SenderRemoveResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## senders_restore
+
+> <Sender> senders_restore(id, opts)
+
+Restore an archived sender
+
+Un-archive a mailbox (clears its soft-delete). Connecting is verifying — a restored OAuth mailbox may need to reconnect before it can send again.
+
+### 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::SendersApi.new
+id = 'id_example' # String | 
+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
+  # Restore an archived sender
+  result = api_instance.senders_restore(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_restore: #{e}"
+end
+```
+
+#### Using the senders_restore_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Sender>, Integer, Hash)> senders_restore_with_http_info(id, opts)
+
+```ruby
+begin
+  # Restore an archived sender
+  data, status_code, headers = api_instance.senders_restore_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Sender>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_restore_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **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
+
+[**Sender**](Sender.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## senders_update
+
+> <Sender> senders_update(id, opts)
+
+Update a sender
+
+Edit a mailbox. Changing the transport or credentials re-verifies by sending a real test email and is rejected if it cannot send. Set state to pause or resume sending, warmup to tune the warmup engine (or null to disable it), or archivedAt to null to restore an archived mailbox.
+
+### 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::SendersApi.new
+id = 'id_example' # String | 
+opts = {
+  update_sender_input: Norbelys::UpdateSenderInput.new # UpdateSenderInput | 
+}
+
+begin
+  # Update a sender
+  result = api_instance.senders_update(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_update: #{e}"
+end
+```
+
+#### Using the senders_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Sender>, Integer, Hash)> senders_update_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update a sender
+  data, status_code, headers = api_instance.senders_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Sender>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SendersApi->senders_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_sender_input** | [**UpdateSenderInput**](UpdateSenderInput.md) |  | [optional] |
+
+### Return type
+
+[**Sender**](Sender.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SlackChannel.md

@@ -0,0 +1,20 @@
+# Norbelys::SlackChannel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Slack channel id. |  |
+| **name** | **String** | The channel's display name. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::SlackChannel.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/SmtpConnectionSettings.md

@@ -0,0 +1,26 @@
+# Norbelys::SmtpConnectionSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | The server hostname. |  |
+| **port** | **Integer** | The server port. |  |
+| **security** | **String** | TLS mode: `ssl` (implicit TLS), `tls` (STARTTLS), or `none`. Defaults to STARTTLS when unset. | [optional] |
+| **password** | **String** | Auth password; encrypted at rest and never returned. | [optional] |
+| **username** | **String** | Auth username; defaults to the fromEmail when omitted. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::SmtpConnectionSettings.new(
+  host: null,
+  port: null,
+  security: null,
+  password: null,
+  username: null
+)
+```
+

data/docs/SmtpConnectionUpdate.md

@@ -0,0 +1,26 @@
+# Norbelys::SmtpConnectionUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | The server hostname. | [optional] |
+| **port** | **Integer** | The server port. | [optional] |
+| **security** | **String** | TLS mode: `ssl` (implicit TLS), `tls` (STARTTLS), or `none`. Defaults to STARTTLS when unset. | [optional] |
+| **password** | **String** | Auth password; encrypted at rest and never returned. | [optional] |
+| **username** | **String** | Auth username; defaults to the fromEmail when omitted. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::SmtpConnectionUpdate.new(
+  host: null,
+  port: null,
+  security: null,
+  password: null,
+  username: null
+)
+```
+

data/docs/SmtpSenderInput.md

@@ -0,0 +1,40 @@
+# Norbelys::SmtpSenderInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bcc_crm_email** | **String** | BCC every send to this address (CRM capture). | [optional] |
+| **client_label** | **String** | Free-text label for this mailbox (e.g. to tag by client). | [optional] |
+| **daily_limit** | **Integer** | Maximum sends per day for this mailbox. | [optional] |
+| **min_gap_minutes** | **Integer** | Minimum gap between sends from this mailbox (floor 3; server default 5). | [optional] |
+| **reply_to** | **String** | Reply-To override. | [optional] |
+| **sending_domain_id** | **String** | The sending domain id. Omit to get-or-create it from the fromEmail host. | [optional] |
+| **signature_html** | **String** | HTML signature appended to every send. | [optional] |
+| **from_email** | **String** | The sending address. |  |
+| **from_name** | **String** | Display name. |  |
+| **imap** | [**ConnectionSettings**](ConnectionSettings.md) |  | [optional] |
+| **smtp** | [**SmtpConnectionSettings**](SmtpConnectionSettings.md) |  |  |
+| **transport_mode** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::SmtpSenderInput.new(
+  bcc_crm_email: null,
+  client_label: null,
+  daily_limit: null,
+  min_gap_minutes: null,
+  reply_to: null,
+  sending_domain_id: null,
+  signature_html: null,
+  from_email: null,
+  from_name: null,
+  imap: null,
+  smtp: null,
+  transport_mode: null
+)
+```
+

data/docs/StaticEmailVariantContent.md

@@ -0,0 +1,28 @@
+# Norbelys::StaticEmailVariantContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cta_override_reason** | **String** | Documented operator reason for keeping multiple commercial asks; advisory, never a launch blocker. | [optional] |
+| **html** | **String** | HTML body; supports template variables. | [optional] |
+| **preheader** | **String** | Optional inbox preview snippet; separate from the MIME plain-text body. | [optional] |
+| **subject** | **String** | Subject line; supports template variables like {{ firstname }} (always give bare tags a `| default:` fallback). | [optional] |
+| **text** | **String** | Optional plain-text body; when omitted it is derived from the rendered HTML. | [optional] |
+| **ai** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::StaticEmailVariantContent.new(
+  cta_override_reason: null,
+  html: null,
+  preheader: null,
+  subject: null,
+  text: null,
+  ai: null
+)
+```
+