norbelys 0.1.0

data/docs/AnalyticsQueryParams.md

@@ -0,0 +1,50 @@
+# Norbelys::AnalyticsQueryParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **activity** | **String** | The outbound message id. Required by the message_events query; returns every event for that one send. | [optional] |
+| **days** | **Integer** | Lookback window in days (alternative to since/until). | [optional] |
+| **dir** | **String** | Sort direction for activity_feed (default desc). | [optional] |
+| **domain** | **String** | The monitored domain name. Required by dmarc_summary / dmarc_sources; optional on dmarc_reports / dmarc_receivers — omit for the account-wide feed. Example: acme.com | [optional] |
+| **exclude_machine** | **Boolean** | activity_feed only: exclude machine-generated engagement — opens not classified as human (e.g. automated inbox prefetches) and any bot-classified event. | [optional] |
+| **limit** | **Integer** | Max rows returned. | [optional] |
+| **offset** | **Integer** | Rows to skip (activity_feed paging). | [optional] |
+| **order_by** | **String** | Sort column for activity_feed. Example: occurred_at | [optional] |
+| **person** | **String** | Scope to one person (person id). Used by: contact_events. | [optional] |
+| **program** | **String** | Scope to one campaign (program id). Used by: activity_feed, program_funnel, sender_breakdown, variant_performance. | [optional] |
+| **receiver** | **String** | Narrow the DMARC queries to ONE reporter (receiver) — 'show me only what Gmail saw'. Used by: dmarc_summary, dmarc_sources, dmarc_geo, dmarc_reports. | [optional] |
+| **search** | **String** | Free-text search (activity_feed: matches recipient/subject). | [optional] |
+| **sender** | **String** | Scope to one sender — by id (\"snd_…\") or by its from address (\"receipts@hola.com\"); both filter identically. Used by: activity_feed, sender_health, warmup_placement. | [optional] |
+| **since** | **String** | Window start (ISO 8601). Most queries default to the last 30 days. | [optional] |
+| **thread** | **String** | A conversation (thread) id — narrows agent_trace to one conversation. | [optional] |
+| **type** | **String** | Filter to one event type. | [optional] |
+| **_until** | **String** | Window end (ISO 8601). | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AnalyticsQueryParams.new(
+  activity: null,
+  days: null,
+  dir: null,
+  domain: null,
+  exclude_machine: null,
+  limit: null,
+  offset: null,
+  order_by: null,
+  person: null,
+  program: null,
+  receiver: null,
+  search: null,
+  sender: null,
+  since: null,
+  thread: null,
+  type: null,
+  _until: null
+)
+```
+

data/docs/AnalyticsQueryResult.md

@@ -0,0 +1,20 @@
+# Norbelys::AnalyticsQueryResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Array<Hash<String, Object>>** | The result rows, one flat object per row. |  |
+| **rows** | **Integer** | Number of rows returned. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AnalyticsQueryResult.new(
+  data: null,
+  rows: null
+)
+```
+

data/docs/ApiError.md

@@ -0,0 +1,18 @@
+# Norbelys::ApiError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ApiErrorDetail**](ApiErrorDetail.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::ApiError.new(
+  error: null
+)
+```
+

data/docs/ApiErrorDetail.md

@@ -0,0 +1,26 @@
+# Norbelys::ApiErrorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Stable machine code — branch on this, never on the human `message`. |  |
+| **doc_url** | **String** | Optional link to the relevant documentation. | [optional] |
+| **hint** | **String** | Optional one-sentence remediation. | [optional] |
+| **message** | **String** | Human-readable explanation. Never a contract. |  |
+| **type** | **String** | Broad, machine-routable category derived from the HTTP status. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::ApiErrorDetail.new(
+  code: null,
+  doc_url: null,
+  hint: null,
+  message: null,
+  type: null
+)
+```
+

data/docs/AudienceActivityAction.md

@@ -0,0 +1,15 @@
+# Norbelys::AudienceActivityAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceActivityAction.new()
+```
+

data/docs/AudienceActivityCondition.md

@@ -0,0 +1,20 @@
+# Norbelys::AudienceActivityCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **activity** | [**AudienceActivityParams**](AudienceActivityParams.md) |  |  |
+| **did** | **Boolean** | `true` = the person DID this at least once; `false` = the person did NOT (zero times). | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceActivityCondition.new(
+  activity: null,
+  did: null
+)
+```
+

data/docs/AudienceActivityLinkFilter.md

@@ -0,0 +1,20 @@
+# Norbelys::AudienceActivityLinkFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AudienceActivityLinkMatchOp**](AudienceActivityLinkMatchOp.md) |  |  |
+| **value** | **String** | The URL (or fragment) the click must match. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceActivityLinkFilter.new(
+  op: null,
+  value: null
+)
+```
+

data/docs/AudienceActivityLinkMatchOp.md

@@ -0,0 +1,15 @@
+# Norbelys::AudienceActivityLinkMatchOp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceActivityLinkMatchOp.new()
+```
+

data/docs/AudienceActivityParams.md

@@ -0,0 +1,32 @@
+# Norbelys::AudienceActivityParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | [**AudienceActivityAction**](AudienceActivityAction.md) |  |  |
+| **after** | **Float** | Only count activity at/after this instant (epoch milliseconds). | [optional] |
+| **before** | **Float** | Only count activity before this instant (epoch milliseconds). | [optional] |
+| **campaign_ids** | **Array<String>** | Scope to these campaigns (matches ANY of them). Omit for activity in any campaign. | [optional] |
+| **link** | [**AudienceActivityLinkFilter**](AudienceActivityLinkFilter.md) |  | [optional] |
+| **step_ids** | **Array<String>** | Scope to these cadence steps (matches ANY of them). | [optional] |
+| **variant_ids** | **Array<String>** | Scope to these A/B variants (matches ANY of them). | [optional] |
+| **within_days** | **Integer** | Only count activity in the last N days. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceActivityParams.new(
+  action: null,
+  after: null,
+  before: null,
+  campaign_ids: null,
+  link: null,
+  step_ids: null,
+  variant_ids: null,
+  within_days: null
+)
+```
+

data/docs/AudienceAttributeCondition.md

@@ -0,0 +1,22 @@
+# Norbelys::AudienceAttributeCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | The field to test: a reserved field key (`email`, `firstname`, `lastname`, `telephone`, `email_domain`, `status`, `source`, `score`, `last_activity_at`, `created_at`, `group`, `program`, `suppressed`) or a custom field's code. |  |
+| **op** | [**AudienceConditionOp**](AudienceConditionOp.md) |  |  |
+| **value** | [**AudienceConditionValue**](AudienceConditionValue.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceAttributeCondition.new(
+  field: null,
+  op: null,
+  value: null
+)
+```
+

data/docs/AudienceConditionOp.md

@@ -0,0 +1,15 @@
+# Norbelys::AudienceConditionOp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceConditionOp.new()
+```
+

data/docs/AudienceConditionValue.md

@@ -0,0 +1,15 @@
+# Norbelys::AudienceConditionValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceConditionValue.new()
+```
+

data/docs/AudienceFilter.md

@@ -0,0 +1,20 @@
+# Norbelys::AudienceFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conditions** | [**Array<AudienceRule>**](AudienceRule.md) | The rules, up to 50 — attribute conditions (field · op · value) and/or activity conditions (did/did-not + engagement scope); an empty list matches every (non-archived) person. | [optional] |
+| **match** | [**AudienceMatch**](AudienceMatch.md) |  | [optional][default to 'all'] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceFilter.new(
+  conditions: null,
+  match: null
+)
+```
+

data/docs/AudienceMatch.md

@@ -0,0 +1,15 @@
+# Norbelys::AudienceMatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceMatch.new()
+```
+

data/docs/AudienceRule.md

@@ -0,0 +1,26 @@
+# Norbelys::AudienceRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | The field to test: a reserved field key (`email`, `firstname`, `lastname`, `telephone`, `email_domain`, `status`, `source`, `score`, `last_activity_at`, `created_at`, `group`, `program`, `suppressed`) or a custom field's code. |  |
+| **op** | [**AudienceConditionOp**](AudienceConditionOp.md) |  |  |
+| **value** | [**AudienceConditionValue**](AudienceConditionValue.md) |  | [optional] |
+| **activity** | [**AudienceActivityParams**](AudienceActivityParams.md) |  |  |
+| **did** | **Boolean** | `true` = the person DID this at least once; `false` = the person did NOT (zero times). | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceRule.new(
+  field: null,
+  op: null,
+  value: null,
+  activity: null,
+  did: null
+)
+```
+

data/docs/AudienceSource.md

@@ -0,0 +1,26 @@
+# Norbelys::AudienceSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** | The source type: a saved segment, a static group, a CSV import, or explicit ids. |  |
+| **label** | **String** | The source's name as it was at enroll time. |  |
+| **people** | **Integer** | People enrolled from this source (accumulated across enrolls). |  |
+| **ref_id** | **String** | The source id (segment/group/import id); \"\" for manually added people. |  |
+| **synced** | **Boolean** | True for a segment kept in CONTINUOUS sync — new matches are auto-enrolled (a dynamic audience). |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceSource.new(
+  kind: null,
+  label: null,
+  people: null,
+  ref_id: null,
+  synced: null
+)
+```
+

data/docs/AudienceStatusBreakdown.md

@@ -0,0 +1,20 @@
+# Norbelys::AudienceStatusBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Lifecycle status represented by this bucket. |  |
+| **value** | **Integer** | People in this status bucket. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceStatusBreakdown.new(
+  status: null,
+  value: null
+)
+```
+

data/docs/AudienceSummary.md

@@ -0,0 +1,26 @@
+# Norbelys::AudienceSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **average_score** | **Float** |  |  |
+| **engaged30d** | **Integer** | People whose last recorded activity was in the last 30 days. |  |
+| **status** | [**Array<AudienceStatusBreakdown>**](AudienceStatusBreakdown.md) | Exact lifecycle-status distribution for the current audience. |  |
+| **total** | **Integer** | Current people in the selected audience or whole workspace. |  |
+| **weekly_created** | [**Array<AudienceWeekPoint>**](AudienceWeekPoint.md) | Current audience members grouped by the week they first entered the workspace, limited to the last 12 weeks. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceSummary.new(
+  average_score: null,
+  engaged30d: null,
+  status: null,
+  total: null,
+  weekly_created: null
+)
+```
+

data/docs/AudienceWeekPoint.md

@@ -0,0 +1,20 @@
+# Norbelys::AudienceWeekPoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **period** | **String** | ISO date (YYYY-MM-DD) for the Monday starting this week. |  |
+| **value** | **Integer** | Current audience members created during this week. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AudienceWeekPoint.new(
+  period: null,
+  value: null
+)
+```
+

data/docs/BulkUpdateSenderPatch.md

@@ -0,0 +1,34 @@
+# Norbelys::BulkUpdateSenderPatch
+
+## 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] |
+| **state** | **String** | Operator-set state to pause or resume the mailbox: `healthy`, `throttled`, or `paused`. | [optional] |
+| **warmup** | [**WarmupSettings**](WarmupSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::BulkUpdateSenderPatch.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,
+  state: null,
+  warmup: null
+)
+```
+

data/docs/BulkUpdateSendersInput.md

@@ -0,0 +1,20 @@
+# Norbelys::BulkUpdateSendersInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | The mailbox ids to update (1–200 per call). |  |
+| **patch** | [**BulkUpdateSenderPatch**](BulkUpdateSenderPatch.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::BulkUpdateSendersInput.new(
+  ids: null,
+  patch: null
+)
+```
+

data/docs/BulkUpdateSendersResult.md

@@ -0,0 +1,24 @@
+# Norbelys::BulkUpdateSendersResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<SenderBulkError>**](SenderBulkError.md) | Per-mailbox failures — every other mailbox still updated. |  |
+| **object** | **Object** |  |  |
+| **senders** | [**Array<Sender>**](Sender.md) | The updated mailboxes. |  |
+| **updated** | **Integer** | How many mailboxes were updated. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::BulkUpdateSendersResult.new(
+  errors: null,
+  object: null,
+  senders: null,
+  updated: null
+)
+```
+

data/docs/CampaignReportShare.md

@@ -0,0 +1,22 @@
+# Norbelys::CampaignReportShare
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Object** |  | [optional] |
+| **object** | **Object** |  |  |
+| **url** | **String** | The public, read-only report URL — share it as-is. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::CampaignReportShare.new(
+  expires_at: null,
+  object: null,
+  url: null
+)
+```
+

data/docs/CollectionAddress.md

@@ -0,0 +1,28 @@
+# Norbelys::CollectionAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | The full `rua` mailto address to put in your DMARC record. |  |
+| **created_at** | **Object** |  | [optional] |
+| **id** | **String** | The collection-address id. |  |
+| **kind** | **String** | What this collection address ingests: `dmarc_rua`, `dmarc_ruf`, `tls_rpt`, or `fbl` (only `dmarc_rua` is active today). |  |
+| **object** | **Object** |  | [optional] |
+| **revoked_at** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::CollectionAddress.new(
+  address: null,
+  created_at: null,
+  id: null,
+  kind: null,
+  object: null,
+  revoked_at: null
+)
+```
+

data/docs/ConnectionSettings.md

@@ -0,0 +1,22 @@
+# Norbelys::ConnectionSettings
+
+## 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] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::ConnectionSettings.new(
+  host: null,
+  port: null,
+  security: null
+)
+```
+

data/docs/CreateSenderInput.md

@@ -0,0 +1,42 @@
+# Norbelys::CreateSenderInput
+
+## 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** |  |  |
+| **transport_provider** | **String** | The voice provider key. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::CreateSenderInput.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,
+  transport_provider: null
+)
+```
+

data/docs/DetachResult.md

@@ -0,0 +1,18 @@
+# Norbelys::DetachResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** | True when the relation was removed. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::DetachResult.new(
+  ok: null
+)
+```
+