norbelys 0.1.0

data/lib/norbelys.rb

@@ -0,0 +1,243 @@
+=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
+
+# Common files
+require 'norbelys/api_client'
+require 'norbelys/api_error'
+require 'norbelys/version'
+require 'norbelys/configuration'
+
+# Models
+require 'norbelys/models/add_program_sender_params'
+require 'norbelys/models/ai_email_variant_content'
+require 'norbelys/models/analytics_query'
+require 'norbelys/models/analytics_query_name'
+require 'norbelys/models/analytics_query_params'
+require 'norbelys/models/analytics_query_result'
+require 'norbelys/models/api_error'
+require 'norbelys/models/api_error_detail'
+require 'norbelys/models/audience_activity_action'
+require 'norbelys/models/audience_activity_condition'
+require 'norbelys/models/audience_activity_link_filter'
+require 'norbelys/models/audience_activity_link_match_op'
+require 'norbelys/models/audience_activity_params'
+require 'norbelys/models/audience_attribute_condition'
+require 'norbelys/models/audience_condition_op'
+require 'norbelys/models/audience_condition_value'
+require 'norbelys/models/audience_filter'
+require 'norbelys/models/audience_match'
+require 'norbelys/models/audience_rule'
+require 'norbelys/models/audience_source'
+require 'norbelys/models/audience_status_breakdown'
+require 'norbelys/models/audience_summary'
+require 'norbelys/models/audience_week_point'
+require 'norbelys/models/bulk_update_sender_patch'
+require 'norbelys/models/bulk_update_senders_input'
+require 'norbelys/models/bulk_update_senders_result'
+require 'norbelys/models/campaign_report_share'
+require 'norbelys/models/collection_address'
+require 'norbelys/models/connection_settings'
+require 'norbelys/models/create_sender_input'
+require 'norbelys/models/detach_result'
+require 'norbelys/models/dmarc_record_to_publish'
+require 'norbelys/models/domain'
+require 'norbelys/models/domain_age'
+require 'norbelys/models/domain_capacity'
+require 'norbelys/models/domain_create_params'
+require 'norbelys/models/domain_detail'
+require 'norbelys/models/domain_health'
+require 'norbelys/models/domain_list'
+require 'norbelys/models/domain_monitoring'
+require 'norbelys/models/domain_monitoring_params'
+require 'norbelys/models/domain_sending'
+require 'norbelys/models/domain_sending_policy'
+require 'norbelys/models/domain_sending_policy_params'
+require 'norbelys/models/domain_sending_update_params'
+require 'norbelys/models/domain_tracking'
+require 'norbelys/models/domain_tracking_params'
+require 'norbelys/models/domain_tracking_update_params'
+require 'norbelys/models/domain_update_params'
+require 'norbelys/models/email_variant_content'
+require 'norbelys/models/enroll_program_params'
+require 'norbelys/models/enroll_program_result'
+require 'norbelys/models/enrollment'
+require 'norbelys/models/enrollment_counts'
+require 'norbelys/models/enrollment_list'
+require 'norbelys/models/enrollment_person_ref'
+require 'norbelys/models/enrollment_program_ref'
+require 'norbelys/models/features'
+require 'norbelys/models/field'
+require 'norbelys/models/field_create_params'
+require 'norbelys/models/field_list'
+require 'norbelys/models/field_type'
+require 'norbelys/models/field_update_params'
+require 'norbelys/models/file_object'
+require 'norbelys/models/file_upload'
+require 'norbelys/models/group'
+require 'norbelys/models/group_add_members_params'
+require 'norbelys/models/group_add_members_result'
+require 'norbelys/models/group_create_params'
+require 'norbelys/models/group_list'
+require 'norbelys/models/group_update_params'
+require 'norbelys/models/imap_connection_update'
+require 'norbelys/models/inbound_message'
+require 'norbelys/models/integration'
+require 'norbelys/models/integration_config'
+require 'norbelys/models/integration_connect_params'
+require 'norbelys/models/integration_connect_result'
+require 'norbelys/models/integration_list'
+require 'norbelys/models/integration_notify_config'
+require 'norbelys/models/integration_options'
+require 'norbelys/models/integration_provider'
+require 'norbelys/models/integration_status'
+require 'norbelys/models/integration_sync_result'
+require 'norbelys/models/integration_update_params'
+require 'norbelys/models/launch_program_params'
+require 'norbelys/models/launch_program_result'
+require 'norbelys/models/message'
+require 'norbelys/models/message_address'
+require 'norbelys/models/message_attachment'
+require 'norbelys/models/message_attachment_download'
+require 'norbelys/models/message_attachment_input'
+require 'norbelys/models/message_attachment_list'
+require 'norbelys/models/message_create_params'
+require 'norbelys/models/message_enroll_params'
+require 'norbelys/models/message_list'
+require 'norbelys/models/message_reply_params'
+require 'norbelys/models/message_source'
+require 'norbelys/models/message_source_attachment'
+require 'norbelys/models/message_test_params'
+require 'norbelys/models/message_update_params'
+require 'norbelys/models/monthly_email_usage_meter'
+require 'norbelys/models/organization'
+require 'norbelys/models/organization_alerts'
+require 'norbelys/models/organization_alerts_params'
+require 'norbelys/models/organization_bounce_policy'
+require 'norbelys/models/organization_bounce_policy_params'
+require 'norbelys/models/organization_onboarding'
+require 'norbelys/models/organization_profile'
+require 'norbelys/models/organization_profile_params'
+require 'norbelys/models/organization_pulse'
+require 'norbelys/models/organization_update_params'
+require 'norbelys/models/organization_usage'
+require 'norbelys/models/outbound_message'
+require 'norbelys/models/people_bulk_create_params'
+require 'norbelys/models/people_bulk_create_result'
+require 'norbelys/models/person'
+require 'norbelys/models/person_create_params'
+require 'norbelys/models/person_detail'
+require 'norbelys/models/person_erased'
+require 'norbelys/models/person_group_ref'
+require 'norbelys/models/person_import_item'
+require 'norbelys/models/person_import_reason'
+require 'norbelys/models/person_import_stats'
+require 'norbelys/models/person_list'
+require 'norbelys/models/person_list_item'
+require 'norbelys/models/person_segment_ref'
+require 'norbelys/models/person_update_params'
+require 'norbelys/models/program'
+require 'norbelys/models/program_create_params'
+require 'norbelys/models/program_detail'
+require 'norbelys/models/program_list'
+require 'norbelys/models/program_list_item'
+require 'norbelys/models/program_pause_meta'
+require 'norbelys/models/program_sender_ref'
+require 'norbelys/models/program_stats'
+require 'norbelys/models/program_step_input'
+require 'norbelys/models/program_update_params'
+require 'norbelys/models/program_variant_input'
+require 'norbelys/models/programs_audience_list'
+require 'norbelys/models/programs_senders_list'
+require 'norbelys/models/provider_api_sender_input'
+require 'norbelys/models/pulse_deliverability'
+require 'norbelys/models/pulse_program'
+require 'norbelys/models/pulse_sender_fleet'
+require 'norbelys/models/pulse_value'
+require 'norbelys/models/report_share'
+require 'norbelys/models/segment'
+require 'norbelys/models/segment_create_params'
+require 'norbelys/models/segment_list'
+require 'norbelys/models/segment_update_params'
+require 'norbelys/models/self_hosted_sender_input'
+require 'norbelys/models/sender'
+require 'norbelys/models/sender_bulk_error'
+require 'norbelys/models/sender_detail'
+require 'norbelys/models/sender_list'
+require 'norbelys/models/sender_remove_result'
+require 'norbelys/models/sender_usage'
+require 'norbelys/models/sender_warmup_status'
+require 'norbelys/models/slack_channel'
+require 'norbelys/models/smtp_connection_settings'
+require 'norbelys/models/smtp_connection_update'
+require 'norbelys/models/smtp_sender_input'
+require 'norbelys/models/static_email_variant_content'
+require 'norbelys/models/step_with_variants'
+require 'norbelys/models/suppression'
+require 'norbelys/models/suppression_bulk_params'
+require 'norbelys/models/suppression_bulk_result'
+require 'norbelys/models/suppression_create_params'
+require 'norbelys/models/suppression_list'
+require 'norbelys/models/suppression_scope'
+require 'norbelys/models/sync_model'
+require 'norbelys/models/team_size'
+require 'norbelys/models/tracking_dns_record'
+require 'norbelys/models/update_sender_input'
+require 'norbelys/models/usage_meter'
+require 'norbelys/models/usage_plan'
+require 'norbelys/models/variant'
+require 'norbelys/models/variant_ai'
+require 'norbelys/models/verify_email_input'
+require 'norbelys/models/verify_mx'
+require 'norbelys/models/verify_reachability'
+require 'norbelys/models/verify_reason_code'
+require 'norbelys/models/verify_result'
+require 'norbelys/models/verify_signals'
+require 'norbelys/models/verify_syntax'
+require 'norbelys/models/voice_sender_input'
+require 'norbelys/models/warmup_runtime_status'
+require 'norbelys/models/warmup_settings'
+require 'norbelys/models/warmup_template'
+require 'norbelys/models/warmup_today_tally'
+
+# APIs
+require 'norbelys/api/analytics_api'
+require 'norbelys/api/domains_api'
+require 'norbelys/api/fields_api'
+require 'norbelys/api/files_api'
+require 'norbelys/api/groups_api'
+require 'norbelys/api/integrations_api'
+require 'norbelys/api/messages_api'
+require 'norbelys/api/organization_api'
+require 'norbelys/api/people_api'
+require 'norbelys/api/programs_api'
+require 'norbelys/api/segments_api'
+require 'norbelys/api/senders_api'
+require 'norbelys/api/suppressions_api'
+require 'norbelys/api/verify_api'
+
+module Norbelys
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Norbelys.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/norbelys.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "norbelys/version"
+
+Gem::Specification.new do |s|
+  s.name        = "norbelys"
+  s.version     = Norbelys::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = [""]
+  s.homepage    = "https://norbelys.com"
+  s.summary     = "Norbelys API Ruby Gem"
+  s.description = "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."
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/analytics_api_spec.rb

@@ -0,0 +1,48 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Norbelys::AnalyticsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AnalyticsApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::AnalyticsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AnalyticsApi' do
+    it 'should create an instance of AnalyticsApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::AnalyticsApi)
+    end
+  end
+
+  # unit tests for analytics_query
+  # 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 
+  # @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]
+  describe 'analytics_query test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/domains_api_spec.rb

@@ -0,0 +1,128 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Norbelys::DomainsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DomainsApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::DomainsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DomainsApi' do
+    it 'should create an instance of DomainsApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::DomainsApi)
+    end
+  end
+
+  # unit tests for domains_archive
+  # Archive a domain
+  # Soft-archive a domain (it is versioned, never hard-deleted). Archiving a monitoring domain also revokes its collection addresses, so DMARC report ingestion stops with it; restore re-enables them.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Domain]
+  describe 'domains_archive test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for domains_create
+  # Create a domain
+  # Provision a domain by capability. A `sending` domain registers a cold/SMTP mailbox domain (normally born automatically when you connect a mailbox); a `monitoring` domain starts DMARC monitoring and auto-mints its first collection address (read it back with find?expand[]=collectionAddresses). The common manual use is adding an external monitor-only domain.
+  # @param domain_create_params 
+  # @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 [Domain]
+  describe 'domains_create test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for domains_find
+  # Get a domain
+  # Read one domain (a monitoring domain reports its DMARC collection readiness on read). Pass expand[]=collectionAddresses to inline the rua addresses reports are sent to.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :expand 
+  # @return [DomainDetail]
+  describe 'domains_find test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for domains_list
+  # List domains
+  # List your domains — both sending domains and DMARC-monitoring domains. Filter by capability, or pass programId to scope to the sending domains a campaign sends from (adds senderCount).
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Boolean] :include_archived 
+  # @option opts [Integer] :limit 
+  # @option opts [String] :capability 
+  # @option opts [String] :program_id 
+  # @return [DomainList]
+  describe 'domains_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for domains_restore
+  # Restore an archived domain
+  # Un-archive a domain. A monitoring domain also resumes DMARC report collection (its collection addresses are re-enabled).
+  # @param id 
+  # @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 [Domain]
+  describe 'domains_restore test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for domains_share
+  # Share the DMARC report
+  # Mint a public, read-only link to this monitoring domain&#39;s DMARC report (send it to a client — no account needed). The link is signed and expires after 30 days; archiving the domain kills it immediately. Mint again for a fresh link.
+  # @param id 
+  # @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 [ReportShare]
+  describe 'domains_share test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for domains_update
+  # Update a domain
+  # Update customer-owned settings on a sending or tracking domain. Operational DNS, TLS, health, recommendation, and capacity fields are read-only. The required version provides optimistic concurrency.
+  # @param id 
+  # @param domain_update_params 
+  # @param [Hash] opts the optional parameters
+  # @return [Domain]
+  describe 'domains_update test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/fields_api_spec.rb

@@ -0,0 +1,85 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Norbelys::FieldsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FieldsApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::FieldsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FieldsApi' do
+    it 'should create an instance of FieldsApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::FieldsApi)
+    end
+  end
+
+  # unit tests for fields_archive
+  # Delete a field
+  # Soft-delete a custom field so it stops appearing in the UI, the merge-tag catalog, and segment filters. The values already stored under its `code` on each person are kept, so the field can be restored without data loss.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Field]
+  describe 'fields_archive test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for fields_create
+  # Create a custom field
+  # Create a custom person-field. Its `code` becomes the `{{ code }}` merge tag used in templates and the key it is filtered by in segments; omit `code` to auto-derive a slug from the label. A `dropdown` field must also supply its `options`.
+  # @param field_create_params 
+  # @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 [Field]
+  describe 'fields_create test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for fields_list
+  # List custom fields
+  # List all of the org's custom person-fields, in display order. The entire set is returned in one response — there is no pagination, because the set is small. System fields (email, telephone, first/last name) are not included here; only tenant-created custom fields.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :include_archived 
+  # @return [FieldList]
+  describe 'fields_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for fields_update
+  # Update a field
+  # Update a field's label, type, options, or filterability. The `code` is immutable after create — live templates and segments reference it — so it cannot be changed here.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [FieldUpdateParams] :field_update_params 
+  # @return [Field]
+  describe 'fields_update test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/files_api_spec.rb

@@ -0,0 +1,48 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Norbelys::FilesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FilesApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::FilesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FilesApi' do
+    it 'should create an instance of FilesApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::FilesApi)
+    end
+  end
+
+  # unit tests for files_create
+  # Upload a public file
+  # Upload one image or PDF (Base64, max 8 MB decoded) to the public files bucket. Returns the permanent public URL — embed it in email HTML (signature images, campaign bodies, linked PDFs). The URL contains an unguessable id, is never listed, and is served with no search indexing.
+  # @param file_upload 
+  # @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 [FileObject]
+  describe 'files_create test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end