norbelys 0.1.0

data/docs/GroupAddMembersParams.md

@@ -0,0 +1,20 @@
+# Norbelys::GroupAddMembersParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **person_ids** | **Array<String>** | Explicit person ids to add. | [optional] |
+| **segment_id** | **String** | Add every person currently matching this segment as a one-time snapshot; they are copied in and not kept in sync with the segment afterward. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::GroupAddMembersParams.new(
+  person_ids: null,
+  segment_id: null
+)
+```
+

data/docs/GroupAddMembersResult.md

@@ -0,0 +1,22 @@
+# Norbelys::GroupAddMembersResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added** | **Integer** | Number of people newly added to the group. |  |
+| **member_count** | **Integer** | The group's total member count after the add. |  |
+| **skipped** | **Integer** | Number of people skipped because they were already members. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::GroupAddMembersResult.new(
+  added: null,
+  member_count: null,
+  skipped: null
+)
+```
+

data/docs/GroupCreateParams.md

@@ -0,0 +1,22 @@
+# Norbelys::GroupCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **color** | **String** | Optional accent color for the group's badge. Example: rose. | [optional] |
+| **description** | **String** | Optional notes on what this group is for. | [optional] |
+| **name** | **String** | The group's display name. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::GroupCreateParams.new(
+  color: null,
+  description: null,
+  name: null
+)
+```
+

data/docs/GroupList.md

@@ -0,0 +1,26 @@
+# Norbelys::GroupList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Group>**](Group.md) | The page of results, newest first. |  |
+| **has_more** | **Boolean** | Whether another page exists beyond this one. |  |
+| **next_cursor** | **String** |  |  |
+| **object** | **Object** |  | [optional] |
+| **total** | **Integer** | Total number of groups matching the search. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::GroupList.new(
+  data: null,
+  has_more: null,
+  next_cursor: null,
+  object: null,
+  total: null
+)
+```
+

data/docs/GroupUpdateParams.md

@@ -0,0 +1,22 @@
+# Norbelys::GroupUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **color** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **name** | **String** | New display name for the group. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::GroupUpdateParams.new(
+  color: null,
+  description: null,
+  name: null
+)
+```
+

data/docs/GroupsApi.md

@@ -0,0 +1,521 @@
+# Norbelys::GroupsApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**groups_archive**](GroupsApi.md#groups_archive) | **DELETE** /groups/{id} | Delete a group |
+| [**groups_create**](GroupsApi.md#groups_create) | **POST** /groups | Create a group |
+| [**groups_find**](GroupsApi.md#groups_find) | **GET** /groups/{id} | Get a group |
+| [**groups_list**](GroupsApi.md#groups_list) | **GET** /groups | List groups |
+| [**groups_members_add**](GroupsApi.md#groups_members_add) | **POST** /groups/{id}/members | Add people to a group |
+| [**groups_members_remove**](GroupsApi.md#groups_members_remove) | **DELETE** /groups/{id}/members/{relId} | Remove a person from a group |
+| [**groups_update**](GroupsApi.md#groups_update) | **PATCH** /groups/{id} | Update a group |
+
+
+## groups_archive
+
+> <Group> groups_archive(id)
+
+Delete a group
+
+Permanently delete the group and its membership rows. The people themselves are kept — only their membership in this group is removed.
+
+### 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::GroupsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a group
+  result = api_instance.groups_archive(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_archive: #{e}"
+end
+```
+
+#### Using the groups_archive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Group>, Integer, Hash)> groups_archive_with_http_info(id)
+
+```ruby
+begin
+  # Delete a group
+  data, status_code, headers = api_instance.groups_archive_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Group>
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_archive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Group**](Group.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## groups_create
+
+> <Group> groups_create(group_create_params, opts)
+
+Create a group
+
+Create a group: an empty static list of people. Add members with groups.members.add (explicit person ids, or snapshot a segment's current matches), then view them at GET /v1/people?groupId={id}.
+
+### 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::GroupsApi.new
+group_create_params = Norbelys::GroupCreateParams.new({name: 'name_example'}) # GroupCreateParams | 
+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
+  # Create a group
+  result = api_instance.groups_create(group_create_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_create: #{e}"
+end
+```
+
+#### Using the groups_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Group>, Integer, Hash)> groups_create_with_http_info(group_create_params, opts)
+
+```ruby
+begin
+  # Create a group
+  data, status_code, headers = api_instance.groups_create_with_http_info(group_create_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Group>
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_create_params** | [**GroupCreateParams**](GroupCreateParams.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
+
+[**Group**](Group.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## groups_find
+
+> <Group> groups_find(id)
+
+Get a group
+
+Read one group, including its live member count. List its members at GET /v1/people?groupId={id} — there is no separate members 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::GroupsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a group
+  result = api_instance.groups_find(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_find: #{e}"
+end
+```
+
+#### Using the groups_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Group>, Integer, Hash)> groups_find_with_http_info(id)
+
+```ruby
+begin
+  # Get a group
+  data, status_code, headers = api_instance.groups_find_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Group>
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Group**](Group.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## groups_list
+
+> <GroupList> groups_list(opts)
+
+List groups
+
+List the org's groups — static, hand-curated lists of people — newest first.
+
+### 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::GroupsApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  include_archived: true, # Boolean | 
+  limit: 56, # Integer | 
+  q: 'q_example' # String | 
+}
+
+begin
+  # List groups
+  result = api_instance.groups_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_list: #{e}"
+end
+```
+
+#### Using the groups_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GroupList>, Integer, Hash)> groups_list_with_http_info(opts)
+
+```ruby
+begin
+  # List groups
+  data, status_code, headers = api_instance.groups_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GroupList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **include_archived** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **q** | **String** |  | [optional] |
+
+### Return type
+
+[**GroupList**](GroupList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## groups_members_add
+
+> <GroupAddMembersResult> groups_members_add(id, opts)
+
+Add people to a group
+
+Add people to the group by explicit person ids and/or by snapshotting a segment's current matches into it. Idempotent — people already in the group are skipped.
+
+### 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::GroupsApi.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.
+  group_add_members_params: Norbelys::GroupAddMembersParams.new # GroupAddMembersParams | 
+}
+
+begin
+  # Add people to a group
+  result = api_instance.groups_members_add(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_members_add: #{e}"
+end
+```
+
+#### Using the groups_members_add_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GroupAddMembersResult>, Integer, Hash)> groups_members_add_with_http_info(id, opts)
+
+```ruby
+begin
+  # Add people to a group
+  data, status_code, headers = api_instance.groups_members_add_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GroupAddMembersResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_members_add_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] |
+| **group_add_members_params** | [**GroupAddMembersParams**](GroupAddMembersParams.md) |  | [optional] |
+
+### Return type
+
+[**GroupAddMembersResult**](GroupAddMembersResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## groups_members_remove
+
+> <DetachResult> groups_members_remove(id, rel_id)
+
+Remove a person from a group
+
+Remove one person from the group. The person record is kept — only their membership in this group is removed.
+
+### 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::GroupsApi.new
+id = 'id_example' # String | 
+rel_id = 'rel_id_example' # String | 
+
+begin
+  # Remove a person from a group
+  result = api_instance.groups_members_remove(id, rel_id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_members_remove: #{e}"
+end
+```
+
+#### Using the groups_members_remove_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DetachResult>, Integer, Hash)> groups_members_remove_with_http_info(id, rel_id)
+
+```ruby
+begin
+  # Remove a person from a group
+  data, status_code, headers = api_instance.groups_members_remove_with_http_info(id, rel_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DetachResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_members_remove_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **rel_id** | **String** |  |  |
+
+### Return type
+
+[**DetachResult**](DetachResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## groups_update
+
+> <Group> groups_update(id, opts)
+
+Update a group
+
+Rename a group or change its description and color chip. Membership is edited separately via groups.members.add / groups.members.remove.
+
+### 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::GroupsApi.new
+id = 'id_example' # String | 
+opts = {
+  group_update_params: Norbelys::GroupUpdateParams.new # GroupUpdateParams | 
+}
+
+begin
+  # Update a group
+  result = api_instance.groups_update(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_update: #{e}"
+end
+```
+
+#### Using the groups_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Group>, Integer, Hash)> groups_update_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update a group
+  data, status_code, headers = api_instance.groups_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Group>
+rescue Norbelys::ApiError => e
+  puts "Error when calling GroupsApi->groups_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **group_update_params** | [**GroupUpdateParams**](GroupUpdateParams.md) |  | [optional] |
+
+### Return type
+
+[**Group**](Group.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ImapConnectionUpdate.md

@@ -0,0 +1,22 @@
+# Norbelys::ImapConnectionUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | The server hostname. | [optional] |
+| **port** | **Integer** | The server port. | [optional] |
+| **security** | **String** | TLS mode: `ssl` (implicit TLS), `tls` (STARTTLS), or `none`. Defaults to STARTTLS when unset. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::ImapConnectionUpdate.new(
+  host: null,
+  port: null,
+  security: null
+)
+```
+

data/docs/InboundMessage.md

@@ -0,0 +1,48 @@
+# Norbelys::InboundMessage
+
+## 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** |  |  |
+| **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. |  |
+| **direction** | **Object** |  |  |
+| **from_email** | **String** |  |  |
+| **is_read** | **Boolean** | Whether the reply has been read. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::InboundMessage.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,
+  assignee_id: null,
+  body_html: null,
+  body_text: null,
+  classification: null,
+  direction: null,
+  from_email: null,
+  is_read: null
+)
+```
+