norbelys 0.1.0

data/docs/UsagePlan.md

@@ -0,0 +1,22 @@
+# Norbelys::UsagePlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ai_budget_usd_monthly** | **Float** | Monthly AI budget included with the plan, in USD. Example: 50. |  |
+| **name** | **String** | Plan display name. Example: \"Growth\". |  |
+| **slug** | **String** | Plan slug: `starter`, `growth`, `scale`, or `none` (no paid plan). Example: `growth`. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::UsagePlan.new(
+  ai_budget_usd_monthly: null,
+  name: null,
+  slug: null
+)
+```
+

data/docs/Variant.md

@@ -0,0 +1,34 @@
+# Norbelys::Variant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **channel** | **String** | Send channel: `email`, `call`, `sms`, `linkedin`. |  |
+| **content** | [**EmailVariantContent**](EmailVariantContent.md) |  |  |
+| **created_at** | **Object** |  | [optional] |
+| **id** | **String** | The variant id. |  |
+| **label** | **String** | Short arm label, e.g. A / B. |  |
+| **object** | **Object** |  | [optional] |
+| **step_id** | **String** | The owning step's id. |  |
+| **weight** | **Float** | Relative distribution weight among live variants. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Variant.new(
+  archived_at: null,
+  channel: null,
+  content: null,
+  created_at: null,
+  id: null,
+  label: null,
+  object: null,
+  step_id: null,
+  weight: null
+)
+```
+

data/docs/VariantAi.md

@@ -0,0 +1,22 @@
+# Norbelys::VariantAi
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** | Language for the generated email (e.g. 'es', 'en'). Default: mirror the base template's language. | [optional] |
+| **prompt** | **String** | The operator's personalization instruction — what to emphasize, tone, goal. The AI keeps the base template's intent and CTA; it never invents facts about the recipient. |  |
+| **signals** | **Array<String>** | What research feeds the generation. `company` = firmographics for the recipient's domain (industry, city, size — one cached lookup per domain); `person` = the contact's own fields; `website` = read the recipient company's own site (business domains only — public/free-mail addresses are skipped; fetched once per domain and cached). Default: company + person. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::VariantAi.new(
+  language: null,
+  prompt: null,
+  signals: null
+)
+```
+

data/docs/VerifyApi.md

@@ -0,0 +1,81 @@
+# Norbelys::VerifyApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**verify_email**](VerifyApi.md#verify_email) | **POST** /verify | Verify an email address |
+
+
+## verify_email
+
+> <VerifyResult> verify_email(verify_email_input, opts)
+
+Verify an email address
+
+Synchronously check whether one email address is deliverable. The `reachability` verdict is the headline outcome: `safe` (the mailbox was positively confirmed — requires an external escalation, so rarely returned today), `risky` (routable but low quality, such as a spam-listed domain or a role/shared inbox), `invalid` (undeliverable: bad syntax, no mail server, a disposable domain, or an address that hard-bounced on a real send before), or `unknown` (deliverable-looking but not confirmed without sending, the common default). It also returns a 0–100 `score`, a stable `reasonCode` twinned with the prose `reason`, a `suggestedCorrection` for likely typos, and the `syntax`/`mx`/`signals` evidence. The result is computed per request: it is not stored and has no 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::VerifyApi.new
+verify_email_input = Norbelys::VerifyEmailInput.new({email: 'email_example'}) # VerifyEmailInput | 
+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
+  # Verify an email address
+  result = api_instance.verify_email(verify_email_input, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling VerifyApi->verify_email: #{e}"
+end
+```
+
+#### Using the verify_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifyResult>, Integer, Hash)> verify_email_with_http_info(verify_email_input, opts)
+
+```ruby
+begin
+  # Verify an email address
+  data, status_code, headers = api_instance.verify_email_with_http_info(verify_email_input, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifyResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling VerifyApi->verify_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verify_email_input** | [**VerifyEmailInput**](VerifyEmailInput.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
+
+[**VerifyResult**](VerifyResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/VerifyEmailInput.md

@@ -0,0 +1,18 @@
+# Norbelys::VerifyEmailInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The email address to verify. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::VerifyEmailInput.new(
+  email: null
+)
+```
+

data/docs/VerifyMx.md

@@ -0,0 +1,22 @@
+# Norbelys::VerifyMx
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accepts_mail** | **Boolean** | Domain has MX records (or an implicit A-record MX, RFC 5321). |  |
+| **provider** | **String** |  |  |
+| **records** | **Array<String>** | MX hostnames, lowercased, deduped. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::VerifyMx.new(
+  accepts_mail: null,
+  provider: null,
+  records: null
+)
+```
+

data/docs/VerifyReachability.md

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

data/docs/VerifyReasonCode.md

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

data/docs/VerifyResult.md

@@ -0,0 +1,38 @@
+# Norbelys::VerifyResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checked_at** | **Time** | When this verdict was computed (RFC 3339). Verdicts are cached for 24h, so this can be up to a day old. |  |
+| **email** | **String** | The normalized (trimmed, lowercased) address that was checked. |  |
+| **mx** | [**VerifyMx**](VerifyMx.md) |  |  |
+| **object** | **Object** |  | [optional] |
+| **reachability** | [**VerifyReachability**](VerifyReachability.md) |  |  |
+| **reason** | **String** | A short, human-readable explanation of the verdict. |  |
+| **reason_code** | [**VerifyReasonCode**](VerifyReasonCode.md) |  |  |
+| **score** | **Integer** | Quality and confidence score from 0 to 100; higher means more likely a real, deliverable address. |  |
+| **signals** | [**VerifySignals**](VerifySignals.md) |  |  |
+| **suggested_correction** | **String** |  |  |
+| **syntax** | [**VerifySyntax**](VerifySyntax.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::VerifyResult.new(
+  checked_at: null,
+  email: null,
+  mx: null,
+  object: null,
+  reachability: null,
+  reason: null,
+  reason_code: null,
+  score: null,
+  signals: null,
+  suggested_correction: null,
+  syntax: null
+)
+```
+

data/docs/VerifySignals.md

@@ -0,0 +1,28 @@
+# Norbelys::VerifySignals
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_disposable** | **Boolean** | Domain is a known disposable / temporary-mail provider. |  |
+| **is_free_email** | **Boolean** | Domain is a consumer webmail provider (gmail, outlook, …). |  |
+| **is_gibberish** | **Boolean** | The local part looks like random characters — likely not a real person's mailbox. |  |
+| **is_reputable** | **Boolean** | Domain is among the reputable top domains — a positive trust signal. |  |
+| **is_role_account** | **Boolean** | Local part is a role account (e.g. \"info\", \"support\"). |  |
+| **is_spam_domain** | **Boolean** | Domain is on a spam/abuse blocklist — a reputation hazard to send to. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::VerifySignals.new(
+  is_disposable: null,
+  is_free_email: null,
+  is_gibberish: null,
+  is_reputable: null,
+  is_role_account: null,
+  is_spam_domain: null
+)
+```
+

data/docs/VerifySyntax.md

@@ -0,0 +1,22 @@
+# Norbelys::VerifySyntax
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | The domain part of the address. |  |
+| **is_valid_syntax** | **Boolean** | RFC 5321/5322 syntactic validity. |  |
+| **local_part** | **String** | The local part of the address (before the @). |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::VerifySyntax.new(
+  domain: null,
+  is_valid_syntax: null,
+  local_part: null
+)
+```
+

data/docs/VoiceSenderInput.md

@@ -0,0 +1,38 @@
+# Norbelys::VoiceSenderInput
+
+## 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. |  |
+| **transport_mode** | **Object** |  |  |
+| **transport_provider** | **String** | The voice provider key. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::VoiceSenderInput.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,
+  transport_mode: null,
+  transport_provider: null
+)
+```
+

data/docs/WarmupRuntimeStatus.md

@@ -0,0 +1,32 @@
+# Norbelys::WarmupRuntimeStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_conversations** | **Integer** | Warmup conversations currently in flight for this mailbox. |  |
+| **cohort_id** | **String** |  |  |
+| **cohort_size** | **Integer** | Number of peer mailboxes in the current cohort (0–10). |  |
+| **health** | **String** | Engine-computed warmup health: `healthy`, `degraded`, `saturated`, `auth_broken`, `bouncing`, or `insufficient_peers`. |  |
+| **next_rotation_at** | **Object** |  | [optional] |
+| **phase** | **String** | Current warmup lifecycle phase: `pending`, `stable`, `rotating`, `paused`, or `blocked`. |  |
+| **ramp_day** | **Integer** | How many days into the warmup ramp this mailbox has progressed. |  |
+| **today** | [**WarmupTodayTally**](WarmupTodayTally.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::WarmupRuntimeStatus.new(
+  active_conversations: null,
+  cohort_id: null,
+  cohort_size: null,
+  health: null,
+  next_rotation_at: null,
+  phase: null,
+  ramp_day: null,
+  today: null
+)
+```
+

data/docs/WarmupSettings.md

@@ -0,0 +1,44 @@
+# Norbelys::WarmupSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_adjust** | **Boolean** | Automatically adapt warmup volume and matching over time. |  |
+| **custom_templates** | [**Array<WarmupTemplate>**](WarmupTemplate.md) | Your own copy to warm — used for a share of daily openers. | [optional] |
+| **daily_max** | **Integer** | Ramp ceiling (max warmup sends per day). |  |
+| **daily_target** | **Integer** | Warmup sends targeted today. |  |
+| **enabled** | **Boolean** | Whether warmup is active for this mailbox. |  |
+| **language** | **String** | Language for stock warmup conversations: English or Spanish (default en). | [optional] |
+| **rampup_enabled** | **Boolean** | Grow the daily target over time. |  |
+| **rampup_increment** | **Integer** | Daily increase applied to the target while ramping. |  |
+| **reply_rate** | **Float** | Fraction of warmup mail replied to, from 0 to 1. |  |
+| **timezone** | **String** | IANA timezone the sending window is evaluated in. | [optional] |
+| **topics** | **Array<String>** | Optional topics woven into stock warmup openers. | [optional] |
+| **weekdays_only** | **Boolean** | Skip weekends. |  |
+| **window_from** | **String** | Window open, \"HH:MM\" in the mailbox timezone. | [optional] |
+| **window_to** | **String** | Window close, \"HH:MM\" in the mailbox timezone. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::WarmupSettings.new(
+  auto_adjust: null,
+  custom_templates: null,
+  daily_max: null,
+  daily_target: null,
+  enabled: null,
+  language: null,
+  rampup_enabled: null,
+  rampup_increment: null,
+  reply_rate: null,
+  timezone: null,
+  topics: null,
+  weekdays_only: null,
+  window_from: null,
+  window_to: null
+)
+```
+

data/docs/WarmupTemplate.md

@@ -0,0 +1,20 @@
+# Norbelys::WarmupTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | Opener body (plain text, spintax allowed, no links). |  |
+| **subject** | **String** | Opener subject. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::WarmupTemplate.new(
+  body: null,
+  subject: null
+)
+```
+

data/docs/WarmupTodayTally.md

@@ -0,0 +1,22 @@
+# Norbelys::WarmupTodayTally
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **failed** | **Integer** | Warmup sends that failed today. |  |
+| **planned** | **Integer** | Warmup sends planned for today. |  |
+| **sent** | **Integer** | Warmup sends completed today. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::WarmupTodayTally.new(
+  failed: null,
+  planned: null,
+  sent: null
+)
+```
+

data/lib/norbelys/api/analytics_api.rb

@@ -0,0 +1,97 @@
+=begin
+#Norbelys API
+
+#The **Norbelys API** is a single, predictable REST surface for cold email and outreach — people, senders, programs, and sending all live behind the five patterns below. Developer-first and AI-first: every name is either already invented (Schema.org) or obvious.  ## Authentication  Every request authenticates with an **org-scoped API key**. Create one in **Settings → API keys** and send it as a bearer token:  ```http GET https://api.norbelys.com/v1/people Authorization: Bearer ak_live_… ```  Interactive agents may instead use OAuth 2.1 (see `/auth.md` and the `/.well-known/oauth-protected-resource` metadata).  ## Conventions  - **Base URL** — `https://api.norbelys.com/v1`. - **JSON in, JSON out.** Timestamps are ISO-8601 in UTC. - **Cursor pagination.** List endpoints take `limit` + `cursor` and return   `{ data, hasMore, nextCursor }` (offset-paged tables add `page` + `total`). - **Expansions.** Detail GETs take an `expand[]` query param to inline related   data (e.g. `GET /people/{id}?expand[]=timeline`) instead of extra calls. - **Soft deletes.** Anything that has been used is archived, never hard-deleted —   `DELETE` archives the resource and returns it.  ## Errors  Failures return the same envelope on every 4xx/5xx, with the matching HTTP status:  ```json { \"error\": { \"type\": \"invalid_request\", \"code\": \"invalid_param\",             \"message\": \"…\", \"hint\": \"…\", \"doc_url\": \"…\" } } ```  `type` is a broad, machine-routable category derived from the status; `code` is the stable machine contract you branch on (never the human `message`). See the `ApiError` schema.  ## Idempotency  Every `POST` accepts an optional **`Idempotency-Key`** header. Reuse the same key to replay the original result for 24h instead of re-executing — so a retried create can never double-charge or duplicate a record.  ## Rate limits & versioning  Abuse control is enforced at the edge; responses advertise the policy via the `RateLimit-Policy` header, and a `429` carries `Retry-After`. The API is versioned in the URL path (`/v1`). Breaking changes ship under a new version; a retiring surface is announced with `Deprecation` + `Sunset` response headers at least 90 days ahead.
+
+The version of the OpenAPI document: 0.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Norbelys
+  class AnalyticsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Run an analytics query
+    # The ONE read door for all event-derived analytics — choose a named `query` from the catalog and pass its `params`; the tenant is auto-scoped (you can never read another org). Returns flat rows + a count. Covers activity feeds, message/person event traces, time-series, campaign funnels, sender & inbox-provider health, A/B performance, warmup placement, and DMARC rollups. The `query` field documents the full catalog and which params each one takes.
+    # @param analytics_query [AnalyticsQuery] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key 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.
+    # @return [AnalyticsQueryResult]
+    def analytics_query(analytics_query, opts = {})
+      data, _status_code, _headers = analytics_query_with_http_info(analytics_query, opts)
+      data
+    end
+
+    # Run an analytics query
+    # The ONE read door for all event-derived analytics — choose a named `query` from the catalog and pass its `params`; the tenant is auto-scoped (you can never read another org). Returns flat rows + a count. Covers activity feeds, message/person event traces, time-series, campaign funnels, sender & inbox-provider health, A/B performance, warmup placement, and DMARC rollups. The `query` field documents the full catalog and which params each one takes.
+    # @param analytics_query [AnalyticsQuery] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key 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.
+    # @return [Array<(AnalyticsQueryResult, Integer, Hash)>] AnalyticsQueryResult data, response status code and response headers
+    def analytics_query_with_http_info(analytics_query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_query ...'
+      end
+      # verify the required parameter 'analytics_query' is set
+      if @api_client.config.client_side_validation && analytics_query.nil?
+        fail ArgumentError, "Missing the required parameter 'analytics_query' when calling AnalyticsApi.analytics_query"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling AnalyticsApi.analytics_query, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/analytics/query'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(analytics_query)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AnalyticsQueryResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AnalyticsApi.analytics_query",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#analytics_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end