norbelys 0.1.0

data/docs/IntegrationsApi.md

@@ -0,0 +1,513 @@
+# Norbelys::IntegrationsApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**integrations_connect**](IntegrationsApi.md#integrations_connect) | **POST** /integrations/connect | Connect an integration |
+| [**integrations_find**](IntegrationsApi.md#integrations_find) | **GET** /integrations/{id} | Get an integration |
+| [**integrations_list**](IntegrationsApi.md#integrations_list) | **GET** /integrations | List integrations |
+| [**integrations_options**](IntegrationsApi.md#integrations_options) | **GET** /integrations/{id}/options | List an integration's config options |
+| [**integrations_remove**](IntegrationsApi.md#integrations_remove) | **DELETE** /integrations/{id} | Disconnect an integration |
+| [**integrations_sync**](IntegrationsApi.md#integrations_sync) | **POST** /integrations/{id}/sync | Sync an integration now |
+| [**integrations_update**](IntegrationsApi.md#integrations_update) | **PATCH** /integrations/{id} | Update an integration |
+
+
+## integrations_connect
+
+> <IntegrationConnectResult> integrations_connect(integration_connect_params, opts)
+
+Connect an integration
+
+Mints a Nango Connect session for the provider and returns its `sessionToken` for the frontend Connect UI. There is no direct create — the connection row is born from the provider's auth webhook once the user finishes authorizing.
+
+### 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::IntegrationsApi.new
+integration_connect_params = Norbelys::IntegrationConnectParams.new({provider: Norbelys::IntegrationProvider::SLACK}) # IntegrationConnectParams | 
+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
+  # Connect an integration
+  result = api_instance.integrations_connect(integration_connect_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_connect: #{e}"
+end
+```
+
+#### Using the integrations_connect_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationConnectResult>, Integer, Hash)> integrations_connect_with_http_info(integration_connect_params, opts)
+
+```ruby
+begin
+  # Connect an integration
+  data, status_code, headers = api_instance.integrations_connect_with_http_info(integration_connect_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationConnectResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_connect_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_connect_params** | [**IntegrationConnectParams**](IntegrationConnectParams.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
+
+[**IntegrationConnectResult**](IntegrationConnectResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## integrations_find
+
+> <Integration> integrations_find(id)
+
+Get an integration
+
+### 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::IntegrationsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get an integration
+  result = api_instance.integrations_find(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_find: #{e}"
+end
+```
+
+#### Using the integrations_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Integration>, Integer, Hash)> integrations_find_with_http_info(id)
+
+```ruby
+begin
+  # Get an integration
+  data, status_code, headers = api_instance.integrations_find_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Integration>
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Integration**](Integration.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## integrations_list
+
+> <IntegrationList> integrations_list(opts)
+
+List integrations
+
+Each row is one connected provider account. There is no create endpoint — a connection is born from the provider's auth webhook after you call `connect`.
+
+### 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::IntegrationsApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  include_archived: true, # Boolean | 
+  limit: 56, # Integer | 
+  provider: 'slack' # String | 
+}
+
+begin
+  # List integrations
+  result = api_instance.integrations_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_list: #{e}"
+end
+```
+
+#### Using the integrations_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationList>, Integer, Hash)> integrations_list_with_http_info(opts)
+
+```ruby
+begin
+  # List integrations
+  data, status_code, headers = api_instance.integrations_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **include_archived** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **provider** | **String** |  | [optional] |
+
+### Return type
+
+[**IntegrationList**](IntegrationList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## integrations_options
+
+> <IntegrationOptions> integrations_options(id)
+
+List an integration's config options
+
+Config-time lookup of the provider's selectable options, proxied live through Nango — today, the postable Slack channels for the notification channel picker.
+
+### 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::IntegrationsApi.new
+id = 'id_example' # String | 
+
+begin
+  # List an integration's config options
+  result = api_instance.integrations_options(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_options: #{e}"
+end
+```
+
+#### Using the integrations_options_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationOptions>, Integer, Hash)> integrations_options_with_http_info(id)
+
+```ruby
+begin
+  # List an integration's config options
+  data, status_code, headers = api_instance.integrations_options_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationOptions>
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_options_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**IntegrationOptions**](IntegrationOptions.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## integrations_remove
+
+> <Integration> integrations_remove(id)
+
+Disconnect an integration
+
+Disconnects the account: revokes the credential at the provider via Nango and soft-archives the row.
+
+### 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::IntegrationsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Disconnect an integration
+  result = api_instance.integrations_remove(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_remove: #{e}"
+end
+```
+
+#### Using the integrations_remove_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Integration>, Integer, Hash)> integrations_remove_with_http_info(id)
+
+```ruby
+begin
+  # Disconnect an integration
+  data, status_code, headers = api_instance.integrations_remove_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Integration>
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_remove_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Integration**](Integration.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## integrations_sync
+
+> <IntegrationSyncResult> integrations_sync(id, opts)
+
+Sync an integration now
+
+Triggers an immediate, off-schedule sync, queuing a drain of every model the provider syncs (e.g. leads and deals for a CRM).
+
+### 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::IntegrationsApi.new
+id = 'id_example' # String | 
+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
+  # Sync an integration now
+  result = api_instance.integrations_sync(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_sync: #{e}"
+end
+```
+
+#### Using the integrations_sync_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationSyncResult>, Integer, Hash)> integrations_sync_with_http_info(id, opts)
+
+```ruby
+begin
+  # Sync an integration now
+  data, status_code, headers = api_instance.integrations_sync_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationSyncResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_sync_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **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
+
+[**IntegrationSyncResult**](IntegrationSyncResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## integrations_update
+
+> <Integration> integrations_update(id, integration_update_params)
+
+Update an integration
+
+Shallow-merges the given `config` over the stored config (top-level keys replace). Slack carries the notification toggles and target channel; CRMs carry the sync-in / push-out direction gates.
+
+### 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::IntegrationsApi.new
+id = 'id_example' # String | 
+integration_update_params = Norbelys::IntegrationUpdateParams.new({config: Norbelys::IntegrationConfig.new}) # IntegrationUpdateParams | 
+
+begin
+  # Update an integration
+  result = api_instance.integrations_update(id, integration_update_params)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_update: #{e}"
+end
+```
+
+#### Using the integrations_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Integration>, Integer, Hash)> integrations_update_with_http_info(id, integration_update_params)
+
+```ruby
+begin
+  # Update an integration
+  data, status_code, headers = api_instance.integrations_update_with_http_info(id, integration_update_params)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Integration>
+rescue Norbelys::ApiError => e
+  puts "Error when calling IntegrationsApi->integrations_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **integration_update_params** | [**IntegrationUpdateParams**](IntegrationUpdateParams.md) |  |  |
+
+### Return type
+
+[**Integration**](Integration.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/LaunchProgramParams.md

@@ -0,0 +1,18 @@
+# Norbelys::LaunchProgramParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::LaunchProgramParams.new(
+  start_date: null
+)
+```
+

data/docs/LaunchProgramResult.md

@@ -0,0 +1,22 @@
+# Norbelys::LaunchProgramResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **program_id** | **String** | The program id. |  |
+| **status** | **String** | Always \"active\" on success. |  |
+| **warnings** | **Array<String>** | Non-fatal compliance advisories (e.g. cold campaign without one-click unsubscribe). The launch still succeeded. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::LaunchProgramResult.new(
+  program_id: null,
+  status: null,
+  warnings: null
+)
+```
+

data/docs/Message.md

@@ -0,0 +1,58 @@
+# Norbelys::Message
+
+## 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** |  |  |
+| **assignee_id** | **String** |  |  |
+| **body_html** | **String** |  |  |
+| **body_text** | **String** |  |  |
+| **classification** | **String** | Triage class: interested, out_of_office, not_interested, auto_reply, bounce, complaint, unsubscribe, or uncategorized. |  |
+| **from_email** | **String** |  |  |
+| **is_read** | **Boolean** | Whether the reply has been read. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Message.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,
+  assignee_id: null,
+  body_html: null,
+  body_text: null,
+  classification: null,
+  from_email: null,
+  is_read: null
+)
+```
+

data/docs/MessageAddress.md

@@ -0,0 +1,20 @@
+# Norbelys::MessageAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email address. |  |
+| **name** | **String** | Display name. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageAddress.new(
+  email: null,
+  name: null
+)
+```
+

data/docs/MessageAttachment.md

@@ -0,0 +1,28 @@
+# Norbelys::MessageAttachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_id** | **String** |  | [optional] |
+| **content_type** | **String** | MIME type. |  |
+| **filename** | **String** | File name. |  |
+| **disposition** | **String** |  | [optional] |
+| **id** | **String** | The attachment id within the message. |  |
+| **size** | **Integer** | Decoded file size in bytes. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageAttachment.new(
+  content_id: null,
+  content_type: null,
+  filename: null,
+  disposition: null,
+  id: null,
+  size: null
+)
+```
+

data/docs/MessageAttachmentDownload.md

@@ -0,0 +1,32 @@
+# Norbelys::MessageAttachmentDownload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_id** | **String** |  | [optional] |
+| **content_type** | **String** | MIME type. |  |
+| **filename** | **String** | File name. |  |
+| **disposition** | **String** |  | [optional] |
+| **id** | **String** | The attachment id within the message. |  |
+| **size** | **Integer** | Decoded file size in bytes. |  |
+| **content** | **String** | Base64-encoded file content — decode to get the file. |  |
+| **object** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::MessageAttachmentDownload.new(
+  content_id: null,
+  content_type: null,
+  filename: null,
+  disposition: null,
+  id: null,
+  size: null,
+  content: null,
+  object: null
+)
+```
+