norbelys 0.1.0

data/docs/EnrollmentList.md

@@ -0,0 +1,28 @@
+# Norbelys::EnrollmentList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Enrollment>**](Enrollment.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 rows matching the filters. Not included on every list. | [optional] |
+| **counts** | [**EnrollmentCounts**](EnrollmentCounts.md) |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::EnrollmentList.new(
+  data: null,
+  has_more: null,
+  next_cursor: null,
+  object: null,
+  total: null,
+  counts: null
+)
+```
+

data/docs/EnrollmentPersonRef.md

@@ -0,0 +1,22 @@
+# Norbelys::EnrollmentPersonRef
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **id** | **String** | The person's id. |  |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::EnrollmentPersonRef.new(
+  email: null,
+  id: null,
+  name: null
+)
+```
+

data/docs/EnrollmentProgramRef.md

@@ -0,0 +1,20 @@
+# Norbelys::EnrollmentProgramRef
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The program's id. |  |
+| **name** | **String** | The program's display name. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::EnrollmentProgramRef.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/Features.md

@@ -0,0 +1,18 @@
+# Norbelys::Features
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sender_google_o_auth** | **Boolean** | Whether this organization can connect email senders via Google OAuth. Access is granted per organization. Example: true |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Features.new(
+  sender_google_o_auth: null
+)
+```
+

data/docs/Field.md

@@ -0,0 +1,38 @@
+# Norbelys::Field
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **code** | **String** | The merge tag and storage key, templated as `{{ code }}`. |  |
+| **created_at** | **Object** |  | [optional] |
+| **id** | **String** | The field id. |  |
+| **is_filterable** | **Boolean** | Whether this field is offered as a segment/list filter. |  |
+| **label** | **String** | The human-readable display name for the field. |  |
+| **object** | **Object** |  | [optional] |
+| **options** | **Array<String>** |  |  |
+| **order** | **Integer** | Display order among custom fields (lower = first). |  |
+| **type** | [**FieldType**](FieldType.md) |  |  |
+| **updated_at** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Field.new(
+  archived_at: null,
+  code: null,
+  created_at: null,
+  id: null,
+  is_filterable: null,
+  label: null,
+  object: null,
+  options: null,
+  order: null,
+  type: null,
+  updated_at: null
+)
+```
+

data/docs/FieldCreateParams.md

@@ -0,0 +1,26 @@
+# Norbelys::FieldCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The merge code; omit to auto-derive a slug from the label. | [optional] |
+| **is_filterable** | **Boolean** | Offer this field as a segment filter; defaults to true. | [optional] |
+| **label** | **String** | The human-readable display name for the field. |  |
+| **options** | **Array<String>** | Allowed values — required when `type` is `dropdown`. | [optional] |
+| **type** | **String** | The data type: `text`, `email`, `phone`, `date`, `datetime`, `number`, or `dropdown`; defaults to `text`. | [optional][default to 'text'] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::FieldCreateParams.new(
+  code: null,
+  is_filterable: null,
+  label: null,
+  options: null,
+  type: null
+)
+```
+

data/docs/FieldList.md

@@ -0,0 +1,20 @@
+# Norbelys::FieldList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Field>**](Field.md) | The org's custom fields, in display order. |  |
+| **object** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::FieldList.new(
+  data: null,
+  object: null
+)
+```
+

data/docs/FieldType.md

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

data/docs/FieldUpdateParams.md

@@ -0,0 +1,24 @@
+# Norbelys::FieldUpdateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_filterable** | **Boolean** | Whether this field is offered as a segment/list filter. | [optional] |
+| **label** | **String** | New display name for the field. | [optional] |
+| **options** | **Array<String>** |  | [optional] |
+| **type** | **String** | Change the data type: `text`, `email`, `phone`, `date`, `datetime`, `number`, or `dropdown`. | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::FieldUpdateParams.new(
+  is_filterable: null,
+  label: null,
+  options: null,
+  type: null
+)
+```
+

data/docs/FieldsApi.md

@@ -0,0 +1,297 @@
+# Norbelys::FieldsApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**fields_archive**](FieldsApi.md#fields_archive) | **DELETE** /fields/{id} | Delete a field |
+| [**fields_create**](FieldsApi.md#fields_create) | **POST** /fields | Create a custom field |
+| [**fields_list**](FieldsApi.md#fields_list) | **GET** /fields | List custom fields |
+| [**fields_update**](FieldsApi.md#fields_update) | **PATCH** /fields/{id} | Update a field |
+
+
+## fields_archive
+
+> <Field> fields_archive(id)
+
+Delete a field
+
+Soft-delete a custom field so it stops appearing in the UI, the merge-tag catalog, and segment filters. The values already stored under its `code` on each person are kept, so the field can be restored without data loss.
+
+### 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::FieldsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a field
+  result = api_instance.fields_archive(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_archive: #{e}"
+end
+```
+
+#### Using the fields_archive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Field>, Integer, Hash)> fields_archive_with_http_info(id)
+
+```ruby
+begin
+  # Delete a field
+  data, status_code, headers = api_instance.fields_archive_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Field>
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_archive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Field**](Field.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## fields_create
+
+> <Field> fields_create(field_create_params, opts)
+
+Create a custom field
+
+Create a custom person-field. Its `code` becomes the `{{ code }}` merge tag used in templates and the key it is filtered by in segments; omit `code` to auto-derive a slug from the label. A `dropdown` field must also supply its `options`.
+
+### 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::FieldsApi.new
+field_create_params = Norbelys::FieldCreateParams.new({label: 'label_example'}) # FieldCreateParams | 
+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 custom field
+  result = api_instance.fields_create(field_create_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_create: #{e}"
+end
+```
+
+#### Using the fields_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Field>, Integer, Hash)> fields_create_with_http_info(field_create_params, opts)
+
+```ruby
+begin
+  # Create a custom field
+  data, status_code, headers = api_instance.fields_create_with_http_info(field_create_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Field>
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_create_params** | [**FieldCreateParams**](FieldCreateParams.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
+
+[**Field**](Field.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## fields_list
+
+> <FieldList> fields_list(opts)
+
+List custom fields
+
+List all of the org's custom person-fields, in display order. The entire set is returned in one response — there is no pagination, because the set is small. System fields (email, telephone, first/last name) are not included here; only tenant-created custom fields.
+
+### 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::FieldsApi.new
+opts = {
+  include_archived: true # Boolean | 
+}
+
+begin
+  # List custom fields
+  result = api_instance.fields_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_list: #{e}"
+end
+```
+
+#### Using the fields_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FieldList>, Integer, Hash)> fields_list_with_http_info(opts)
+
+```ruby
+begin
+  # List custom fields
+  data, status_code, headers = api_instance.fields_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FieldList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include_archived** | **Boolean** |  | [optional] |
+
+### Return type
+
+[**FieldList**](FieldList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## fields_update
+
+> <Field> fields_update(id, opts)
+
+Update a field
+
+Update a field's label, type, options, or filterability. The `code` is immutable after create — live templates and segments reference it — so it cannot be changed here.
+
+### 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::FieldsApi.new
+id = 'id_example' # String | 
+opts = {
+  field_update_params: Norbelys::FieldUpdateParams.new # FieldUpdateParams | 
+}
+
+begin
+  # Update a field
+  result = api_instance.fields_update(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_update: #{e}"
+end
+```
+
+#### Using the fields_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Field>, Integer, Hash)> fields_update_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update a field
+  data, status_code, headers = api_instance.fields_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Field>
+rescue Norbelys::ApiError => e
+  puts "Error when calling FieldsApi->fields_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **field_update_params** | [**FieldUpdateParams**](FieldUpdateParams.md) |  | [optional] |
+
+### Return type
+
+[**Field**](Field.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FileObject.md

@@ -0,0 +1,28 @@
+# Norbelys::FileObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_type** | **String** | MIME type. Example: image/png |  |
+| **filename** | **String** | The sanitized file name. Example: logo.png |  |
+| **id** | **String** | The file id. |  |
+| **object** | **Object** |  |  |
+| **size** | **Integer** | Decoded size in bytes. Example: 24680 |  |
+| **url** | **String** | The permanent public URL. |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::FileObject.new(
+  content_type: null,
+  filename: null,
+  id: null,
+  object: null,
+  size: null,
+  url: null
+)
+```
+

data/docs/FileUpload.md

@@ -0,0 +1,22 @@
+# Norbelys::FileUpload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | Base64-encoded file content (max 8 MB decoded). Example: iVBORw0KGgoAAAANSUhEUgAA… |  |
+| **content_type** | **String** | MIME type — an `image/*` type or `application/pdf`. Example: image/png |  |
+| **filename** | **String** | Original file name — kept (sanitized) as the URL's last segment. Example: logo.png |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::FileUpload.new(
+  content: null,
+  content_type: null,
+  filename: null
+)
+```
+

data/docs/FilesApi.md

@@ -0,0 +1,81 @@
+# Norbelys::FilesApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**files_create**](FilesApi.md#files_create) | **POST** /files | Upload a public file |
+
+
+## files_create
+
+> <FileObject> files_create(file_upload, opts)
+
+Upload a public file
+
+Upload one image or PDF (Base64, max 8 MB decoded) to the public files bucket. Returns the permanent public URL — embed it in email HTML (signature images, campaign bodies, linked PDFs). The URL contains an unguessable id, is never listed, and is served with no search indexing.
+
+### 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::FilesApi.new
+file_upload = Norbelys::FileUpload.new({content: 'content_example', content_type: 'content_type_example', filename: 'filename_example'}) # FileUpload | 
+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
+  # Upload a public file
+  result = api_instance.files_create(file_upload, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling FilesApi->files_create: #{e}"
+end
+```
+
+#### Using the files_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FileObject>, Integer, Hash)> files_create_with_http_info(file_upload, opts)
+
+```ruby
+begin
+  # Upload a public file
+  data, status_code, headers = api_instance.files_create_with_http_info(file_upload, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileObject>
+rescue Norbelys::ApiError => e
+  puts "Error when calling FilesApi->files_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_upload** | [**FileUpload**](FileUpload.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
+
+[**FileObject**](FileObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Group.md

@@ -0,0 +1,34 @@
+# Norbelys::Group
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived_at** | **Object** |  | [optional] |
+| **color** | **String** |  |  |
+| **created_at** | **Object** |  | [optional] |
+| **description** | **String** |  |  |
+| **id** | **String** | The group id. |  |
+| **member_count** | **Integer** | Number of active people currently in the group. |  |
+| **name** | **String** | The group's display name. |  |
+| **object** | **Object** |  | [optional] |
+| **updated_at** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::Group.new(
+  archived_at: null,
+  color: null,
+  created_at: null,
+  description: null,
+  id: null,
+  member_count: null,
+  name: null,
+  object: null,
+  updated_at: null
+)
+```
+