norbelys 0.1.0

data/spec/api/programs_api_spec.rb

@@ -0,0 +1,270 @@
+=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::ProgramsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ProgramsApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::ProgramsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProgramsApi' do
+    it 'should create an instance of ProgramsApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::ProgramsApi)
+    end
+  end
+
+  # unit tests for programs_archive
+  # Archive a program
+  # Soft-delete the campaign and cancel its in-flight runs. Reversible with programs.restore.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Program]
+  describe 'programs_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 programs_audience_list
+  # List a program's audience sources
+  # Where this campaign's people came from — one entry per source (segment, group, CSV import, manual), with the people count enrolled from each and whether a segment is kept in continuous sync (dynamic audience).
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [ProgramsAudienceList]
+  describe 'programs_audience_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 programs_create
+  # Create a program
+  # Create a cold-email sequence. Optionally build the WHOLE cadence in one call by passing steps[] (each with inline variants[]); the response returns the program with its steps expanded. Then attach senders, enroll people, and launch.
+  # @param program_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 [ProgramDetail]
+  describe 'programs_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 programs_enroll
+  # Enroll people into a program
+  # Add an audience as leads — the union of personIds, a groupId's members, and a segmentId's current matches (omit all to enroll every active person). Never starts sending on its own; call programs.launch to go live.
+  # @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.
+  # @option opts [EnrollProgramParams] :enroll_program_params 
+  # @return [EnrollProgramResult]
+  describe 'programs_enroll 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 programs_enrollments_find
+  # Get an enrollment
+  # @param program_id 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Enrollment]
+  describe 'programs_enrollments_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 programs_enrollments_list
+  # List a program's leads
+  # The people enrolled in the program and where each sits in the cadence, with per-status counts for the Leads view.
+  # @param program_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Boolean] :include_archived 
+  # @option opts [Integer] :limit 
+  # @option opts [String] :dir 
+  # @option opts [Integer] :page 
+  # @option opts [String] :q 
+  # @option opts [String] :sort 
+  # @option opts [Array<String>] :status 
+  # @return [EnrollmentList]
+  describe 'programs_enrollments_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 programs_find
+  # Get a program
+  # Read one program. Pass expand[]&#x3D;steps to inline the cadence (each step with its arms) and expand[]&#x3D;senders for the attached mailboxes.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :expand 
+  # @return [ProgramDetail]
+  describe 'programs_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 programs_launch
+  # Launch a program
+  # The go-live gate — the only path a draft becomes active. Requires at least one live sender, one step, and one enrolled lead. Returns any non-blocking compliance warnings.
+  # @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.
+  # @option opts [LaunchProgramParams] :launch_program_params 
+  # @return [LaunchProgramResult]
+  describe 'programs_launch 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 programs_list
+  # List programs
+  # List the org&#39;s campaigns (cold-email sequences), newest first, with per-campaign stats (leads, completion, next send).
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Boolean] :include_archived 
+  # @option opts [Integer] :limit 
+  # @option opts [String] :dir 
+  # @option opts [Integer] :page 
+  # @option opts [Boolean] :archived 
+  # @option opts [String] :q 
+  # @option opts [String] :sender_id 
+  # @option opts [String] :sort 
+  # @option opts [Array<String>] :status 
+  # @return [ProgramList]
+  describe 'programs_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 programs_pause
+  # Pause a program&#39;s sending
+  # Stop sending; messages already queued still complete. Resume with programs.resume.
+  # @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 [Program]
+  describe 'programs_pause 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 programs_restore
+  # Restore an archived program
+  # Un-archive the campaign and revive the runs the archive cancelled, resuming what&#39;s left of the cadence.
+  # @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 [Program]
+  describe 'programs_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 programs_resume
+  # Resume a paused program
+  # Resume sending from where it stopped — each lead keeps its place in the cadence.
+  # @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 [Program]
+  describe 'programs_resume 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 programs_senders_add
+  # Attach a sender to a program
+  # Assign a mailbox the program can send from (a program needs at least one to launch).
+  # @param id 
+  # @param add_program_sender_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 [ProgramSenderRef]
+  describe 'programs_senders_add 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 programs_senders_list
+  # List a program&#39;s senders
+  # The mailboxes assigned to this program, each with its pending queue in the program.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [ProgramsSendersList]
+  describe 'programs_senders_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 programs_senders_remove
+  # Detach a sender from a program
+  # Unassign a mailbox. A running campaign refuses to drop its last live sender — pause it first.
+  # @param id 
+  # @param rel_id 
+  # @param [Hash] opts the optional parameters
+  # @return [DetachResult]
+  describe 'programs_senders_remove 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 programs_share
+  # Share the campaign report
+  # Mint a public, read-only link to this campaign&#39;s report (send it to a client — no account needed). The link is signed and expires after 30 days; archiving the campaign 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 [CampaignReportShare]
+  describe 'programs_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 programs_update
+  # Update a program
+  # Patch program settings and/or edit the cadence in one call. steps[] is a sparse upsert: an item WITH id edits that step, WITHOUT id creates one, archived:true removes it — same for each step&#39;s variants[]. Returns the program with its steps expanded.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [ProgramUpdateParams] :program_update_params 
+  # @return [ProgramDetail]
+  describe 'programs_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/segments_api_spec.rb

@@ -0,0 +1,100 @@
+=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::SegmentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SegmentsApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::SegmentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SegmentsApi' do
+    it 'should create an instance of SegmentsApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::SegmentsApi)
+    end
+  end
+
+  # unit tests for segments_archive
+  # Delete a segment
+  # Permanently delete the segment and detach it from any program that used it as an audience source. The people it matched are unaffected.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Segment]
+  describe 'segments_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 segments_create
+  # Create a segment
+  # Create a segment: a named, saved audience filter (the rule tree in `definition`). Membership is computed live, so it auto-refreshes as people change. Preview the people it matches at GET /v1/people?segmentId={id}.
+  # @param segment_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 [Segment]
+  describe 'segments_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 segments_find
+  # Get a segment
+  # Read one segment, including its saved filter definition. List the people it currently matches at GET /v1/people?segmentId={id}.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Segment]
+  describe 'segments_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 segments_list
+  # List segments
+  # List the org's segments — dynamic saved filters over people — newest first.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Boolean] :include_archived 
+  # @option opts [Integer] :limit 
+  # @option opts [String] :q 
+  # @return [SegmentList]
+  describe 'segments_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 segments_update
+  # Update a segment
+  # Rename a segment or replace its filter definition. Because membership is computed live, changing the definition immediately changes who the segment matches.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [SegmentUpdateParams] :segment_update_params 
+  # @return [Segment]
+  describe 'segments_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/senders_api_spec.rb

@@ -0,0 +1,130 @@
+=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::SendersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SendersApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::SendersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SendersApi' do
+    it 'should create an instance of SendersApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::SendersApi)
+    end
+  end
+
+  # unit tests for senders_bulk
+  # Bulk-update senders
+  # Apply ONE patch to MANY mailboxes at once, in a single call: pacing (dailyLimit, minGapMinutes), lifecycle (pause/resume via state), warmup, or operator labels. Use this whenever the same change goes to several senders (e.g. 'set every sender to 50/day', 'pause all senders') INSTEAD of calling update once per mailbox. It cannot change credentials or transport, so it never sends a verification email. Returns how many updated plus any per-mailbox errors. Note: a mailbox has NO per-mailbox clock-time send window for campaigns — the daily sending window and timezone belong to the CAMPAIGN (program), so 'make each sender send at a different hour' means splitting senders across campaigns with different windows, not a sender edit.
+  # @param bulk_update_senders_input 
+  # @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 [BulkUpdateSendersResult]
+  describe 'senders_bulk 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 senders_create
+  # Connect a sender
+  # Connect a mailbox from its SMTP/IMAP (or managed-provider) credentials. The save auto-verifies by sending a real test email from the mailbox and is rejected if it cannot send — connecting is verifying, so there is no separate verify or test step. Omit sendingDomainId to get-or-create the sending domain from the fromEmail host.
+  # @param create_sender_input 
+  # @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 [Sender]
+  describe 'senders_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 senders_find
+  # Get a sender
+  # Return one mailbox. Use `expand[]=usage` to inline its send/receive/campaign history counts (the preview that drives delete-vs-archive) and `expand[]=warmup` for the warmup config plus today's slot tally.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :expand 
+  # @return [SenderDetail]
+  describe 'senders_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 senders_list
+  # List senders
+  # List the mailboxes (senders) on this workspace. Filter by &#x60;search&#x60; (matches fromName, fromEmail and clientLabel), &#x60;state[]&#x60;, &#x60;reputation[]&#x60;, or &#x60;sendingDomainId&#x60;; the page carries &#x60;total&#x60; for page / totalPages.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Boolean] :include_archived 
+  # @option opts [Integer] :limit 
+  # @option opts [Array<String>] :reputation 
+  # @option opts [String] :search 
+  # @option opts [String] :sending_domain_id 
+  # @option opts [Array<String>] :state 
+  # @return [SenderList]
+  describe 'senders_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 senders_remove
+  # Delete or archive a sender
+  # The smart delete: a mailbox with no history is hard-deleted, one with sends, replies, or campaigns is soft-archived instead — the response&#39;s outcome says which happened. Archived mailboxes can be restored.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [SenderRemoveResult]
+  describe 'senders_remove 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 senders_restore
+  # Restore an archived sender
+  # Un-archive a mailbox (clears its soft-delete). Connecting is verifying — a restored OAuth mailbox may need to reconnect before it can send again.
+  # @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 [Sender]
+  describe 'senders_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 senders_update
+  # Update a sender
+  # Edit a mailbox. Changing the transport or credentials re-verifies by sending a real test email and is rejected if it cannot send. Set state to pause or resume sending, warmup to tune the warmup engine (or null to disable it), or archivedAt to null to restore an archived mailbox.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [UpdateSenderInput] :update_sender_input 
+  # @return [Sender]
+  describe 'senders_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/suppressions_api_spec.rb

@@ -0,0 +1,98 @@
+=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::SuppressionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SuppressionsApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::SuppressionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SuppressionsApi' do
+    it 'should create an instance of SuppressionsApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::SuppressionsApi)
+    end
+  end
+
+  # unit tests for suppressions_archive
+  # Delete a suppression
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Suppression]
+  describe 'suppressions_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 suppressions_bulk
+  # 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.
+  # @param suppression_bulk_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 [SuppressionBulkResult]
+  describe 'suppressions_bulk 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 suppressions_create
+  # 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.
+  # @param suppression_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 [Suppression]
+  describe 'suppressions_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 suppressions_find
+  # Get a suppression
+  # Read one suppression entry by id.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [Suppression]
+  describe 'suppressions_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 suppressions_list
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Boolean] :include_archived 
+  # @option opts [Integer] :limit 
+  # @return [SuppressionList]
+  describe 'suppressions_list 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/verify_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::VerifyApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'VerifyApi' do
+  before do
+    # run before each test
+    @api_instance = Norbelys::VerifyApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VerifyApi' do
+    it 'should create an instance of VerifyApi' do
+      expect(@api_instance).to be_instance_of(Norbelys::VerifyApi)
+    end
+  end
+
+  # unit tests for verify_email
+  # 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.
+  # @param verify_email_input 
+  # @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 [VerifyResult]
+  describe 'verify_email test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end