norbelys 0.1.0

data/docs/DomainsApi.md

@@ -0,0 +1,525 @@
+# Norbelys::DomainsApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**domains_archive**](DomainsApi.md#domains_archive) | **DELETE** /domains/{id} | Archive a domain |
+| [**domains_create**](DomainsApi.md#domains_create) | **POST** /domains | Create a domain |
+| [**domains_find**](DomainsApi.md#domains_find) | **GET** /domains/{id} | Get a domain |
+| [**domains_list**](DomainsApi.md#domains_list) | **GET** /domains | List domains |
+| [**domains_restore**](DomainsApi.md#domains_restore) | **POST** /domains/{id}/restore | Restore an archived domain |
+| [**domains_share**](DomainsApi.md#domains_share) | **POST** /domains/{id}/share | Share the DMARC report |
+| [**domains_update**](DomainsApi.md#domains_update) | **PATCH** /domains/{id} | Update a domain |
+
+
+## domains_archive
+
+> <Domain> domains_archive(id)
+
+Archive a domain
+
+Soft-archive a domain (it is versioned, never hard-deleted). Archiving a monitoring domain also revokes its collection addresses, so DMARC report ingestion stops with it; restore re-enables them.
+
+### 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::DomainsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Archive a domain
+  result = api_instance.domains_archive(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_archive: #{e}"
+end
+```
+
+#### Using the domains_archive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> domains_archive_with_http_info(id)
+
+```ruby
+begin
+  # Archive a domain
+  data, status_code, headers = api_instance.domains_archive_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_archive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## domains_create
+
+> <Domain> domains_create(domain_create_params, opts)
+
+Create a domain
+
+Provision a domain by capability. A `sending` domain registers a cold/SMTP mailbox domain (normally born automatically when you connect a mailbox); a `monitoring` domain starts DMARC monitoring and auto-mints its first collection address (read it back with find?expand[]=collectionAddresses). The common manual use is adding an external monitor-only domain.
+
+### 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::DomainsApi.new
+domain_create_params = Norbelys::DomainCreateParams.new({domain: 'domain_example'}) # DomainCreateParams | 
+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
+  # Create a domain
+  result = api_instance.domains_create(domain_create_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_create: #{e}"
+end
+```
+
+#### Using the domains_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> domains_create_with_http_info(domain_create_params, opts)
+
+```ruby
+begin
+  # Create a domain
+  data, status_code, headers = api_instance.domains_create_with_http_info(domain_create_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_create_params** | [**DomainCreateParams**](DomainCreateParams.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
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## domains_find
+
+> <DomainDetail> domains_find(id, opts)
+
+Get a domain
+
+Read one domain (a monitoring domain reports its DMARC collection readiness on read). Pass expand[]=collectionAddresses to inline the rua addresses reports are sent to.
+
+### 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::DomainsApi.new
+id = 'id_example' # String | 
+opts = {
+  expand: [['collectionAddresses']] # Array<String> | 
+}
+
+begin
+  # Get a domain
+  result = api_instance.domains_find(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_find: #{e}"
+end
+```
+
+#### Using the domains_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DomainDetail>, Integer, Hash)> domains_find_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get a domain
+  data, status_code, headers = api_instance.domains_find_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DomainDetail>
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **expand** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+
+### Return type
+
+[**DomainDetail**](DomainDetail.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## domains_list
+
+> <DomainList> domains_list(opts)
+
+List domains
+
+List your domains — both sending domains and DMARC-monitoring domains. Filter by capability, or pass programId to scope to the sending domains a campaign sends from (adds senderCount).
+
+### 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::DomainsApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  include_archived: true, # Boolean | 
+  limit: 56, # Integer | 
+  capability: 'sending', # String | 
+  program_id: 'program_id_example' # String | 
+}
+
+begin
+  # List domains
+  result = api_instance.domains_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_list: #{e}"
+end
+```
+
+#### Using the domains_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DomainList>, Integer, Hash)> domains_list_with_http_info(opts)
+
+```ruby
+begin
+  # List domains
+  data, status_code, headers = api_instance.domains_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DomainList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **include_archived** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **capability** | **String** |  | [optional] |
+| **program_id** | **String** |  | [optional] |
+
+### Return type
+
+[**DomainList**](DomainList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## domains_restore
+
+> <Domain> domains_restore(id, opts)
+
+Restore an archived domain
+
+Un-archive a domain. A monitoring domain also resumes DMARC report collection (its collection addresses are re-enabled).
+
+### 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::DomainsApi.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 domain
+  result = api_instance.domains_restore(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_restore: #{e}"
+end
+```
+
+#### Using the domains_restore_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> domains_restore_with_http_info(id, opts)
+
+```ruby
+begin
+  # Restore an archived domain
+  data, status_code, headers = api_instance.domains_restore_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_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
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## domains_share
+
+> <ReportShare> domains_share(id, opts)
+
+Share the DMARC report
+
+Mint a public, read-only link to this monitoring domain's DMARC report (send it to a client — no account needed). The link is signed and expires after 30 days; archiving the domain kills it immediately. Mint again for a fresh link.
+
+### 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::DomainsApi.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
+  # Share the DMARC report
+  result = api_instance.domains_share(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_share: #{e}"
+end
+```
+
+#### Using the domains_share_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReportShare>, Integer, Hash)> domains_share_with_http_info(id, opts)
+
+```ruby
+begin
+  # Share the DMARC report
+  data, status_code, headers = api_instance.domains_share_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReportShare>
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_share_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
+
+[**ReportShare**](ReportShare.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## domains_update
+
+> <Domain> domains_update(id, domain_update_params)
+
+Update a domain
+
+Update customer-owned settings on a sending or tracking domain. Operational DNS, TLS, health, recommendation, and capacity fields are read-only. The required version provides optimistic concurrency.
+
+### 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::DomainsApi.new
+id = 'id_example' # String | 
+domain_update_params = Norbelys::DomainUpdateParams.new({version: 37}) # DomainUpdateParams | 
+
+begin
+  # Update a domain
+  result = api_instance.domains_update(id, domain_update_params)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_update: #{e}"
+end
+```
+
+#### Using the domains_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> domains_update_with_http_info(id, domain_update_params)
+
+```ruby
+begin
+  # Update a domain
+  data, status_code, headers = api_instance.domains_update_with_http_info(id, domain_update_params)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue Norbelys::ApiError => e
+  puts "Error when calling DomainsApi->domains_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **domain_update_params** | [**DomainUpdateParams**](DomainUpdateParams.md) |  |  |
+
+### Return type
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmailVariantContent.md

@@ -0,0 +1,28 @@
+# Norbelys::EmailVariantContent
+
+## 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** | [**VariantAi**](VariantAi.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::EmailVariantContent.new(
+  cta_override_reason: null,
+  html: null,
+  preheader: null,
+  subject: null,
+  text: null,
+  ai: null
+)
+```
+

data/docs/EnrollProgramParams.md

@@ -0,0 +1,28 @@
+# Norbelys::EnrollProgramParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **all** | **Object** | Enroll EVERY active person. Required explicitly — omitting all selectors is an error, never an implicit enroll-everyone. | [optional] |
+| **group_ids** | **Array<String>** | Enroll every LIVE person in these groups (static lists) — several at once, resolved as one union. | [optional] |
+| **import_ids** | **Array<String>** | When the `personIds` came from CSV imports, the import ids — each is recorded as an audience source so the campaign shows where its people came from. | [optional] |
+| **mode** | **String** | `snapshot` (default): enroll the CURRENT matches once and freeze. `reactive`: also keep the campaign in sync with EVERY given segment — new people are enrolled automatically as they come to match. Groups are static lists, so they always behave as snapshots. | [optional] |
+| **person_ids** | **Array<String>** | Explicit person ids (CSV/preview-resolved sets). | [optional] |
+| **segment_ids** | **Array<String>** | Enroll every person CURRENTLY matching these segments (saved filters) — several at once, resolved as one union. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::EnrollProgramParams.new(
+  all: null,
+  group_ids: null,
+  import_ids: null,
+  mode: null,
+  person_ids: null,
+  segment_ids: null
+)
+```
+

data/docs/EnrollProgramResult.md

@@ -0,0 +1,28 @@
+# Norbelys::EnrollProgramResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Whether the program is live after this enroll (true = the new leads start sending). |  |
+| **already_enrolled** | **Integer** | How many of the resolved audience were already in this program and were skipped. |  |
+| **enrolled** | **Integer** | Number of people newly enrolled. |  |
+| **program_id** | **String** | The program id. |  |
+| **sender_ids** | **Array<String>** | The program's attached mailboxes. |  |
+| **suppressed** | **Integer** | How many of the resolved audience were excluded by the suppression list (unsubscribed, hard-bounced, or verified-undeliverable addresses never enter a campaign). |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::EnrollProgramResult.new(
+  active: null,
+  already_enrolled: null,
+  enrolled: null,
+  program_id: null,
+  sender_ids: null,
+  suppressed: null
+)
+```
+

data/docs/Enrollment.md

@@ -0,0 +1,42 @@
+# Norbelys::Enrollment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **assigned_sender_id** | **String** |  |  |
+| **created_at** | **Object** |  | [optional] |
+| **current_step_id** | **String** |  |  |
+| **id** | **String** | The enrollment id. |  |
+| **next_send_at** | **Object** |  | [optional] |
+| **object** | **Object** |  | [optional] |
+| **person_id** | **String** | The enrolled person's id. |  |
+| **program_id** | **String** | The owning program's id. |  |
+| **status** | **String** | Lifecycle status: `active`, `replied`, `bounced`, `unsubscribed`, `finished`, `skipped`, `stopped`, `cancelled`, `paused`. |  |
+| **updated_at** | **Object** |  | [optional] |
+| **person** | [**EnrollmentPersonRef**](EnrollmentPersonRef.md) |  |  |
+| **program** | [**EnrollmentProgramRef**](EnrollmentProgramRef.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Enrollment.new(
+  archived_at: null,
+  assigned_sender_id: null,
+  created_at: null,
+  current_step_id: null,
+  id: null,
+  next_send_at: null,
+  object: null,
+  person_id: null,
+  program_id: null,
+  status: null,
+  updated_at: null,
+  person: null,
+  program: null
+)
+```
+

data/docs/EnrollmentCounts.md

@@ -0,0 +1,44 @@
+# Norbelys::EnrollmentCounts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Integer** | Active leads. |  |
+| **bounced** | **Integer** | Leads that bounced. |  |
+| **by_step** | **Hash<String, Integer>** | Active leads waiting at each cadence step (`currentStepId` → count) — who sits between which emails right now. | [optional] |
+| **cancelled** | **Integer** | Leads whose run was cancelled by archiving the campaign. |  |
+| **finished** | **Integer** | Leads that finished the cadence. |  |
+| **in_progress** | **Integer** | Active leads mid-cadence. |  |
+| **next_send_at** | **Object** |  | [optional] |
+| **not_started** | **Integer** | Active leads not yet contacted. |  |
+| **paused** | **Integer** | Paused leads. |  |
+| **replied** | **Integer** | Leads that replied. |  |
+| **skipped** | **Integer** | Leads skipped because they were suppressed at send time. |  |
+| **stopped** | **Integer** | Leads pulled out by an engagement stop (open/click). |  |
+| **total** | **Integer** | All enrollments in scope. |  |
+| **unsubscribed** | **Integer** | Leads that unsubscribed. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::EnrollmentCounts.new(
+  active: null,
+  bounced: null,
+  by_step: null,
+  cancelled: null,
+  finished: null,
+  in_progress: null,
+  next_send_at: null,
+  not_started: null,
+  paused: null,
+  replied: null,
+  skipped: null,
+  stopped: null,
+  total: null,
+  unsubscribed: null
+)
+```
+