norbelys 0.1.0

data/docs/StepWithVariants.md

@@ -0,0 +1,46 @@
+# Norbelys::StepWithVariants
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ab_min_sample** | **Integer** | Minimum sends before a winner can be decided. |  |
+| **ab_mode** | **String** | How the A/B winner is decided: `manual`, `even`, `ai_percentage`. |  |
+| **ab_test_pct** | **Integer** | Percent of leads in the test group while the test holds. |  |
+| **ab_winner_variant_id** | **String** |  |  |
+| **ab_winning_metric** | **String** | Metric the winner is decided by: `reply`, `positive_reply`, `click`, `open`. |  |
+| **archived_at** | **Object** |  | [optional] |
+| **channel** | **String** | Send channel: `email`, `call`, `sms`, `linkedin`. |  |
+| **created_at** | **Object** |  | [optional] |
+| **id** | **String** | The step id. |  |
+| **object** | **Object** |  | [optional] |
+| **order_idx** | **Integer** | Position in the cadence, 0-based. |  |
+| **program_id** | **String** | The owning program's id. |  |
+| **type** | **String** | Step type: `email`, `wait`, `condition`, `call`. |  |
+| **wait_days** | **Integer** | Days to wait after the previous step before this one sends. |  |
+| **variants** | [**Array<Variant>**](Variant.md) | The step's live (un-archived) arms, in creation order. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::StepWithVariants.new(
+  ab_min_sample: null,
+  ab_mode: null,
+  ab_test_pct: null,
+  ab_winner_variant_id: null,
+  ab_winning_metric: null,
+  archived_at: null,
+  channel: null,
+  created_at: null,
+  id: null,
+  object: null,
+  order_idx: null,
+  program_id: null,
+  type: null,
+  wait_days: null,
+  variants: null
+)
+```
+

data/docs/Suppression.md

@@ -0,0 +1,32 @@
+# Norbelys::Suppression
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **created_at** | **Object** |  | [optional] |
+| **email_or_domain** | **String** | The suppressed email address or bare domain. |  |
+| **id** | **String** | The suppression id. |  |
+| **object** | **Object** |  | [optional] |
+| **program_id** | **String** |  |  |
+| **reason** | **String** |  |  |
+| **scope** | [**SuppressionScope**](SuppressionScope.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Suppression.new(
+  archived_at: null,
+  created_at: null,
+  email_or_domain: null,
+  id: null,
+  object: null,
+  program_id: null,
+  reason: null,
+  scope: null
+)
+```
+

data/docs/SuppressionBulkParams.md

@@ -0,0 +1,20 @@
+# Norbelys::SuppressionBulkParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emails** | **Array<String>** | Up to 10,000 email addresses or bare domains to suppress. |  |
+| **reason** | **String** | Free-text note applied to every added entry. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::SuppressionBulkParams.new(
+  emails: null,
+  reason: null
+)
+```
+

data/docs/SuppressionBulkResult.md

@@ -0,0 +1,18 @@
+# Norbelys::SuppressionBulkResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Integer** | How many addresses were newly suppressed (already-suppressed values are skipped). |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::SuppressionBulkResult.new(
+  created: null
+)
+```
+

data/docs/SuppressionCreateParams.md

@@ -0,0 +1,24 @@
+# Norbelys::SuppressionCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_or_domain** | **String** | The email address or bare domain to suppress. |  |
+| **program_id** | **String** | The campaign to scope to; required when scope is \"program\". | [optional] |
+| **reason** | **String** | Free-text note recording why the address is being suppressed. | [optional] |
+| **scope** | **String** | Suppression scope: \"org\" (the default) suppresses everywhere; \"program\" suppresses within one campaign only. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::SuppressionCreateParams.new(
+  email_or_domain: null,
+  program_id: null,
+  reason: null,
+  scope: null
+)
+```
+

data/docs/SuppressionList.md

@@ -0,0 +1,26 @@
+# Norbelys::SuppressionList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Suppression>**](Suppression.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::SuppressionList.new(
+  data: null,
+  has_more: null,
+  next_cursor: null,
+  object: null,
+  total: null
+)
+```
+

data/docs/SuppressionScope.md

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

data/docs/SuppressionsApi.md

@@ -0,0 +1,369 @@
+# Norbelys::SuppressionsApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**suppressions_archive**](SuppressionsApi.md#suppressions_archive) | **DELETE** /suppressions/{id} | Delete a suppression |
+| [**suppressions_bulk**](SuppressionsApi.md#suppressions_bulk) | **POST** /suppressions/bulk | Bulk-suppress addresses |
+| [**suppressions_create**](SuppressionsApi.md#suppressions_create) | **POST** /suppressions | Suppress an address or domain |
+| [**suppressions_find**](SuppressionsApi.md#suppressions_find) | **GET** /suppressions/{id} | Get a suppression |
+| [**suppressions_list**](SuppressionsApi.md#suppressions_list) | **GET** /suppressions | List suppressions |
+
+
+## suppressions_archive
+
+> <Suppression> suppressions_archive(id)
+
+Delete a suppression
+
+### 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::SuppressionsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a suppression
+  result = api_instance.suppressions_archive(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_archive: #{e}"
+end
+```
+
+#### Using the suppressions_archive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Suppression>, Integer, Hash)> suppressions_archive_with_http_info(id)
+
+```ruby
+begin
+  # Delete a suppression
+  data, status_code, headers = api_instance.suppressions_archive_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Suppression>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_archive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Suppression**](Suppression.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## suppressions_bulk
+
+> <SuppressionBulkResult> suppressions_bulk(suppression_bulk_params, opts)
+
+Bulk-suppress addresses
+
+Add many email addresses or bare domains to the do-not-contact list in one call (up to 10,000). Idempotent per value — already-suppressed entries are skipped; the response returns how many were newly added.
+
+### 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::SuppressionsApi.new
+suppression_bulk_params = Norbelys::SuppressionBulkParams.new({emails: ['emails_example']}) # SuppressionBulkParams | 
+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-suppress addresses
+  result = api_instance.suppressions_bulk(suppression_bulk_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_bulk: #{e}"
+end
+```
+
+#### Using the suppressions_bulk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuppressionBulkResult>, Integer, Hash)> suppressions_bulk_with_http_info(suppression_bulk_params, opts)
+
+```ruby
+begin
+  # Bulk-suppress addresses
+  data, status_code, headers = api_instance.suppressions_bulk_with_http_info(suppression_bulk_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuppressionBulkResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_bulk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suppression_bulk_params** | [**SuppressionBulkParams**](SuppressionBulkParams.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
+
+[**SuppressionBulkResult**](SuppressionBulkResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## suppressions_create
+
+> <Suppression> suppressions_create(suppression_create_params, opts)
+
+Suppress an address or domain
+
+Add one email address or bare domain to the do-not-contact list so it is never emailed. Idempotent and lowercased — re-suppressing an existing value is a no-op, not an error. Defaults to org-wide scope; pass scope `program` with a `programId` to suppress within a single campaign only. To add many at once, use bulk instead.
+
+### 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::SuppressionsApi.new
+suppression_create_params = Norbelys::SuppressionCreateParams.new({email_or_domain: 'email_or_domain_example'}) # SuppressionCreateParams | 
+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
+  # Suppress an address or domain
+  result = api_instance.suppressions_create(suppression_create_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_create: #{e}"
+end
+```
+
+#### Using the suppressions_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Suppression>, Integer, Hash)> suppressions_create_with_http_info(suppression_create_params, opts)
+
+```ruby
+begin
+  # Suppress an address or domain
+  data, status_code, headers = api_instance.suppressions_create_with_http_info(suppression_create_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Suppression>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suppression_create_params** | [**SuppressionCreateParams**](SuppressionCreateParams.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
+
+[**Suppression**](Suppression.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## suppressions_find
+
+> <Suppression> suppressions_find(id)
+
+Get a suppression
+
+Read one suppression entry by id.
+
+### 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::SuppressionsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a suppression
+  result = api_instance.suppressions_find(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_find: #{e}"
+end
+```
+
+#### Using the suppressions_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Suppression>, Integer, Hash)> suppressions_find_with_http_info(id)
+
+```ruby
+begin
+  # Get a suppression
+  data, status_code, headers = api_instance.suppressions_find_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Suppression>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Suppression**](Suppression.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## suppressions_list
+
+> <SuppressionList> suppressions_list(opts)
+
+List suppressions
+
+List the org's do-not-contact entries — suppressed email addresses and bare domains — newest first. A suppressed address or domain is never emailed by any campaign.
+
+### 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::SuppressionsApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  include_archived: true, # Boolean | 
+  limit: 56 # Integer | 
+}
+
+begin
+  # List suppressions
+  result = api_instance.suppressions_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_list: #{e}"
+end
+```
+
+#### Using the suppressions_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuppressionList>, Integer, Hash)> suppressions_list_with_http_info(opts)
+
+```ruby
+begin
+  # List suppressions
+  data, status_code, headers = api_instance.suppressions_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuppressionList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling SuppressionsApi->suppressions_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **include_archived** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+
+### Return type
+
+[**SuppressionList**](SuppressionList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SyncModel.md

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

data/docs/TeamSize.md

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

data/docs/TrackingDnsRecord.md

@@ -0,0 +1,22 @@
+# Norbelys::TrackingDnsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | The CNAME host to create. |  |
+| **type** | **Object** |  |  |
+| **value** | **String** | The CNAME target to point at. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::TrackingDnsRecord.new(
+  host: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/UpdateSenderInput.md

@@ -0,0 +1,48 @@
+# Norbelys::UpdateSenderInput
+
+## 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] |
+| **archived_at** | **Integer** |  | [optional] |
+| **from_email** | **String** | The sending address (re-verifies the mailbox when changed). | [optional] |
+| **from_name** | **String** | Display name. | [optional] |
+| **imap** | [**ImapConnectionUpdate**](ImapConnectionUpdate.md) |  | [optional] |
+| **smtp** | [**SmtpConnectionUpdate**](SmtpConnectionUpdate.md) |  | [optional] |
+| **transport_mode** | **String** | How messages are carried: `smtp`, `provider_api`, `self_hosted`, or `voice`. | [optional] |
+| **transport_provider** | **String** | Managed provider; omit for a plain cold/SMTP mailbox. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::UpdateSenderInput.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,
+  archived_at: null,
+  from_email: null,
+  from_name: null,
+  imap: null,
+  smtp: null,
+  transport_mode: null,
+  transport_provider: null
+)
+```
+

data/docs/UsageMeter.md

@@ -0,0 +1,22 @@
+# Norbelys::UsageMeter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **level** | **String** | `ok`, `near` (~80% of the cap used) or `reached` (at/over the cap). Example: `near`. |  |
+| **limit** | **Integer** |  |  |
+| **used** | **Integer** | Current usage against the cap. Example: 4. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::UsageMeter.new(
+  level: null,
+  limit: null,
+  used: null
+)
+```
+