norbelys 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6a423f76ac9b8662e56b7bb0c20b551baafbcc799773dc9912017f43447b147
+  data.tar.gz: 85c295335ca269db61a88c2a5808209ef1ac84ec5684629a4f0318522e875384
+SHA512:
+  metadata.gz: 6007594d3f2ee155dd9a6c9f1e936fa95fe27b4e2b13178ca689bdf9f1c81c25d0658e6c35268223477c216102f48c14d2ac6017cb67738609f3b14958f3f48e
+  data.tar.gz: 4bcd68f2cae84e10420fcca00d79336fd821e348f8ab46550116b352ae75278985cc8feaa5c976dd5b169cf8ef7f259cc5fd362c9d610fbd09e5465662205d78

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,429 @@
+# norbelys
+
+Norbelys - the Ruby gem for the 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.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.0.1
+- Package version: 0.1.0
+- Generator version: 7.10.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build norbelys.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./norbelys-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./norbelys-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'norbelys', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/norbelys-com/sdk-ruby, then add the following in the Gemfile:
+
+    gem 'norbelys', :git => 'https://github.com/norbelys-com/sdk-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'norbelys'
+
+# Setup authorization
+Norbelys.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+end
+
+api_instance = Norbelys::AnalyticsApi.new
+analytics_query = Norbelys::AnalyticsQuery.new({query: Norbelys::AnalyticsQueryName::ACTIVITY_FEED}) # AnalyticsQuery | 
+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
+  #Run an analytics query
+  result = api_instance.analytics_query(analytics_query, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Exception when calling AnalyticsApi->analytics_query: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Norbelys::AnalyticsApi* | [**analytics_query**](docs/AnalyticsApi.md#analytics_query) | **POST** /analytics/query | Run an analytics query
+*Norbelys::DomainsApi* | [**domains_archive**](docs/DomainsApi.md#domains_archive) | **DELETE** /domains/{id} | Archive a domain
+*Norbelys::DomainsApi* | [**domains_create**](docs/DomainsApi.md#domains_create) | **POST** /domains | Create a domain
+*Norbelys::DomainsApi* | [**domains_find**](docs/DomainsApi.md#domains_find) | **GET** /domains/{id} | Get a domain
+*Norbelys::DomainsApi* | [**domains_list**](docs/DomainsApi.md#domains_list) | **GET** /domains | List domains
+*Norbelys::DomainsApi* | [**domains_restore**](docs/DomainsApi.md#domains_restore) | **POST** /domains/{id}/restore | Restore an archived domain
+*Norbelys::DomainsApi* | [**domains_share**](docs/DomainsApi.md#domains_share) | **POST** /domains/{id}/share | Share the DMARC report
+*Norbelys::DomainsApi* | [**domains_update**](docs/DomainsApi.md#domains_update) | **PATCH** /domains/{id} | Update a domain
+*Norbelys::FieldsApi* | [**fields_archive**](docs/FieldsApi.md#fields_archive) | **DELETE** /fields/{id} | Delete a field
+*Norbelys::FieldsApi* | [**fields_create**](docs/FieldsApi.md#fields_create) | **POST** /fields | Create a custom field
+*Norbelys::FieldsApi* | [**fields_list**](docs/FieldsApi.md#fields_list) | **GET** /fields | List custom fields
+*Norbelys::FieldsApi* | [**fields_update**](docs/FieldsApi.md#fields_update) | **PATCH** /fields/{id} | Update a field
+*Norbelys::FilesApi* | [**files_create**](docs/FilesApi.md#files_create) | **POST** /files | Upload a public file
+*Norbelys::GroupsApi* | [**groups_archive**](docs/GroupsApi.md#groups_archive) | **DELETE** /groups/{id} | Delete a group
+*Norbelys::GroupsApi* | [**groups_create**](docs/GroupsApi.md#groups_create) | **POST** /groups | Create a group
+*Norbelys::GroupsApi* | [**groups_find**](docs/GroupsApi.md#groups_find) | **GET** /groups/{id} | Get a group
+*Norbelys::GroupsApi* | [**groups_list**](docs/GroupsApi.md#groups_list) | **GET** /groups | List groups
+*Norbelys::GroupsApi* | [**groups_members_add**](docs/GroupsApi.md#groups_members_add) | **POST** /groups/{id}/members | Add people to a group
+*Norbelys::GroupsApi* | [**groups_members_remove**](docs/GroupsApi.md#groups_members_remove) | **DELETE** /groups/{id}/members/{relId} | Remove a person from a group
+*Norbelys::GroupsApi* | [**groups_update**](docs/GroupsApi.md#groups_update) | **PATCH** /groups/{id} | Update a group
+*Norbelys::IntegrationsApi* | [**integrations_connect**](docs/IntegrationsApi.md#integrations_connect) | **POST** /integrations/connect | Connect an integration
+*Norbelys::IntegrationsApi* | [**integrations_find**](docs/IntegrationsApi.md#integrations_find) | **GET** /integrations/{id} | Get an integration
+*Norbelys::IntegrationsApi* | [**integrations_list**](docs/IntegrationsApi.md#integrations_list) | **GET** /integrations | List integrations
+*Norbelys::IntegrationsApi* | [**integrations_options**](docs/IntegrationsApi.md#integrations_options) | **GET** /integrations/{id}/options | List an integration's config options
+*Norbelys::IntegrationsApi* | [**integrations_remove**](docs/IntegrationsApi.md#integrations_remove) | **DELETE** /integrations/{id} | Disconnect an integration
+*Norbelys::IntegrationsApi* | [**integrations_sync**](docs/IntegrationsApi.md#integrations_sync) | **POST** /integrations/{id}/sync | Sync an integration now
+*Norbelys::IntegrationsApi* | [**integrations_update**](docs/IntegrationsApi.md#integrations_update) | **PATCH** /integrations/{id} | Update an integration
+*Norbelys::MessagesApi* | [**messages_attachment**](docs/MessagesApi.md#messages_attachment) | **GET** /messages/{id}/attachments/{attachmentId} | Download a message attachment
+*Norbelys::MessagesApi* | [**messages_attachments**](docs/MessagesApi.md#messages_attachments) | **GET** /messages/{id}/attachments | List a message's attachments
+*Norbelys::MessagesApi* | [**messages_create**](docs/MessagesApi.md#messages_create) | **POST** /messages | Send a message
+*Norbelys::MessagesApi* | [**messages_find**](docs/MessagesApi.md#messages_find) | **GET** /messages/{id} | Get a message
+*Norbelys::MessagesApi* | [**messages_list**](docs/MessagesApi.md#messages_list) | **GET** /messages | List messages
+*Norbelys::MessagesApi* | [**messages_source**](docs/MessagesApi.md#messages_source) | **GET** /messages/{id}/source | Get a sent message's source
+*Norbelys::MessagesApi* | [**messages_update**](docs/MessagesApi.md#messages_update) | **PATCH** /messages/{id} | Triage an inbound message
+*Norbelys::OrganizationApi* | [**organization_features**](docs/OrganizationApi.md#organization_features) | **GET** /organization/features | Get the organization's feature flags
+*Norbelys::OrganizationApi* | [**organization_find**](docs/OrganizationApi.md#organization_find) | **GET** /organization | Get the organization
+*Norbelys::OrganizationApi* | [**organization_pulse**](docs/OrganizationApi.md#organization_pulse) | **GET** /organization/pulse | Get the workspace pulse
+*Norbelys::OrganizationApi* | [**organization_update**](docs/OrganizationApi.md#organization_update) | **PATCH** /organization | Update the organization
+*Norbelys::OrganizationApi* | [**organization_usage**](docs/OrganizationApi.md#organization_usage) | **GET** /organization/usage | Get the organization's plan usage
+*Norbelys::PeopleApi* | [**people_archive**](docs/PeopleApi.md#people_archive) | **DELETE** /people/{id} | Archive a person
+*Norbelys::PeopleApi* | [**people_audience_summary**](docs/PeopleApi.md#people_audience_summary) | **GET** /people/audience-summary | Get audience summary
+*Norbelys::PeopleApi* | [**people_bulk_create**](docs/PeopleApi.md#people_bulk_create) | **POST** /people/bulk | Bulk create people (verifies + suppresses in the background; optional group / campaign)
+*Norbelys::PeopleApi* | [**people_create**](docs/PeopleApi.md#people_create) | **POST** /people | Create a person
+*Norbelys::PeopleApi* | [**people_erase**](docs/PeopleApi.md#people_erase) | **POST** /people/{id}/erase | Erase a person (GDPR)
+*Norbelys::PeopleApi* | [**people_find**](docs/PeopleApi.md#people_find) | **GET** /people/{id} | Get a person
+*Norbelys::PeopleApi* | [**people_get_bulk**](docs/PeopleApi.md#people_get_bulk) | **GET** /people/bulk/{id} | Get a bulk import's verify stats (sendable / suppressed / pending)
+*Norbelys::PeopleApi* | [**people_list**](docs/PeopleApi.md#people_list) | **GET** /people | List people
+*Norbelys::PeopleApi* | [**people_update**](docs/PeopleApi.md#people_update) | **PATCH** /people/{id} | Update a person
+*Norbelys::ProgramsApi* | [**programs_archive**](docs/ProgramsApi.md#programs_archive) | **DELETE** /programs/{id} | Archive a program
+*Norbelys::ProgramsApi* | [**programs_audience_list**](docs/ProgramsApi.md#programs_audience_list) | **GET** /programs/{id}/audience | List a program's audience sources
+*Norbelys::ProgramsApi* | [**programs_create**](docs/ProgramsApi.md#programs_create) | **POST** /programs | Create a program
+*Norbelys::ProgramsApi* | [**programs_enroll**](docs/ProgramsApi.md#programs_enroll) | **POST** /programs/{id}/enroll | Enroll people into a program
+*Norbelys::ProgramsApi* | [**programs_enrollments_find**](docs/ProgramsApi.md#programs_enrollments_find) | **GET** /programs/{programId}/enrollments/{id} | Get an enrollment
+*Norbelys::ProgramsApi* | [**programs_enrollments_list**](docs/ProgramsApi.md#programs_enrollments_list) | **GET** /programs/{programId}/enrollments | List a program's leads
+*Norbelys::ProgramsApi* | [**programs_find**](docs/ProgramsApi.md#programs_find) | **GET** /programs/{id} | Get a program
+*Norbelys::ProgramsApi* | [**programs_launch**](docs/ProgramsApi.md#programs_launch) | **POST** /programs/{id}/launch | Launch a program
+*Norbelys::ProgramsApi* | [**programs_list**](docs/ProgramsApi.md#programs_list) | **GET** /programs | List programs
+*Norbelys::ProgramsApi* | [**programs_pause**](docs/ProgramsApi.md#programs_pause) | **POST** /programs/{id}/pause | Pause a program's sending
+*Norbelys::ProgramsApi* | [**programs_restore**](docs/ProgramsApi.md#programs_restore) | **POST** /programs/{id}/restore | Restore an archived program
+*Norbelys::ProgramsApi* | [**programs_resume**](docs/ProgramsApi.md#programs_resume) | **POST** /programs/{id}/resume | Resume a paused program
+*Norbelys::ProgramsApi* | [**programs_senders_add**](docs/ProgramsApi.md#programs_senders_add) | **POST** /programs/{id}/senders | Attach a sender to a program
+*Norbelys::ProgramsApi* | [**programs_senders_list**](docs/ProgramsApi.md#programs_senders_list) | **GET** /programs/{id}/senders | List a program's senders
+*Norbelys::ProgramsApi* | [**programs_senders_remove**](docs/ProgramsApi.md#programs_senders_remove) | **DELETE** /programs/{id}/senders/{relId} | Detach a sender from a program
+*Norbelys::ProgramsApi* | [**programs_share**](docs/ProgramsApi.md#programs_share) | **POST** /programs/{id}/share | Share the campaign report
+*Norbelys::ProgramsApi* | [**programs_update**](docs/ProgramsApi.md#programs_update) | **PATCH** /programs/{id} | Update a program
+*Norbelys::SegmentsApi* | [**segments_archive**](docs/SegmentsApi.md#segments_archive) | **DELETE** /segments/{id} | Delete a segment
+*Norbelys::SegmentsApi* | [**segments_create**](docs/SegmentsApi.md#segments_create) | **POST** /segments | Create a segment
+*Norbelys::SegmentsApi* | [**segments_find**](docs/SegmentsApi.md#segments_find) | **GET** /segments/{id} | Get a segment
+*Norbelys::SegmentsApi* | [**segments_list**](docs/SegmentsApi.md#segments_list) | **GET** /segments | List segments
+*Norbelys::SegmentsApi* | [**segments_update**](docs/SegmentsApi.md#segments_update) | **PATCH** /segments/{id} | Update a segment
+*Norbelys::SendersApi* | [**senders_bulk**](docs/SendersApi.md#senders_bulk) | **POST** /senders/bulk | Bulk-update senders
+*Norbelys::SendersApi* | [**senders_create**](docs/SendersApi.md#senders_create) | **POST** /senders | Connect a sender
+*Norbelys::SendersApi* | [**senders_find**](docs/SendersApi.md#senders_find) | **GET** /senders/{id} | Get a sender
+*Norbelys::SendersApi* | [**senders_list**](docs/SendersApi.md#senders_list) | **GET** /senders | List senders
+*Norbelys::SendersApi* | [**senders_remove**](docs/SendersApi.md#senders_remove) | **DELETE** /senders/{id} | Delete or archive a sender
+*Norbelys::SendersApi* | [**senders_restore**](docs/SendersApi.md#senders_restore) | **POST** /senders/{id}/restore | Restore an archived sender
+*Norbelys::SendersApi* | [**senders_update**](docs/SendersApi.md#senders_update) | **PATCH** /senders/{id} | Update a sender
+*Norbelys::SuppressionsApi* | [**suppressions_archive**](docs/SuppressionsApi.md#suppressions_archive) | **DELETE** /suppressions/{id} | Delete a suppression
+*Norbelys::SuppressionsApi* | [**suppressions_bulk**](docs/SuppressionsApi.md#suppressions_bulk) | **POST** /suppressions/bulk | Bulk-suppress addresses
+*Norbelys::SuppressionsApi* | [**suppressions_create**](docs/SuppressionsApi.md#suppressions_create) | **POST** /suppressions | Suppress an address or domain
+*Norbelys::SuppressionsApi* | [**suppressions_find**](docs/SuppressionsApi.md#suppressions_find) | **GET** /suppressions/{id} | Get a suppression
+*Norbelys::SuppressionsApi* | [**suppressions_list**](docs/SuppressionsApi.md#suppressions_list) | **GET** /suppressions | List suppressions
+*Norbelys::VerifyApi* | [**verify_email**](docs/VerifyApi.md#verify_email) | **POST** /verify | Verify an email address
+
+
+## Documentation for Models
+
+ - [Norbelys::AddProgramSenderParams](docs/AddProgramSenderParams.md)
+ - [Norbelys::AiEmailVariantContent](docs/AiEmailVariantContent.md)
+ - [Norbelys::AnalyticsQuery](docs/AnalyticsQuery.md)
+ - [Norbelys::AnalyticsQueryName](docs/AnalyticsQueryName.md)
+ - [Norbelys::AnalyticsQueryParams](docs/AnalyticsQueryParams.md)
+ - [Norbelys::AnalyticsQueryResult](docs/AnalyticsQueryResult.md)
+ - [Norbelys::ApiError](docs/ApiError.md)
+ - [Norbelys::ApiErrorDetail](docs/ApiErrorDetail.md)
+ - [Norbelys::AudienceActivityAction](docs/AudienceActivityAction.md)
+ - [Norbelys::AudienceActivityCondition](docs/AudienceActivityCondition.md)
+ - [Norbelys::AudienceActivityLinkFilter](docs/AudienceActivityLinkFilter.md)
+ - [Norbelys::AudienceActivityLinkMatchOp](docs/AudienceActivityLinkMatchOp.md)
+ - [Norbelys::AudienceActivityParams](docs/AudienceActivityParams.md)
+ - [Norbelys::AudienceAttributeCondition](docs/AudienceAttributeCondition.md)
+ - [Norbelys::AudienceConditionOp](docs/AudienceConditionOp.md)
+ - [Norbelys::AudienceConditionValue](docs/AudienceConditionValue.md)
+ - [Norbelys::AudienceFilter](docs/AudienceFilter.md)
+ - [Norbelys::AudienceMatch](docs/AudienceMatch.md)
+ - [Norbelys::AudienceRule](docs/AudienceRule.md)
+ - [Norbelys::AudienceSource](docs/AudienceSource.md)
+ - [Norbelys::AudienceStatusBreakdown](docs/AudienceStatusBreakdown.md)
+ - [Norbelys::AudienceSummary](docs/AudienceSummary.md)
+ - [Norbelys::AudienceWeekPoint](docs/AudienceWeekPoint.md)
+ - [Norbelys::BulkUpdateSenderPatch](docs/BulkUpdateSenderPatch.md)
+ - [Norbelys::BulkUpdateSendersInput](docs/BulkUpdateSendersInput.md)
+ - [Norbelys::BulkUpdateSendersResult](docs/BulkUpdateSendersResult.md)
+ - [Norbelys::CampaignReportShare](docs/CampaignReportShare.md)
+ - [Norbelys::CollectionAddress](docs/CollectionAddress.md)
+ - [Norbelys::ConnectionSettings](docs/ConnectionSettings.md)
+ - [Norbelys::CreateSenderInput](docs/CreateSenderInput.md)
+ - [Norbelys::DetachResult](docs/DetachResult.md)
+ - [Norbelys::DmarcRecordToPublish](docs/DmarcRecordToPublish.md)
+ - [Norbelys::Domain](docs/Domain.md)
+ - [Norbelys::DomainAge](docs/DomainAge.md)
+ - [Norbelys::DomainCapacity](docs/DomainCapacity.md)
+ - [Norbelys::DomainCreateParams](docs/DomainCreateParams.md)
+ - [Norbelys::DomainDetail](docs/DomainDetail.md)
+ - [Norbelys::DomainHealth](docs/DomainHealth.md)
+ - [Norbelys::DomainList](docs/DomainList.md)
+ - [Norbelys::DomainMonitoring](docs/DomainMonitoring.md)
+ - [Norbelys::DomainMonitoringParams](docs/DomainMonitoringParams.md)
+ - [Norbelys::DomainSending](docs/DomainSending.md)
+ - [Norbelys::DomainSendingPolicy](docs/DomainSendingPolicy.md)
+ - [Norbelys::DomainSendingPolicyParams](docs/DomainSendingPolicyParams.md)
+ - [Norbelys::DomainSendingUpdateParams](docs/DomainSendingUpdateParams.md)
+ - [Norbelys::DomainTracking](docs/DomainTracking.md)
+ - [Norbelys::DomainTrackingParams](docs/DomainTrackingParams.md)
+ - [Norbelys::DomainTrackingUpdateParams](docs/DomainTrackingUpdateParams.md)
+ - [Norbelys::DomainUpdateParams](docs/DomainUpdateParams.md)
+ - [Norbelys::EmailVariantContent](docs/EmailVariantContent.md)
+ - [Norbelys::EnrollProgramParams](docs/EnrollProgramParams.md)
+ - [Norbelys::EnrollProgramResult](docs/EnrollProgramResult.md)
+ - [Norbelys::Enrollment](docs/Enrollment.md)
+ - [Norbelys::EnrollmentCounts](docs/EnrollmentCounts.md)
+ - [Norbelys::EnrollmentList](docs/EnrollmentList.md)
+ - [Norbelys::EnrollmentPersonRef](docs/EnrollmentPersonRef.md)
+ - [Norbelys::EnrollmentProgramRef](docs/EnrollmentProgramRef.md)
+ - [Norbelys::Features](docs/Features.md)
+ - [Norbelys::Field](docs/Field.md)
+ - [Norbelys::FieldCreateParams](docs/FieldCreateParams.md)
+ - [Norbelys::FieldList](docs/FieldList.md)
+ - [Norbelys::FieldType](docs/FieldType.md)
+ - [Norbelys::FieldUpdateParams](docs/FieldUpdateParams.md)
+ - [Norbelys::FileObject](docs/FileObject.md)
+ - [Norbelys::FileUpload](docs/FileUpload.md)
+ - [Norbelys::Group](docs/Group.md)
+ - [Norbelys::GroupAddMembersParams](docs/GroupAddMembersParams.md)
+ - [Norbelys::GroupAddMembersResult](docs/GroupAddMembersResult.md)
+ - [Norbelys::GroupCreateParams](docs/GroupCreateParams.md)
+ - [Norbelys::GroupList](docs/GroupList.md)
+ - [Norbelys::GroupUpdateParams](docs/GroupUpdateParams.md)
+ - [Norbelys::ImapConnectionUpdate](docs/ImapConnectionUpdate.md)
+ - [Norbelys::InboundMessage](docs/InboundMessage.md)
+ - [Norbelys::Integration](docs/Integration.md)
+ - [Norbelys::IntegrationConfig](docs/IntegrationConfig.md)
+ - [Norbelys::IntegrationConnectParams](docs/IntegrationConnectParams.md)
+ - [Norbelys::IntegrationConnectResult](docs/IntegrationConnectResult.md)
+ - [Norbelys::IntegrationList](docs/IntegrationList.md)
+ - [Norbelys::IntegrationNotifyConfig](docs/IntegrationNotifyConfig.md)
+ - [Norbelys::IntegrationOptions](docs/IntegrationOptions.md)
+ - [Norbelys::IntegrationProvider](docs/IntegrationProvider.md)
+ - [Norbelys::IntegrationStatus](docs/IntegrationStatus.md)
+ - [Norbelys::IntegrationSyncResult](docs/IntegrationSyncResult.md)
+ - [Norbelys::IntegrationUpdateParams](docs/IntegrationUpdateParams.md)
+ - [Norbelys::LaunchProgramParams](docs/LaunchProgramParams.md)
+ - [Norbelys::LaunchProgramResult](docs/LaunchProgramResult.md)
+ - [Norbelys::Message](docs/Message.md)
+ - [Norbelys::MessageAddress](docs/MessageAddress.md)
+ - [Norbelys::MessageAttachment](docs/MessageAttachment.md)
+ - [Norbelys::MessageAttachmentDownload](docs/MessageAttachmentDownload.md)
+ - [Norbelys::MessageAttachmentInput](docs/MessageAttachmentInput.md)
+ - [Norbelys::MessageAttachmentList](docs/MessageAttachmentList.md)
+ - [Norbelys::MessageCreateParams](docs/MessageCreateParams.md)
+ - [Norbelys::MessageEnrollParams](docs/MessageEnrollParams.md)
+ - [Norbelys::MessageList](docs/MessageList.md)
+ - [Norbelys::MessageReplyParams](docs/MessageReplyParams.md)
+ - [Norbelys::MessageSource](docs/MessageSource.md)
+ - [Norbelys::MessageSourceAttachment](docs/MessageSourceAttachment.md)
+ - [Norbelys::MessageTestParams](docs/MessageTestParams.md)
+ - [Norbelys::MessageUpdateParams](docs/MessageUpdateParams.md)
+ - [Norbelys::MonthlyEmailUsageMeter](docs/MonthlyEmailUsageMeter.md)
+ - [Norbelys::Organization](docs/Organization.md)
+ - [Norbelys::OrganizationAlerts](docs/OrganizationAlerts.md)
+ - [Norbelys::OrganizationAlertsParams](docs/OrganizationAlertsParams.md)
+ - [Norbelys::OrganizationBouncePolicy](docs/OrganizationBouncePolicy.md)
+ - [Norbelys::OrganizationBouncePolicyParams](docs/OrganizationBouncePolicyParams.md)
+ - [Norbelys::OrganizationOnboarding](docs/OrganizationOnboarding.md)
+ - [Norbelys::OrganizationProfile](docs/OrganizationProfile.md)
+ - [Norbelys::OrganizationProfileParams](docs/OrganizationProfileParams.md)
+ - [Norbelys::OrganizationPulse](docs/OrganizationPulse.md)
+ - [Norbelys::OrganizationUpdateParams](docs/OrganizationUpdateParams.md)
+ - [Norbelys::OrganizationUsage](docs/OrganizationUsage.md)
+ - [Norbelys::OutboundMessage](docs/OutboundMessage.md)
+ - [Norbelys::PeopleBulkCreateParams](docs/PeopleBulkCreateParams.md)
+ - [Norbelys::PeopleBulkCreateResult](docs/PeopleBulkCreateResult.md)
+ - [Norbelys::Person](docs/Person.md)
+ - [Norbelys::PersonCreateParams](docs/PersonCreateParams.md)
+ - [Norbelys::PersonDetail](docs/PersonDetail.md)
+ - [Norbelys::PersonErased](docs/PersonErased.md)
+ - [Norbelys::PersonGroupRef](docs/PersonGroupRef.md)
+ - [Norbelys::PersonImportItem](docs/PersonImportItem.md)
+ - [Norbelys::PersonImportReason](docs/PersonImportReason.md)
+ - [Norbelys::PersonImportStats](docs/PersonImportStats.md)
+ - [Norbelys::PersonList](docs/PersonList.md)
+ - [Norbelys::PersonListItem](docs/PersonListItem.md)
+ - [Norbelys::PersonSegmentRef](docs/PersonSegmentRef.md)
+ - [Norbelys::PersonUpdateParams](docs/PersonUpdateParams.md)
+ - [Norbelys::Program](docs/Program.md)
+ - [Norbelys::ProgramCreateParams](docs/ProgramCreateParams.md)
+ - [Norbelys::ProgramDetail](docs/ProgramDetail.md)
+ - [Norbelys::ProgramList](docs/ProgramList.md)
+ - [Norbelys::ProgramListItem](docs/ProgramListItem.md)
+ - [Norbelys::ProgramPauseMeta](docs/ProgramPauseMeta.md)
+ - [Norbelys::ProgramSenderRef](docs/ProgramSenderRef.md)
+ - [Norbelys::ProgramStats](docs/ProgramStats.md)
+ - [Norbelys::ProgramStepInput](docs/ProgramStepInput.md)
+ - [Norbelys::ProgramUpdateParams](docs/ProgramUpdateParams.md)
+ - [Norbelys::ProgramVariantInput](docs/ProgramVariantInput.md)
+ - [Norbelys::ProgramsAudienceList](docs/ProgramsAudienceList.md)
+ - [Norbelys::ProgramsSendersList](docs/ProgramsSendersList.md)
+ - [Norbelys::ProviderApiSenderInput](docs/ProviderApiSenderInput.md)
+ - [Norbelys::PulseDeliverability](docs/PulseDeliverability.md)
+ - [Norbelys::PulseProgram](docs/PulseProgram.md)
+ - [Norbelys::PulseSenderFleet](docs/PulseSenderFleet.md)
+ - [Norbelys::PulseValue](docs/PulseValue.md)
+ - [Norbelys::ReportShare](docs/ReportShare.md)
+ - [Norbelys::Segment](docs/Segment.md)
+ - [Norbelys::SegmentCreateParams](docs/SegmentCreateParams.md)
+ - [Norbelys::SegmentList](docs/SegmentList.md)
+ - [Norbelys::SegmentUpdateParams](docs/SegmentUpdateParams.md)
+ - [Norbelys::SelfHostedSenderInput](docs/SelfHostedSenderInput.md)
+ - [Norbelys::Sender](docs/Sender.md)
+ - [Norbelys::SenderBulkError](docs/SenderBulkError.md)
+ - [Norbelys::SenderDetail](docs/SenderDetail.md)
+ - [Norbelys::SenderList](docs/SenderList.md)
+ - [Norbelys::SenderRemoveResult](docs/SenderRemoveResult.md)
+ - [Norbelys::SenderUsage](docs/SenderUsage.md)
+ - [Norbelys::SenderWarmupStatus](docs/SenderWarmupStatus.md)
+ - [Norbelys::SlackChannel](docs/SlackChannel.md)
+ - [Norbelys::SmtpConnectionSettings](docs/SmtpConnectionSettings.md)
+ - [Norbelys::SmtpConnectionUpdate](docs/SmtpConnectionUpdate.md)
+ - [Norbelys::SmtpSenderInput](docs/SmtpSenderInput.md)
+ - [Norbelys::StaticEmailVariantContent](docs/StaticEmailVariantContent.md)
+ - [Norbelys::StepWithVariants](docs/StepWithVariants.md)
+ - [Norbelys::Suppression](docs/Suppression.md)
+ - [Norbelys::SuppressionBulkParams](docs/SuppressionBulkParams.md)
+ - [Norbelys::SuppressionBulkResult](docs/SuppressionBulkResult.md)
+ - [Norbelys::SuppressionCreateParams](docs/SuppressionCreateParams.md)
+ - [Norbelys::SuppressionList](docs/SuppressionList.md)
+ - [Norbelys::SuppressionScope](docs/SuppressionScope.md)
+ - [Norbelys::SyncModel](docs/SyncModel.md)
+ - [Norbelys::TeamSize](docs/TeamSize.md)
+ - [Norbelys::TrackingDnsRecord](docs/TrackingDnsRecord.md)
+ - [Norbelys::UpdateSenderInput](docs/UpdateSenderInput.md)
+ - [Norbelys::UsageMeter](docs/UsageMeter.md)
+ - [Norbelys::UsagePlan](docs/UsagePlan.md)
+ - [Norbelys::Variant](docs/Variant.md)
+ - [Norbelys::VariantAi](docs/VariantAi.md)
+ - [Norbelys::VerifyEmailInput](docs/VerifyEmailInput.md)
+ - [Norbelys::VerifyMx](docs/VerifyMx.md)
+ - [Norbelys::VerifyReachability](docs/VerifyReachability.md)
+ - [Norbelys::VerifyReasonCode](docs/VerifyReasonCode.md)
+ - [Norbelys::VerifyResult](docs/VerifyResult.md)
+ - [Norbelys::VerifySignals](docs/VerifySignals.md)
+ - [Norbelys::VerifySyntax](docs/VerifySyntax.md)
+ - [Norbelys::VoiceSenderInput](docs/VoiceSenderInput.md)
+ - [Norbelys::WarmupRuntimeStatus](docs/WarmupRuntimeStatus.md)
+ - [Norbelys::WarmupSettings](docs/WarmupSettings.md)
+ - [Norbelys::WarmupTemplate](docs/WarmupTemplate.md)
+ - [Norbelys::WarmupTodayTally](docs/WarmupTodayTally.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### bearerAuth
+
+- **Type**: Bearer authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddProgramSenderParams.md

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

data/docs/AiEmailVariantContent.md

@@ -0,0 +1,28 @@
+# Norbelys::AiEmailVariantContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cta_override_reason** | **String** | Documented operator reason for keeping multiple commercial asks; advisory, never a launch blocker. | [optional] |
+| **html** | **String** | HTML body; supports template variables. | [optional] |
+| **preheader** | **String** | Optional inbox preview snippet; separate from the MIME plain-text body. | [optional] |
+| **subject** | **String** | Subject line; supports template variables like {{ firstname }} (always give bare tags a `| default:` fallback). | [optional] |
+| **text** | **String** | Optional plain-text body; when omitted it is derived from the rendered HTML. | [optional] |
+| **ai** | [**VariantAi**](VariantAi.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AiEmailVariantContent.new(
+  cta_override_reason: null,
+  html: null,
+  preheader: null,
+  subject: null,
+  text: null,
+  ai: null
+)
+```
+

data/docs/AnalyticsApi.md

@@ -0,0 +1,81 @@
+# Norbelys::AnalyticsApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**analytics_query**](AnalyticsApi.md#analytics_query) | **POST** /analytics/query | Run an analytics query |
+
+
+## analytics_query
+
+> <AnalyticsQueryResult> analytics_query(analytics_query, opts)
+
+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.
+
+### 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::AnalyticsApi.new
+analytics_query = Norbelys::AnalyticsQuery.new({query: Norbelys::AnalyticsQueryName::ACTIVITY_FEED}) # AnalyticsQuery | 
+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
+  # Run an analytics query
+  result = api_instance.analytics_query(analytics_query, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling AnalyticsApi->analytics_query: #{e}"
+end
+```
+
+#### Using the analytics_query_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AnalyticsQueryResult>, Integer, Hash)> analytics_query_with_http_info(analytics_query, opts)
+
+```ruby
+begin
+  # Run an analytics query
+  data, status_code, headers = api_instance.analytics_query_with_http_info(analytics_query, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AnalyticsQueryResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling AnalyticsApi->analytics_query_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **analytics_query** | [**AnalyticsQuery**](AnalyticsQuery.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
+
+[**AnalyticsQueryResult**](AnalyticsQueryResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AnalyticsQuery.md

@@ -0,0 +1,20 @@
+# Norbelys::AnalyticsQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **params** | [**AnalyticsQueryParams**](AnalyticsQueryParams.md) |  | [optional] |
+| **query** | [**AnalyticsQueryName**](AnalyticsQueryName.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::AnalyticsQuery.new(
+  params: null,
+  query: null
+)
+```
+

data/docs/AnalyticsQueryName.md

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