norbelys 0.1.0

data/docs/PeopleApi.md

@@ -0,0 +1,681 @@
+# Norbelys::PeopleApi
+
+All URIs are relative to *https://api.norbelys.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**people_archive**](PeopleApi.md#people_archive) | **DELETE** /people/{id} | Archive a person |
+| [**people_audience_summary**](PeopleApi.md#people_audience_summary) | **GET** /people/audience-summary | Get audience summary |
+| [**people_bulk_create**](PeopleApi.md#people_bulk_create) | **POST** /people/bulk | Bulk create people (verifies + suppresses in the background; optional group / campaign) |
+| [**people_create**](PeopleApi.md#people_create) | **POST** /people | Create a person |
+| [**people_erase**](PeopleApi.md#people_erase) | **POST** /people/{id}/erase | Erase a person (GDPR) |
+| [**people_find**](PeopleApi.md#people_find) | **GET** /people/{id} | Get a person |
+| [**people_get_bulk**](PeopleApi.md#people_get_bulk) | **GET** /people/bulk/{id} | Get a bulk import's verify stats (sendable / suppressed / pending) |
+| [**people_list**](PeopleApi.md#people_list) | **GET** /people | List people |
+| [**people_update**](PeopleApi.md#people_update) | **PATCH** /people/{id} | Update a person |
+
+
+## people_archive
+
+> <Person> people_archive(id)
+
+Archive a person
+
+### 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::PeopleApi.new
+id = 'id_example' # String | 
+
+begin
+  # Archive a person
+  result = api_instance.people_archive(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_archive: #{e}"
+end
+```
+
+#### Using the people_archive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Person>, Integer, Hash)> people_archive_with_http_info(id)
+
+```ruby
+begin
+  # Archive a person
+  data, status_code, headers = api_instance.people_archive_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Person>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_archive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Person**](Person.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## people_audience_summary
+
+> <AudienceSummary> people_audience_summary(scope, opts)
+
+Get audience summary
+
+Summarize the whole workspace, one group, or one segment: exact people total, lifecycle mix, recent engagement, average score, and a 12-week audience-arrival series.
+
+### 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::PeopleApi.new
+scope = TODO # AnyOf | 
+opts = {
+  group_id: 'group_id_example', # String | 
+  segment_id: 'segment_id_example' # String | 
+}
+
+begin
+  # Get audience summary
+  result = api_instance.people_audience_summary(scope, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_audience_summary: #{e}"
+end
+```
+
+#### Using the people_audience_summary_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AudienceSummary>, Integer, Hash)> people_audience_summary_with_http_info(scope, opts)
+
+```ruby
+begin
+  # Get audience summary
+  data, status_code, headers = api_instance.people_audience_summary_with_http_info(scope, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AudienceSummary>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_audience_summary_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scope** | [**AnyOf**](.md) |  |  |
+| **group_id** | **String** |  | [optional] |
+| **segment_id** | **String** |  | [optional] |
+
+### Return type
+
+[**AudienceSummary**](AudienceSummary.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## people_bulk_create
+
+> <PeopleBulkCreateResult> people_bulk_create(people_bulk_create_params, opts)
+
+Bulk create people (verifies + suppresses in the background; optional group / campaign)
+
+### 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::PeopleApi.new
+people_bulk_create_params = Norbelys::PeopleBulkCreateParams.new({people: [Norbelys::PersonImportItem.new({email: 'email_example'})]}) # PeopleBulkCreateParams | 
+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
+  # Bulk create people (verifies + suppresses in the background; optional group / campaign)
+  result = api_instance.people_bulk_create(people_bulk_create_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_bulk_create: #{e}"
+end
+```
+
+#### Using the people_bulk_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PeopleBulkCreateResult>, Integer, Hash)> people_bulk_create_with_http_info(people_bulk_create_params, opts)
+
+```ruby
+begin
+  # Bulk create people (verifies + suppresses in the background; optional group / campaign)
+  data, status_code, headers = api_instance.people_bulk_create_with_http_info(people_bulk_create_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PeopleBulkCreateResult>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_bulk_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **people_bulk_create_params** | [**PeopleBulkCreateParams**](PeopleBulkCreateParams.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
+
+[**PeopleBulkCreateResult**](PeopleBulkCreateResult.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## people_create
+
+> <Person> people_create(person_create_params, opts)
+
+Create a person
+
+Add one person (a lead) to the CRM. `email` is required; anything beyond the system fields rides in `customFields` keyed by code. To insert many at once, use bulkCreate instead.
+
+### 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::PeopleApi.new
+person_create_params = Norbelys::PersonCreateParams.new({email: 'email_example'}) # PersonCreateParams | 
+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 person
+  result = api_instance.people_create(person_create_params, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_create: #{e}"
+end
+```
+
+#### Using the people_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Person>, Integer, Hash)> people_create_with_http_info(person_create_params, opts)
+
+```ruby
+begin
+  # Create a person
+  data, status_code, headers = api_instance.people_create_with_http_info(person_create_params, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Person>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **person_create_params** | [**PersonCreateParams**](PersonCreateParams.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
+
+[**Person**](Person.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## people_erase
+
+> <PersonErased> people_erase(id, opts)
+
+Erase a person (GDPR)
+
+Permanently scrub this person's PII and redact their inbound messages — the ONE true hard delete (distinct from archive/DELETE, which only soft-archives and keeps the data). Irreversible; use for a GDPR erasure request.
+
+### 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::PeopleApi.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
+  # Erase a person (GDPR)
+  result = api_instance.people_erase(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_erase: #{e}"
+end
+```
+
+#### Using the people_erase_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PersonErased>, Integer, Hash)> people_erase_with_http_info(id, opts)
+
+```ruby
+begin
+  # Erase a person (GDPR)
+  data, status_code, headers = api_instance.people_erase_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PersonErased>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_erase_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
+
+[**PersonErased**](PersonErased.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## people_find
+
+> <PersonDetail> people_find(id, opts)
+
+Get a person
+
+Read one person. Pass `expand[]=timeline` for their merged sent/received messages, `expand[]=enrollments` for campaign memberships, `expand[]=groups` for their static lists, and/or `expand[]=segments` for dynamic audiences they currently match.
+
+### 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::PeopleApi.new
+id = 'id_example' # String | 
+opts = {
+  expand: [['timeline']] # Array<String> | 
+}
+
+begin
+  # Get a person
+  result = api_instance.people_find(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_find: #{e}"
+end
+```
+
+#### Using the people_find_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PersonDetail>, Integer, Hash)> people_find_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get a person
+  data, status_code, headers = api_instance.people_find_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PersonDetail>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_find_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **expand** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+
+### Return type
+
+[**PersonDetail**](PersonDetail.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## people_get_bulk
+
+> <PersonImportStats> people_get_bulk(id)
+
+Get a bulk import's verify stats (sendable / suppressed / pending)
+
+### 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::PeopleApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a bulk import's verify stats (sendable / suppressed / pending)
+  result = api_instance.people_get_bulk(id)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_get_bulk: #{e}"
+end
+```
+
+#### Using the people_get_bulk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PersonImportStats>, Integer, Hash)> people_get_bulk_with_http_info(id)
+
+```ruby
+begin
+  # Get a bulk import's verify stats (sendable / suppressed / pending)
+  data, status_code, headers = api_instance.people_get_bulk_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PersonImportStats>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_get_bulk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**PersonImportStats**](PersonImportStats.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## people_list
+
+> <PersonList> people_list(opts)
+
+List people
+
+List the org's people (its CRM leads); `total` is the full match count. Filter by status, source, group, or segment, or pass a live `filter` rule tree to preview a draft segment. Cursor callers remain newest-first; page-based callers can sort by creation, name, email, last activity, or engagement score.
+
+### 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::PeopleApi.new
+opts = {
+  cursor: 'cursor_example', # String | 
+  include_archived: true, # Boolean | 
+  dir: 'asc', # String | 
+  filter: Norbelys::AudienceFilter.new, # AudienceFilter | 
+  group_id: 'group_id_example', # String | 
+  limit: 56, # Integer | 
+  page: 56, # Integer | 
+  search: 'search_example', # String | 
+  segment_id: 'segment_id_example', # String | 
+  sort: 'created_at', # String | 
+  source: [['csv_import']], # Array<String> | 
+  status: [['active']] # Array<String> | 
+}
+
+begin
+  # List people
+  result = api_instance.people_list(opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_list: #{e}"
+end
+```
+
+#### Using the people_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PersonList>, Integer, Hash)> people_list_with_http_info(opts)
+
+```ruby
+begin
+  # List people
+  data, status_code, headers = api_instance.people_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PersonList>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **include_archived** | **Boolean** |  | [optional] |
+| **dir** | **String** |  | [optional] |
+| **filter** | [**AudienceFilter**](.md) |  | [optional] |
+| **group_id** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **search** | **String** |  | [optional] |
+| **segment_id** | **String** |  | [optional] |
+| **sort** | **String** |  | [optional] |
+| **source** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **status** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+
+### Return type
+
+[**PersonList**](PersonList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## people_update
+
+> <PersonDetail> people_update(id, opts)
+
+Update a person
+
+Patch a person's editable fields; only the fields you send change. Note that `customFields` replaces the entire custom-field bag — send the full set, not a partial delta.
+
+### 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::PeopleApi.new
+id = 'id_example' # String | 
+opts = {
+  person_update_params: Norbelys::PersonUpdateParams.new # PersonUpdateParams | 
+}
+
+begin
+  # Update a person
+  result = api_instance.people_update(id, opts)
+  p result
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_update: #{e}"
+end
+```
+
+#### Using the people_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PersonDetail>, Integer, Hash)> people_update_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update a person
+  data, status_code, headers = api_instance.people_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PersonDetail>
+rescue Norbelys::ApiError => e
+  puts "Error when calling PeopleApi->people_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **person_update_params** | [**PersonUpdateParams**](PersonUpdateParams.md) |  | [optional] |
+
+### Return type
+
+[**PersonDetail**](PersonDetail.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PeopleBulkCreateParams.md

@@ -0,0 +1,28 @@
+# Norbelys::PeopleBulkCreateParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign_ids** | **Array<String>** | Optional campaigns to enroll every imported person into — both newly created people and already-existing matches. Several allowed; a draft campaign holds them until launch. | [optional] |
+| **default_country** | **String** | ISO 3166-1 alpha-2 country used to normalize NATIONAL phone numbers to E.164 — e.g. `CO` turns `3163586947` into `+573163586947`. A number that already carries its country code (`+57…`) ignores this. | [optional] |
+| **group_ids** | **Array<String>** | Optional static groups (lists) to add every imported person to — new AND already-existing matches. Several allowed. | [optional] |
+| **import_id** | **String** | Optional import id you supply to GROUP several chunked calls into ONE import (so the stats at `GET /v1/people/bulk/{importId}` cover the whole upload). Generated automatically when omitted. | [optional] |
+| **on_conflict** | **String** | What to do when a person with this email already exists. `fill` (default): update the existing person, only filling fields that are currently empty — never overwrites existing values. `overwrite`: the uploaded values win for every field they provide. `skip`: leave the existing person untouched. | [optional][default to 'fill'] |
+| **people** | [**Array<PersonImportItem>**](PersonImportItem.md) | Up to 10,000 people to insert (data + custom fields); duplicate emails are skipped and malformed emails are rejected (both non-fatal — see `skipped` / `rejected`). |  |
+
+## Example
+
+```ruby
+require 'norbelys'
+
+instance = Norbelys::PeopleBulkCreateParams.new(
+  campaign_ids: null,
+  default_country: null,
+  group_ids: null,
+  import_id: null,
+  on_conflict: null,
+  people: null
+)
+```
+