norbelys 0.1.0

data/docs/PeopleBulkCreateResult.md

@@ -0,0 +1,34 @@
+# Norbelys::PeopleBulkCreateResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Integer** | Number of people actually inserted. |  |
+| **enrolled** | **Integer** | Total enrollments created across all `campaignIds` (0 when none requested). |  |
+| **fields_dropped** | **Integer** | Individual field VALUES dropped as invalid (an unparseable phone, a malformed `email`/`phone` custom-field value). The person was still imported — only the bad value was left out. |  |
+| **grouped** | **Integer** | Total group memberships created across all `groupIds` (0 when none requested). |  |
+| **ids** | **Array<String>** | Ids of EVERY matched person (new + pre-existing), for enrolling the whole set. |  |
+| **import_id** | **String** | The import id — poll its verification stats at GET /v1/people/bulk/{importId}. |  |
+| **rejected** | **Integer** | People dropped because the email was malformed — never inserted, and never fatal to the rest of the batch. |  |
+| **skipped** | **Integer** | People skipped as duplicate emails (already exist). |  |
+| **updated** | **Integer** | Existing people updated in place. 0 when `onConflict` is `skip`. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PeopleBulkCreateResult.new(
+  created: null,
+  enrolled: null,
+  fields_dropped: null,
+  grouped: null,
+  ids: null,
+  import_id: null,
+  rejected: null,
+  skipped: null,
+  updated: null
+)
+```
+

data/docs/Person.md

@@ -0,0 +1,52 @@
+# Norbelys::Person
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **created_at** | **Object** |  | [optional] |
+| **custom_fields** | **Hash<String, Object>** |  |  |
+| **email** | **String** |  |  |
+| **email_domain** | **String** |  |  |
+| **family_name** | **String** |  |  |
+| **given_name** | **String** |  |  |
+| **id** | **String** | The person id. |  |
+| **import_id** | **String** |  |  |
+| **last_activity_at** | **Object** |  | [optional] |
+| **object** | **Object** |  | [optional] |
+| **private_notes** | **String** |  |  |
+| **score** | **Integer** |  |  |
+| **source** | **String** | Where the person came from: `csv_import`, `manual`, `api`, `form`, `inbound`, `integration`. |  |
+| **status** | **String** | Lifecycle status: `active`, `replied`, `bounced`, `unsubscribed`, `finished`. |  |
+| **telephone** | **String** |  |  |
+| **telephones** | **Array<String>** |  |  |
+| **updated_at** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Person.new(
+  archived_at: null,
+  created_at: null,
+  custom_fields: null,
+  email: null,
+  email_domain: null,
+  family_name: null,
+  given_name: null,
+  id: null,
+  import_id: null,
+  last_activity_at: null,
+  object: null,
+  private_notes: null,
+  score: null,
+  source: null,
+  status: null,
+  telephone: null,
+  telephones: null,
+  updated_at: null
+)
+```
+

data/docs/PersonCreateParams.md

@@ -0,0 +1,30 @@
+# Norbelys::PersonCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_fields** | **Hash<String, Object>** | Custom field values keyed by code (see the Fields page). | [optional] |
+| **email** | **String** | The person's email address. |  |
+| **family_name** | **String** | The person's last name. | [optional] |
+| **given_name** | **String** | The person's first name. | [optional] |
+| **source** | **String** | Where this person came from: `csv_import`, `manual`, `api`, `form`, `inbound`, `integration`. Defaults to `manual`. | [optional] |
+| **telephone** | **String** | The primary telephone number. Normalized to E.164 on write; an invalid number is dropped (the person still saves), never fatal. | [optional] |
+| **telephones** | **Array<String>** | Additional telephone numbers. Merged with `telephone`, normalized to E.164, deduped; invalid entries are dropped. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonCreateParams.new(
+  custom_fields: null,
+  email: null,
+  family_name: null,
+  given_name: null,
+  source: null,
+  telephone: null,
+  telephones: null
+)
+```
+

data/docs/PersonDetail.md

@@ -0,0 +1,60 @@
+# Norbelys::PersonDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **created_at** | **Object** |  | [optional] |
+| **custom_fields** | **Hash<String, Object>** |  |  |
+| **email** | **String** |  |  |
+| **email_domain** | **String** |  |  |
+| **family_name** | **String** |  |  |
+| **given_name** | **String** |  |  |
+| **id** | **String** | The person id. |  |
+| **import_id** | **String** |  |  |
+| **last_activity_at** | **Object** |  | [optional] |
+| **object** | **Object** |  | [optional] |
+| **private_notes** | **String** |  |  |
+| **score** | **Integer** |  |  |
+| **source** | **String** | Where the person came from: `csv_import`, `manual`, `api`, `form`, `inbound`, `integration`. |  |
+| **status** | **String** | Lifecycle status: `active`, `replied`, `bounced`, `unsubscribed`, `finished`. |  |
+| **telephone** | **String** |  |  |
+| **telephones** | **Array<String>** |  |  |
+| **updated_at** | **Object** |  | [optional] |
+| **enrollments** | [**Array<Enrollment>**](Enrollment.md) | Expansion: the person's enrollments across all campaigns. | [optional] |
+| **groups** | [**Array<PersonGroupRef>**](PersonGroupRef.md) | Expansion: the static groups this person belongs to. | [optional] |
+| **segments** | [**Array<PersonSegmentRef>**](PersonSegmentRef.md) | Expansion: the dynamic segments this person currently matches. | [optional] |
+| **timeline** | [**Array<Message>**](Message.md) | Expansion: the person's merged sent + received messages, newest first. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonDetail.new(
+  archived_at: null,
+  created_at: null,
+  custom_fields: null,
+  email: null,
+  email_domain: null,
+  family_name: null,
+  given_name: null,
+  id: null,
+  import_id: null,
+  last_activity_at: null,
+  object: null,
+  private_notes: null,
+  score: null,
+  source: null,
+  status: null,
+  telephone: null,
+  telephones: null,
+  updated_at: null,
+  enrollments: null,
+  groups: null,
+  segments: null,
+  timeline: null
+)
+```
+

data/docs/PersonErased.md

@@ -0,0 +1,20 @@
+# Norbelys::PersonErased
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **erased** | **Object** |  |  |
+| **id** | **String** | The erased person's id. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonErased.new(
+  erased: null,
+  id: null
+)
+```
+

data/docs/PersonGroupRef.md

@@ -0,0 +1,22 @@
+# Norbelys::PersonGroupRef
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The reference id. |  |
+| **name** | **String** | Display name. |  |
+| **color** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonGroupRef.new(
+  id: null,
+  name: null,
+  color: null
+)
+```
+

data/docs/PersonImportItem.md

@@ -0,0 +1,30 @@
+# Norbelys::PersonImportItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_fields** | **Hash<String, Object>** | Custom field values keyed by code (see the Fields page). | [optional] |
+| **email** | **String** | The person's email address. A malformed address is skipped (counted in `rejected`), never fatal to the batch. |  |
+| **family_name** | **String** | The person's last name. | [optional] |
+| **given_name** | **String** | The person's first name. | [optional] |
+| **source** | **String** | Where this person came from: `csv_import`, `manual`, `api`, `form`, `inbound`, `integration`. Defaults to `manual`. | [optional] |
+| **telephone** | **String** | The primary telephone number. Normalized to E.164 on write; an invalid number is dropped (the person still saves), never fatal. | [optional] |
+| **telephones** | **Array<String>** | Additional telephone numbers. Merged with `telephone`, normalized to E.164, deduped; invalid entries are dropped. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonImportItem.new(
+  custom_fields: null,
+  email: null,
+  family_name: null,
+  given_name: null,
+  source: null,
+  telephone: null,
+  telephones: null
+)
+```
+

data/docs/PersonImportReason.md

@@ -0,0 +1,22 @@
+# Norbelys::PersonImportReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | People in this (outcome, reason) bucket. |  |
+| **outcome** | **String** | Which outcome bucket this reason belongs to: `sendable`, `suppressed_new`, or `suppressed_existing`. |  |
+| **reason_code** | **String** | Machine-readable reason for the verdict (typo_suspected · invalid_tld · disposable · no_mail_server · previously_bounced · spam_listed · role_account · …). |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonImportReason.new(
+  count: null,
+  outcome: null,
+  reason_code: null
+)
+```
+

data/docs/PersonImportStats.md

@@ -0,0 +1,36 @@
+# Norbelys::PersonImportStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Integer** | New people this import inserted. |  |
+| **id** | **String** | The import id. |  |
+| **object** | **Object** |  | [optional] |
+| **pending** | **Integer** | Created people still awaiting a verdict (`created − processed`). |  |
+| **processed** | **Integer** | How many of the created people have been verified so far. |  |
+| **reasons** | [**Array<PersonImportReason>**](PersonImportReason.md) | The cleaning report: WHAT the verification found, per reason — which addresses were removed as dead domains, likely typos, disposables, previously bounced, and so on. Ordered by count, descending. |  |
+| **sendable** | **Integer** | Verified and safe to email. |  |
+| **status** | **String** | `processing` while addresses are still being verified, `completed` once every created person has a verdict. |  |
+| **suppressed_existing** | **Integer** | Already on the suppression list before the import, so verification was skipped. |  |
+| **suppressed_new** | **Integer** | Newly suppressed by an undeliverable verdict. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonImportStats.new(
+  created: null,
+  id: null,
+  object: null,
+  pending: null,
+  processed: null,
+  reasons: null,
+  sendable: null,
+  status: null,
+  suppressed_existing: null,
+  suppressed_new: null
+)
+```
+

data/docs/PersonList.md

@@ -0,0 +1,26 @@
+# Norbelys::PersonList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<PersonListItem>**](PersonListItem.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** | Count of ALL people matching the filters. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonList.new(
+  data: null,
+  has_more: null,
+  next_cursor: null,
+  object: null,
+  total: null
+)
+```
+

data/docs/PersonListItem.md

@@ -0,0 +1,50 @@
+# Norbelys::PersonListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **created_at** | **Object** |  | [optional] |
+| **custom_fields** | **Hash<String, Object>** |  |  |
+| **email** | **String** |  |  |
+| **email_domain** | **String** |  |  |
+| **family_name** | **String** |  |  |
+| **given_name** | **String** |  |  |
+| **id** | **String** | The person id. |  |
+| **import_id** | **String** |  |  |
+| **last_activity_at** | **Object** |  | [optional] |
+| **object** | **Object** |  | [optional] |
+| **score** | **Integer** |  |  |
+| **source** | **String** | Where the person came from: `csv_import`, `manual`, `api`, `form`, `inbound`, `integration`. |  |
+| **status** | **String** | Lifecycle status: `active`, `replied`, `bounced`, `unsubscribed`, `finished`. |  |
+| **telephone** | **String** |  |  |
+| **telephones** | **Array<String>** |  |  |
+| **updated_at** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonListItem.new(
+  archived_at: null,
+  created_at: null,
+  custom_fields: null,
+  email: null,
+  email_domain: null,
+  family_name: null,
+  given_name: null,
+  id: null,
+  import_id: null,
+  last_activity_at: null,
+  object: null,
+  score: null,
+  source: null,
+  status: null,
+  telephone: null,
+  telephones: null,
+  updated_at: null
+)
+```
+

data/docs/PersonSegmentRef.md

@@ -0,0 +1,22 @@
+# Norbelys::PersonSegmentRef
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The reference id. |  |
+| **name** | **String** | Display name. |  |
+| **description** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonSegmentRef.new(
+  id: null,
+  name: null,
+  description: null
+)
+```
+

data/docs/PersonUpdateParams.md

@@ -0,0 +1,30 @@
+# Norbelys::PersonUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_fields** | **Hash<String, Object>** |  | [optional] |
+| **family_name** | **String** |  | [optional] |
+| **given_name** | **String** |  | [optional] |
+| **private_notes** | **String** |  | [optional] |
+| **status** | **String** | Set the lifecycle status: `active`, `replied`, `bounced`, `unsubscribed`, `finished`. | [optional] |
+| **telephone** | **String** |  | [optional] |
+| **telephones** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PersonUpdateParams.new(
+  custom_fields: null,
+  family_name: null,
+  given_name: null,
+  private_notes: null,
+  status: null,
+  telephone: null,
+  telephones: null
+)
+```
+

data/docs/Program.md

@@ -0,0 +1,78 @@
+# Norbelys::Program
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_days** | **Array<Integer>** |  |  |
+| **add_unsubscribe** | **Boolean** | Attach RFC 8058 one-click unsubscribe headers + footer. |  |
+| **archived_at** | **Object** |  | [optional] |
+| **auto_pause_on_company_reply** | **Boolean** | Pause every lead at a company once one of them replies. |  |
+| **bounce_pause_threshold** | **Float** | Auto-pause when the bounce rate reaches this percent; 0 disables. |  |
+| **created_at** | **Object** |  | [optional] |
+| **id** | **String** | The program id. |  |
+| **jitter_max_seconds** | **Integer** | Random extra wait per send, upper bound (seconds). |  |
+| **jitter_min_seconds** | **Integer** | Random extra wait per send, lower bound (seconds). |  |
+| **kind** | **String** | Kind of sending; `cold_sequence` is the only kind today. |  |
+| **name** | **String** | Display name. |  |
+| **new_per_day** | **Integer** | New leads started per day for the WHOLE campaign, shared across all its mailboxes (follow-ups are not counted). 0 = no daily cap — new leads flow at mailbox capacity. Real throughput is always bounded by the mailboxes' own daily limits. |  |
+| **object** | **Object** |  | [optional] |
+| **paused_at** | **Object** |  | [optional] |
+| **paused_meta** | [**ProgramPauseMeta**](ProgramPauseMeta.md) |  |  |
+| **paused_reason** | **String** |  |  |
+| **plain_text_mode** | **Boolean** | Send the body as plain text only: no HTML part, open pixel, or link tracking. |  |
+| **send_interval_minutes** | **Integer** | Minutes between sends from one mailbox. |  |
+| **spam_pause_threshold** | **Float** | Auto-pause when the spam-complaint rate reaches this percent; 0 disables. |  |
+| **start_date** | **Object** |  | [optional] |
+| **status** | **String** | Lifecycle status: `draft`, `active`, `paused`, `done`. |  |
+| **stop_condition** | **String** | Engagement that pulls a lead out of the cadence: `reply`, `click`, `open`, `none`. |  |
+| **timezone** | **String** | IANA timezone the window applies in. |  |
+| **track_clicks** | **Boolean** | Rewrite links to track clicks. |  |
+| **tracking_domain_id** | **String** |  |  |
+| **track_opens** | **Boolean** | Insert the open pixel. |  |
+| **unsubscribe_text** | **String** |  |  |
+| **updated_at** | **Object** |  | [optional] |
+| **variant_distribution** | **String** | How A/B arms are spread across leads with no decided winner: `pattern` (deterministic per-lead hash) or `random` (independent roll per lead). |  |
+| **window_from** | **String** |  |  |
+| **window_to** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Program.new(
+  active_days: null,
+  add_unsubscribe: null,
+  archived_at: null,
+  auto_pause_on_company_reply: null,
+  bounce_pause_threshold: null,
+  created_at: null,
+  id: null,
+  jitter_max_seconds: null,
+  jitter_min_seconds: null,
+  kind: null,
+  name: null,
+  new_per_day: null,
+  object: null,
+  paused_at: null,
+  paused_meta: null,
+  paused_reason: null,
+  plain_text_mode: null,
+  send_interval_minutes: null,
+  spam_pause_threshold: null,
+  start_date: null,
+  status: null,
+  stop_condition: null,
+  timezone: null,
+  track_clicks: null,
+  tracking_domain_id: null,
+  track_opens: null,
+  unsubscribe_text: null,
+  updated_at: null,
+  variant_distribution: null,
+  window_from: null,
+  window_to: null
+)
+```
+

data/docs/ProgramCreateParams.md

@@ -0,0 +1,62 @@
+# Norbelys::ProgramCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_days** | **Array<Integer>** |  | [optional] |
+| **add_unsubscribe** | **Boolean** | Attach RFC 8058 one-click unsubscribe headers + footer. Defaults off (opt-in). | [optional] |
+| **auto_pause_on_company_reply** | **Boolean** | Pause every lead at a company once one of them replies. | [optional] |
+| **bounce_pause_threshold** | **Float** | Auto-pause when the bounce rate reaches this percent; 0 disables. Default 2. | [optional] |
+| **jitter_max_seconds** | **Integer** | Random extra wait per send, upper bound (seconds). | [optional] |
+| **jitter_min_seconds** | **Integer** | Random extra wait per send, lower bound (seconds). | [optional] |
+| **kind** | **String** | Defaults to \"cold_sequence\". | [optional] |
+| **name** | **String** | Display name. |  |
+| **new_per_day** | **Integer** | New leads started per day for the whole campaign, shared across all its mailboxes (follow-ups excluded); 0 = uncapped. | [optional] |
+| **plain_text_mode** | **Boolean** | Send the body as plain text only: no HTML part, open pixel, or link tracking. | [optional] |
+| **send_interval_minutes** | **Integer** | Minutes between sends from one mailbox (cold-email floor is 3). | [optional] |
+| **spam_pause_threshold** | **Float** | Auto-pause when the spam-complaint rate reaches this percent; 0 disables. Default 0.3. | [optional] |
+| **start_date** | **Integer** |  | [optional] |
+| **steps** | [**Array<ProgramStepInput>**](ProgramStepInput.md) | Build the whole cadence in one call: ordered steps, each with its arms. Omit to start empty and add steps later via programs.update. | [optional] |
+| **stop_condition** | **String** | Engagement that pulls a lead out of the cadence: `reply`, `click`, `open`, `none`. | [optional] |
+| **timezone** | **String** | IANA timezone. | [optional] |
+| **track_clicks** | **Boolean** | Rewrite links to track clicks. | [optional] |
+| **tracking_domain_id** | **String** |  | [optional] |
+| **track_opens** | **Boolean** | Insert the open pixel. | [optional] |
+| **unsubscribe_text** | **String** | Custom unsubscribe footer copy. | [optional] |
+| **variant_distribution** | **String** | How A/B arms are spread across leads with no decided winner: `pattern` (deterministic per-lead hash) or `random` (independent roll per lead). | [optional] |
+| **window_from** | **String** |  | [optional] |
+| **window_to** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::ProgramCreateParams.new(
+  active_days: null,
+  add_unsubscribe: null,
+  auto_pause_on_company_reply: null,
+  bounce_pause_threshold: null,
+  jitter_max_seconds: null,
+  jitter_min_seconds: null,
+  kind: null,
+  name: null,
+  new_per_day: null,
+  plain_text_mode: null,
+  send_interval_minutes: null,
+  spam_pause_threshold: null,
+  start_date: null,
+  steps: null,
+  stop_condition: null,
+  timezone: null,
+  track_clicks: null,
+  tracking_domain_id: null,
+  track_opens: null,
+  unsubscribe_text: null,
+  variant_distribution: null,
+  window_from: null,
+  window_to: null
+)
+```
+

data/docs/ProgramDetail.md

@@ -0,0 +1,84 @@
+# Norbelys::ProgramDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_days** | **Array<Integer>** |  |  |
+| **add_unsubscribe** | **Boolean** | Attach RFC 8058 one-click unsubscribe headers + footer. |  |
+| **archived_at** | **Object** |  | [optional] |
+| **auto_pause_on_company_reply** | **Boolean** | Pause every lead at a company once one of them replies. |  |
+| **bounce_pause_threshold** | **Float** | Auto-pause when the bounce rate reaches this percent; 0 disables. |  |
+| **created_at** | **Object** |  | [optional] |
+| **id** | **String** | The program id. |  |
+| **jitter_max_seconds** | **Integer** | Random extra wait per send, upper bound (seconds). |  |
+| **jitter_min_seconds** | **Integer** | Random extra wait per send, lower bound (seconds). |  |
+| **kind** | **String** | Kind of sending; `cold_sequence` is the only kind today. |  |
+| **name** | **String** | Display name. |  |
+| **new_per_day** | **Integer** | New leads started per day for the WHOLE campaign, shared across all its mailboxes (follow-ups are not counted). 0 = no daily cap — new leads flow at mailbox capacity. Real throughput is always bounded by the mailboxes' own daily limits. |  |
+| **object** | **Object** |  | [optional] |
+| **paused_at** | **Object** |  | [optional] |
+| **paused_meta** | [**ProgramPauseMeta**](ProgramPauseMeta.md) |  |  |
+| **paused_reason** | **String** |  |  |
+| **plain_text_mode** | **Boolean** | Send the body as plain text only: no HTML part, open pixel, or link tracking. |  |
+| **send_interval_minutes** | **Integer** | Minutes between sends from one mailbox. |  |
+| **spam_pause_threshold** | **Float** | Auto-pause when the spam-complaint rate reaches this percent; 0 disables. |  |
+| **start_date** | **Object** |  | [optional] |
+| **status** | **String** | Lifecycle status: `draft`, `active`, `paused`, `done`. |  |
+| **stop_condition** | **String** | Engagement that pulls a lead out of the cadence: `reply`, `click`, `open`, `none`. |  |
+| **timezone** | **String** | IANA timezone the window applies in. |  |
+| **track_clicks** | **Boolean** | Rewrite links to track clicks. |  |
+| **tracking_domain_id** | **String** |  |  |
+| **track_opens** | **Boolean** | Insert the open pixel. |  |
+| **unsubscribe_text** | **String** |  |  |
+| **updated_at** | **Object** |  | [optional] |
+| **variant_distribution** | **String** | How A/B arms are spread across leads with no decided winner: `pattern` (deterministic per-lead hash) or `random` (independent roll per lead). |  |
+| **window_from** | **String** |  |  |
+| **window_to** | **String** |  |  |
+| **stats** | [**ProgramStats**](ProgramStats.md) |  |  |
+| **senders** | [**Array<ProgramSenderRef>**](ProgramSenderRef.md) | The attached mailboxes — present when expand[]=senders. | [optional] |
+| **steps** | [**Array<StepWithVariants>**](StepWithVariants.md) | The cadence with arms — present when expand[]=steps (always returned by create/update). | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::ProgramDetail.new(
+  active_days: null,
+  add_unsubscribe: null,
+  archived_at: null,
+  auto_pause_on_company_reply: null,
+  bounce_pause_threshold: null,
+  created_at: null,
+  id: null,
+  jitter_max_seconds: null,
+  jitter_min_seconds: null,
+  kind: null,
+  name: null,
+  new_per_day: null,
+  object: null,
+  paused_at: null,
+  paused_meta: null,
+  paused_reason: null,
+  plain_text_mode: null,
+  send_interval_minutes: null,
+  spam_pause_threshold: null,
+  start_date: null,
+  status: null,
+  stop_condition: null,
+  timezone: null,
+  track_clicks: null,
+  tracking_domain_id: null,
+  track_opens: null,
+  unsubscribe_text: null,
+  updated_at: null,
+  variant_distribution: null,
+  window_from: null,
+  window_to: null,
+  stats: null,
+  senders: null,
+  steps: null
+)
+```
+