norbelys 0.1.0

data/docs/OrganizationApi.md

@@ -0,0 +1,350 @@
+# Norbelys::OrganizationApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**organization_features**](OrganizationApi.md#organization_features) | **GET** /organization/features | Get the organization's feature flags |
+| [**organization_find**](OrganizationApi.md#organization_find) | **GET** /organization | Get the organization |
+| [**organization_pulse**](OrganizationApi.md#organization_pulse) | **GET** /organization/pulse | Get the workspace pulse |
+| [**organization_update**](OrganizationApi.md#organization_update) | **PATCH** /organization | Update the organization |
+| [**organization_usage**](OrganizationApi.md#organization_usage) | **GET** /organization/usage | Get the organization's plan usage |
+
+
+## organization_features
+
+> <Features> organization_features
+
+Get the organization's feature flags
+
+Returns the workspace's resolved feature flags (per-org, evaluated at the edge). Use it to conditionally render gated features in a client; server endpoints enforce their own gate independently.
+
+### 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::OrganizationApi.new
+
+begin
+  # Get the organization's feature flags
+  result = api_instance.organization_features
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_features: #{e}"
+end
+```
+
+#### Using the organization_features_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Features>, Integer, Hash)> organization_features_with_http_info
+
+```ruby
+begin
+  # Get the organization's feature flags
+  data, status_code, headers = api_instance.organization_features_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Features>
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_features_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Features**](Features.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## organization_find
+
+> <Organization> organization_find
+
+Get the organization
+
+The workspace this credential acts on: org id, display name, company profile, onboarding and notification state. Read-only — THE first call to confirm \"who am I / which tenant is this?\".
+
+### 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::OrganizationApi.new
+
+begin
+  # Get the organization
+  result = api_instance.organization_find
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_find: #{e}"
+end
+```
+
+#### Using the organization_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Organization>, Integer, Hash)> organization_find_with_http_info
+
+```ruby
+begin
+  # Get the organization
+  data, status_code, headers = api_instance.organization_find_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Organization>
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## organization_pulse
+
+> <OrganizationPulse> organization_pulse(opts)
+
+Get the workspace pulse
+
+One-call workspace briefing: every campaign with its lead count, completion, and engagement funnel over the window (default 7 days), the mailbox fleet rolled up by state and reputation, and the account deliverability headline. THE first read for any \"how is everything going?\" / status question — prefer it over separately listing programs, senders, and analytics.
+
+### 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::OrganizationApi.new
+opts = {
+  days: 56 # Integer | 
+}
+
+begin
+  # Get the workspace pulse
+  result = api_instance.organization_pulse(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_pulse: #{e}"
+end
+```
+
+#### Using the organization_pulse_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrganizationPulse>, Integer, Hash)> organization_pulse_with_http_info(opts)
+
+```ruby
+begin
+  # Get the workspace pulse
+  data, status_code, headers = api_instance.organization_pulse_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrganizationPulse>
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_pulse_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **days** | **Integer** |  | [optional] |
+
+### Return type
+
+[**OrganizationPulse**](OrganizationPulse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## organization_update
+
+> <Organization> organization_update(organization_update_params)
+
+Update the organization
+
+Update the workspace's editable profile and settings: company profile, onboarding state, deliverability alerts, and bounce-handling policy. Idempotent — every field is optional, and calling it with an empty body just reconciles the tenant (it provisions the org's registry row when the user moves faster than the provisioning webhook). Returns the full resolved organization state. Members and invites are managed through Clerk, not this endpoint.
+
+### 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::OrganizationApi.new
+organization_update_params = Norbelys::OrganizationUpdateParams.new # OrganizationUpdateParams | 
+
+begin
+  # Update the organization
+  result = api_instance.organization_update(organization_update_params)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_update: #{e}"
+end
+```
+
+#### Using the organization_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Organization>, Integer, Hash)> organization_update_with_http_info(organization_update_params)
+
+```ruby
+begin
+  # Update the organization
+  data, status_code, headers = api_instance.organization_update_with_http_info(organization_update_params)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Organization>
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_update_params** | [**OrganizationUpdateParams**](OrganizationUpdateParams.md) |  |  |
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## organization_usage
+
+> <OrganizationUsage> organization_usage
+
+Get the organization's plan usage
+
+The workspace's usage against its plan limits: live campaigns, active contacts, and emails sent this UTC month, each with the cap and an `ok`/`near`/`reached` level, plus the plan itself. Use it to answer \"how close am I to my limits?\" — the caps are enforced server-side regardless.
+
+### 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::OrganizationApi.new
+
+begin
+  # Get the organization's plan usage
+  result = api_instance.organization_usage
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_usage: #{e}"
+end
+```
+
+#### Using the organization_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrganizationUsage>, Integer, Hash)> organization_usage_with_http_info
+
+```ruby
+begin
+  # Get the organization's plan usage
+  data, status_code, headers = api_instance.organization_usage_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrganizationUsage>
+rescue Norbelys::ApiError => e
+  puts "Error when calling OrganizationApi->organization_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**OrganizationUsage**](OrganizationUsage.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OrganizationBouncePolicy.md

@@ -0,0 +1,20 @@
+# Norbelys::OrganizationBouncePolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **stop_on_soft_failure** | **Boolean** | Stop a person's sequences when a delivery fails softly (mailbox full / over quota). Off = only permanently-dead bounces stop the cadence. Default: true. |  |
+| **suppress_on_soft_stop** | **Boolean** | When a soft failure stops the cadence, also add the address to the suppression list (block re-import/re-send). Default: false — the mailbox may clear, so the lead stays re-importable. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationBouncePolicy.new(
+  stop_on_soft_failure: null,
+  suppress_on_soft_stop: null
+)
+```
+

data/docs/OrganizationBouncePolicyParams.md

@@ -0,0 +1,20 @@
+# Norbelys::OrganizationBouncePolicyParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **stop_on_soft_failure** | **Boolean** | Stop sequences on a soft delivery failure (full / over-quota mailbox). | [optional] |
+| **suppress_on_soft_stop** | **Boolean** | Also suppress the address when a soft failure stops it. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationBouncePolicyParams.new(
+  stop_on_soft_failure: null,
+  suppress_on_soft_stop: null
+)
+```
+

data/docs/OrganizationOnboarding.md

@@ -0,0 +1,20 @@
+# Norbelys::OrganizationOnboarding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completed** | **Boolean** | Whether onboarding has been completed. |  |
+| **completed_at** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationOnboarding.new(
+  completed: null,
+  completed_at: null
+)
+```
+

data/docs/OrganizationProfile.md

@@ -0,0 +1,22 @@
+# Norbelys::OrganizationProfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **industry** | **String** |  |  |
+| **team_size** | [**TeamSize**](TeamSize.md) |  |  |
+| **website** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationProfile.new(
+  industry: null,
+  team_size: null,
+  website: null
+)
+```
+

data/docs/OrganizationProfileParams.md

@@ -0,0 +1,22 @@
+# Norbelys::OrganizationProfileParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **industry** | **String** | Free-text industry label. | [optional] |
+| **team_size** | **String** | Coarse team-size bucket: `1`, `2-10`, `11-50`, `51-200`, or `201+`. | [optional] |
+| **website** | **String** | The company website URL. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationProfileParams.new(
+  industry: null,
+  team_size: null,
+  website: null
+)
+```
+

data/docs/OrganizationPulse.md

@@ -0,0 +1,28 @@
+# Norbelys::OrganizationPulse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deliverability** | [**PulseDeliverability**](PulseDeliverability.md) |  |  |
+| **object** | **Object** |  |  |
+| **programs** | [**Array<PulseProgram>**](PulseProgram.md) | Every non-archived campaign with its state and window metrics — active first, then by lead count. |  |
+| **senders** | [**PulseSenderFleet**](PulseSenderFleet.md) |  |  |
+| **value** | [**PulseValue**](PulseValue.md) |  |  |
+| **window_days** | **Float** | The window (days) the metrics were computed over. Example: 7 |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationPulse.new(
+  deliverability: null,
+  object: null,
+  programs: null,
+  senders: null,
+  value: null,
+  window_days: null
+)
+```
+

data/docs/OrganizationUpdateParams.md

@@ -0,0 +1,24 @@
+# Norbelys::OrganizationUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alerts** | [**OrganizationAlertsParams**](OrganizationAlertsParams.md) |  | [optional] |
+| **bounce_policy** | [**OrganizationBouncePolicyParams**](OrganizationBouncePolicyParams.md) |  | [optional] |
+| **complete** | **Boolean** | Mark onboarding complete (only applied once the organization is provisioned). | [optional] |
+| **profile** | [**OrganizationProfileParams**](OrganizationProfileParams.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationUpdateParams.new(
+  alerts: null,
+  bounce_policy: null,
+  complete: null,
+  profile: null
+)
+```
+

data/docs/OrganizationUsage.md

@@ -0,0 +1,26 @@
+# Norbelys::OrganizationUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaigns** | [**UsageMeter**](UsageMeter.md) |  |  |
+| **contacts** | [**UsageMeter**](UsageMeter.md) | Active (non-archived) people. |  |
+| **emails** | [**MonthlyEmailUsageMeter**](MonthlyEmailUsageMeter.md) |  |  |
+| **object** | **Object** |  |  |
+| **plan** | [**UsagePlan**](UsagePlan.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OrganizationUsage.new(
+  campaigns: null,
+  contacts: null,
+  emails: null,
+  object: null,
+  plan: null
+)
+```
+

data/docs/OutboundMessage.md

@@ -0,0 +1,46 @@
+# Norbelys::OutboundMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_email** | **String** |  |  |
+| **contact_name** | **String** |  |  |
+| **id** | **String** | The message id. |  |
+| **object** | **Object** |  | [optional] |
+| **occurred_at** | **Object** |  | [optional] |
+| **person_id** | **String** |  |  |
+| **sender_id** | **String** |  |  |
+| **subject** | **String** |  |  |
+| **thread_id** | **String** |  |  |
+| **channel** | **String** | Outbound channel: email, call, sms, or linkedin. |  |
+| **direction** | **Object** |  |  |
+| **is_test** | **Boolean** | A test/probe send — surfaced in the log but excluded from campaign rates. |  |
+| **program_id** | **String** |  |  |
+| **status** | **String** | Delivery status: queued, sent, delivered, failed, bounced, or cancelled. |  |
+| **step_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::OutboundMessage.new(
+  contact_email: null,
+  contact_name: null,
+  id: null,
+  object: null,
+  occurred_at: null,
+  person_id: null,
+  sender_id: null,
+  subject: null,
+  thread_id: null,
+  channel: null,
+  direction: null,
+  is_test: null,
+  program_id: null,
+  status: null,
+  step_id: null
+)
+```
+