norbelys 0.1.0

data/docs/DmarcRecordToPublish.md

@@ -0,0 +1,22 @@
+# Norbelys::DmarcRecordToPublish
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | The DNS host to create. |  |
+| **type** | **Object** |  |  |
+| **value** | **String** | The exact TXT value to publish, verbatim. Points DMARC `rua` at your collection address; if a `_dmarc` record already exists, this value keeps yours and adds the `rua`. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DmarcRecordToPublish.new(
+  host: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/Domain.md

@@ -0,0 +1,38 @@
+# Norbelys::Domain
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **age** | [**DomainAge**](DomainAge.md) |  |  |
+| **capability** | **String** | What the domain is for: `sending`, `monitoring`, or `tracking`. |  |
+| **created_at** | **Object** |  | [optional] |
+| **domain** | **String** | The bare DNS name. |  |
+| **id** | **String** | The domain id. |  |
+| **monitoring** | [**DomainMonitoring**](DomainMonitoring.md) |  |  |
+| **object** | **Object** |  | [optional] |
+| **sender_count** | **Integer** |  |  |
+| **sending** | [**DomainSending**](DomainSending.md) |  |  |
+| **tracking** | [**DomainTracking**](DomainTracking.md) |  |  |
+| **version** | **Integer** | Optimistic concurrency version. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Domain.new(
+  age: null,
+  capability: null,
+  created_at: null,
+  domain: null,
+  id: null,
+  monitoring: null,
+  object: null,
+  sender_count: null,
+  sending: null,
+  tracking: null,
+  version: null
+)
+```
+

data/docs/DomainAge.md

@@ -0,0 +1,30 @@
+# Norbelys::DomainAge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **age_days** | **Integer** |  |  |
+| **checked_at** | **Object** |  | [optional] |
+| **first_healthy_at** | **Object** |  | [optional] |
+| **first_seen_sending_at** | **Object** |  | [optional] |
+| **registered_at** | **Object** |  | [optional] |
+| **sending_age_days** | **Integer** |  |  |
+| **source** | **String** | Where the age came from: `rdap`, `sending_history`, or `unknown`. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainAge.new(
+  age_days: null,
+  checked_at: null,
+  first_healthy_at: null,
+  first_seen_sending_at: null,
+  registered_at: null,
+  sending_age_days: null,
+  source: null
+)
+```
+

data/docs/DomainCapacity.md

@@ -0,0 +1,28 @@
+# Norbelys::DomainCapacity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign_used** | **Integer** | Sends already used today by the filtered campaign. |  |
+| **domain_remaining** | **Integer** |  |  |
+| **limiting_reason** | **String** |  |  |
+| **mailbox_capacity** | **Integer** | Total daily capacity across the domain's mailboxes. |  |
+| **next_reset_at** | **Object** |  | [optional] |
+| **warmup_reserved** | **Integer** | Daily capacity reserved for warmup and unavailable to campaigns. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainCapacity.new(
+  campaign_used: null,
+  domain_remaining: null,
+  limiting_reason: null,
+  mailbox_capacity: null,
+  next_reset_at: null,
+  warmup_reserved: null
+)
+```
+

data/docs/DomainCreateParams.md

@@ -0,0 +1,24 @@
+# Norbelys::DomainCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capability** | **String** | What the domain is for: `sending`, `monitoring`, or `tracking`. Defaults to `sending`. | [optional][default to 'sending'] |
+| **domain** | **String** | The bare DNS name. |  |
+| **monitoring** | [**DomainMonitoringParams**](DomainMonitoringParams.md) |  | [optional] |
+| **tracking** | [**DomainTrackingParams**](DomainTrackingParams.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainCreateParams.new(
+  capability: null,
+  domain: null,
+  monitoring: null,
+  tracking: null
+)
+```
+

data/docs/DomainDetail.md

@@ -0,0 +1,42 @@
+# Norbelys::DomainDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **age** | [**DomainAge**](DomainAge.md) |  |  |
+| **capability** | **String** | What the domain is for: `sending`, `monitoring`, or `tracking`. |  |
+| **created_at** | **Object** |  | [optional] |
+| **domain** | **String** | The bare DNS name. |  |
+| **id** | **String** | The domain id. |  |
+| **monitoring** | [**DomainMonitoring**](DomainMonitoring.md) |  |  |
+| **object** | **Object** |  | [optional] |
+| **sender_count** | **Integer** |  |  |
+| **sending** | [**DomainSending**](DomainSending.md) |  |  |
+| **tracking** | [**DomainTracking**](DomainTracking.md) |  |  |
+| **version** | **Integer** | Optimistic concurrency version. |  |
+| **collection_addresses** | [**Array<CollectionAddress>**](CollectionAddress.md) | The monitoring rua addresses DMARC reports are sent to — present when expand[]=collectionAddresses (empty on a sending domain). | [optional] |
+| **tracking_domains** | [**Array<Domain>**](Domain.md) | Tracking-domain resources assigned to this sending domain, or an empty array for other capabilities. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainDetail.new(
+  age: null,
+  capability: null,
+  created_at: null,
+  domain: null,
+  id: null,
+  monitoring: null,
+  object: null,
+  sender_count: null,
+  sending: null,
+  tracking: null,
+  version: null,
+  collection_addresses: null,
+  tracking_domains: null
+)
+```
+

data/docs/DomainHealth.md

@@ -0,0 +1,24 @@
+# Norbelys::DomainHealth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reasons** | **Array<String>** | Human-readable reasons behind the current health state. |  |
+| **recommended_action** | **String** |  |  |
+| **state** | **String** | Overall sending health: `unknown`, `healthy`, `degraded`, or `critical`. |  |
+| **updated_at** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainHealth.new(
+  reasons: null,
+  recommended_action: null,
+  state: null,
+  updated_at: null
+)
+```
+

data/docs/DomainList.md

@@ -0,0 +1,26 @@
+# Norbelys::DomainList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Domain>**](Domain.md) | The page of results, newest first. |  |
+| **has_more** | **Boolean** | Whether another page exists beyond this one. |  |
+| **next_cursor** | **String** |  |  |
+| **object** | **Object** |  | [optional] |
+| **total** | **Integer** | Total number of rows matching the filters. Not included on every list. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainList.new(
+  data: null,
+  has_more: null,
+  next_cursor: null,
+  object: null,
+  total: null
+)
+```
+

data/docs/DomainMonitoring.md

@@ -0,0 +1,30 @@
+# Norbelys::DomainMonitoring
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **collection_status** | **String** | Where report collection stands: \"waiting\" = the `_dmarc` rua record isn't pointing to us yet; \"live\" = published to us, awaiting the first report; \"collecting\" = reports are arriving. |  |
+| **dmarc_policy** | **String** |  |  |
+| **kind** | **String** | \"sending\" = one of our own sending domains; \"external\" = monitor-only. |  |
+| **last_report_at** | **Object** |  | [optional] |
+| **pass_rate7d** | **Float** |  |  |
+| **record_to_publish** | [**DmarcRecordToPublish**](DmarcRecordToPublish.md) |  |  |
+| **sending_domain_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainMonitoring.new(
+  collection_status: null,
+  dmarc_policy: null,
+  kind: null,
+  last_report_at: null,
+  pass_rate7d: null,
+  record_to_publish: null,
+  sending_domain_id: null
+)
+```
+

data/docs/DomainMonitoringParams.md

@@ -0,0 +1,20 @@
+# Norbelys::DomainMonitoringParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** | What the monitored domain is: `sending` (one of our own) or `external` (monitor-only). Defaults to `external`. | [optional][default to 'external'] |
+| **sending_domain_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainMonitoringParams.new(
+  kind: null,
+  sending_domain_id: null
+)
+```
+

data/docs/DomainSending.md

@@ -0,0 +1,26 @@
+# Norbelys::DomainSending
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capacity** | [**DomainCapacity**](DomainCapacity.md) |  |  |
+| **default_tracking_domain_id** | **String** |  |  |
+| **health** | [**DomainHealth**](DomainHealth.md) |  |  |
+| **policy** | [**DomainSendingPolicy**](DomainSendingPolicy.md) |  |  |
+| **sender_count** | **Integer** | Number of mailboxes attached to this sending domain. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainSending.new(
+  capacity: null,
+  default_tracking_domain_id: null,
+  health: null,
+  policy: null,
+  sender_count: null
+)
+```
+

data/docs/DomainSendingPolicy.md

@@ -0,0 +1,36 @@
+# Norbelys::DomainSendingPolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_pause_all** | **Boolean** | Whether the platform may pause ALL sends from this domain when health is critical. |  |
+| **allow_pause_first_touches** | **Boolean** | Whether the platform may pause first-touch (cold) sends while replies keep flowing. |  |
+| **autopilot_max** | **Integer** |  |  |
+| **autopilot_min** | **Integer** |  |  |
+| **configured_daily_cap** | **Integer** |  |  |
+| **effective_daily_cap** | **Integer** |  |  |
+| **max_daily_growth_percent** | **Integer** |  |  |
+| **mode** | **String** | Budget control mode: `legacy`, `manual`, or `autopilot`. |  |
+| **recommended_daily_cap** | **Integer** |  |  |
+| **timezone** | **String** | IANA timezone the daily window and reset are computed in. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainSendingPolicy.new(
+  allow_pause_all: null,
+  allow_pause_first_touches: null,
+  autopilot_max: null,
+  autopilot_min: null,
+  configured_daily_cap: null,
+  effective_daily_cap: null,
+  max_daily_growth_percent: null,
+  mode: null,
+  recommended_daily_cap: null,
+  timezone: null
+)
+```
+

data/docs/DomainSendingPolicyParams.md

@@ -0,0 +1,32 @@
+# Norbelys::DomainSendingPolicyParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_pause_all** | **Boolean** | Whether the platform may pause ALL sends from this domain when health is critical. | [optional] |
+| **allow_pause_first_touches** | **Boolean** | Whether the platform may pause first-touch (cold) sends while replies keep flowing. | [optional] |
+| **autopilot_max** | **Integer** |  | [optional] |
+| **autopilot_min** | **Integer** |  | [optional] |
+| **configured_daily_cap** | **Integer** |  | [optional] |
+| **max_daily_growth_percent** | **Integer** |  | [optional] |
+| **mode** | **String** | Budget control mode: `legacy`, `manual`, or `autopilot`. | [optional] |
+| **timezone** | **String** | IANA timezone the daily window and reset are computed in. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainSendingPolicyParams.new(
+  allow_pause_all: null,
+  allow_pause_first_touches: null,
+  autopilot_max: null,
+  autopilot_min: null,
+  configured_daily_cap: null,
+  max_daily_growth_percent: null,
+  mode: null,
+  timezone: null
+)
+```
+

data/docs/DomainSendingUpdateParams.md

@@ -0,0 +1,20 @@
+# Norbelys::DomainSendingUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default_tracking_domain_id** | **String** |  | [optional] |
+| **policy** | [**DomainSendingPolicyParams**](DomainSendingPolicyParams.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainSendingUpdateParams.new(
+  default_tracking_domain_id: null,
+  policy: null
+)
+```
+

data/docs/DomainTracking.md

@@ -0,0 +1,50 @@
+# Norbelys::DomainTracking
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assigned_sending_domain_ids** | **Array<String>** | Sending domains whose links route through this tracking hostname. |  |
+| **cloudflare_hostname_id** | **String** |  |  |
+| **desired_state** | **String** | Operator target state: `active` or `disabled`. |  |
+| **dns_status** | **String** | Whether the CNAME resolves correctly: `pending`, `valid`, or `invalid`. |  |
+| **domain_connect_supported** | **Boolean** | Whether the DNS provider supports one-click Domain Connect setup. |  |
+| **domain_connect_url** | **String** |  |  |
+| **http_status** | **String** | Whether the tracking host serves over HTTP correctly: `pending`, `valid`, or `invalid`. |  |
+| **is_organization_default** | **Boolean** | Whether this is the organization's default tracking domain. |  |
+| **label** | **String** |  |  |
+| **last_checked_at** | **Object** |  | [optional] |
+| **provider** | **String** | Detected DNS provider: `cloudflare`, `vercel`, `other`, or `unknown`. |  |
+| **provider_display_name** | **String** |  |  |
+| **provider_url** | **String** |  |  |
+| **record** | [**TrackingDnsRecord**](TrackingDnsRecord.md) |  |  |
+| **setup_mode** | **String** | How the record is being set up: `domain_connect` or `manual`. |  |
+| **status** | **String** | Lifecycle status: `pending_dns`, `pending_tls`, `checking`, `active`, `degraded`, or `archived`. |  |
+| **tls_status** | **String** | Whether the edge TLS certificate is issued: `pending`, `valid`, or `invalid`. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainTracking.new(
+  assigned_sending_domain_ids: null,
+  cloudflare_hostname_id: null,
+  desired_state: null,
+  dns_status: null,
+  domain_connect_supported: null,
+  domain_connect_url: null,
+  http_status: null,
+  is_organization_default: null,
+  label: null,
+  last_checked_at: null,
+  provider: null,
+  provider_display_name: null,
+  provider_url: null,
+  record: null,
+  setup_mode: null,
+  status: null,
+  tls_status: null
+)
+```
+

data/docs/DomainTrackingParams.md

@@ -0,0 +1,22 @@
+# Norbelys::DomainTrackingParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assigned_sending_domain_ids** | **Array<String>** | Sending domains to route through this tracking hostname. Defaults to an empty list. | [optional] |
+| **is_organization_default** | **Boolean** | Make this the organization's default tracking domain. Defaults to false. | [optional][default to false] |
+| **label** | **String** | Optional operator-facing label for this tracking domain. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainTrackingParams.new(
+  assigned_sending_domain_ids: null,
+  is_organization_default: null,
+  label: null
+)
+```
+

data/docs/DomainTrackingUpdateParams.md

@@ -0,0 +1,24 @@
+# Norbelys::DomainTrackingUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assigned_sending_domain_ids** | **Array<String>** | Replace the set of sending domains routed through this tracking hostname. | [optional] |
+| **desired_state** | **String** | Set the target state: `active` or `disabled`. | [optional] |
+| **is_organization_default** | **Boolean** | Make this the organization's default tracking domain. | [optional] |
+| **label** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainTrackingUpdateParams.new(
+  assigned_sending_domain_ids: null,
+  desired_state: null,
+  is_organization_default: null,
+  label: null
+)
+```
+

data/docs/DomainUpdateParams.md

@@ -0,0 +1,22 @@
+# Norbelys::DomainUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sending** | [**DomainSendingUpdateParams**](DomainSendingUpdateParams.md) |  | [optional] |
+| **tracking** | [**DomainTrackingUpdateParams**](DomainTrackingUpdateParams.md) |  | [optional] |
+| **version** | **Integer** | Optimistic concurrency version; must match the current row. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DomainUpdateParams.new(
+  sending: null,
+  tracking: null,
+  version: null
+)
+```
+