zyphr 0.1.0

data/docs/SubscribersApi.md

@@ -0,0 +1,1450 @@
+# Zyphr::SubscribersApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_category**](SubscribersApi.md#create_category) | **POST** /subscribers/categories | Create a notification category |
+| [**create_subscriber**](SubscribersApi.md#create_subscriber) | **POST** /subscribers | Create or update a subscriber |
+| [**delete_category**](SubscribersApi.md#delete_category) | **DELETE** /subscribers/categories/{id} | Delete a category |
+| [**delete_subscriber**](SubscribersApi.md#delete_subscriber) | **DELETE** /subscribers/{id} | Delete a subscriber |
+| [**get_category**](SubscribersApi.md#get_category) | **GET** /subscribers/categories/{idOrSlug} | Get a category by ID or slug |
+| [**get_subscriber**](SubscribersApi.md#get_subscriber) | **GET** /subscribers/{id} | Get a subscriber by ID |
+| [**get_subscriber_by_external_id**](SubscribersApi.md#get_subscriber_by_external_id) | **GET** /subscribers/by-external-id/{externalId} | Get subscriber by external ID |
+| [**get_subscriber_consent**](SubscribersApi.md#get_subscriber_consent) | **GET** /subscribers/{id}/consent | Get subscriber consent status |
+| [**get_subscriber_consent_history**](SubscribersApi.md#get_subscriber_consent_history) | **GET** /subscribers/{id}/consent/history | Get subscriber consent history |
+| [**get_subscriber_preferences**](SubscribersApi.md#get_subscriber_preferences) | **GET** /subscribers/{id}/preferences | Get subscriber preferences |
+| [**get_subscriber_unsubscribes**](SubscribersApi.md#get_subscriber_unsubscribes) | **GET** /subscribers/{id}/unsubscribes | Get subscriber unsubscribes |
+| [**list_categories**](SubscribersApi.md#list_categories) | **GET** /subscribers/categories | List notification categories |
+| [**list_subscribers**](SubscribersApi.md#list_subscribers) | **GET** /subscribers | List subscribers |
+| [**record_subscriber_consent**](SubscribersApi.md#record_subscriber_consent) | **POST** /subscribers/{id}/consent | Record subscriber consent |
+| [**resubscribe_subscriber**](SubscribersApi.md#resubscribe_subscriber) | **POST** /subscribers/{id}/resubscribe | Resubscribe to a channel |
+| [**set_subscriber_preferences**](SubscribersApi.md#set_subscriber_preferences) | **PUT** /subscribers/{id}/preferences | Set subscriber preferences |
+| [**unsubscribe_subscriber**](SubscribersApi.md#unsubscribe_subscriber) | **POST** /subscribers/{id}/unsubscribe | Unsubscribe from a channel |
+| [**update_category**](SubscribersApi.md#update_category) | **PATCH** /subscribers/categories/{id} | Update a category |
+| [**update_subscriber**](SubscribersApi.md#update_subscriber) | **PATCH** /subscribers/{id} | Update a subscriber |
+| [**withdraw_subscriber_consent**](SubscribersApi.md#withdraw_subscriber_consent) | **DELETE** /subscribers/{id}/consent | Withdraw subscriber consent |
+
+
+## create_category
+
+> <CategoryResponse> create_category(create_category_request)
+
+Create a notification category
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+create_category_request = Zyphr::CreateCategoryRequest.new({name: 'name_example', slug: 'slug_example', channels: ['channels_example']}) # CreateCategoryRequest | 
+
+begin
+  # Create a notification category
+  result = api_instance.create_category(create_category_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->create_category: #{e}"
+end
+```
+
+#### Using the create_category_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoryResponse>, Integer, Hash)> create_category_with_http_info(create_category_request)
+
+```ruby
+begin
+  # Create a notification category
+  data, status_code, headers = api_instance.create_category_with_http_info(create_category_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoryResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->create_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_category_request** | [**CreateCategoryRequest**](CreateCategoryRequest.md) |  |  |
+
+### Return type
+
+[**CategoryResponse**](CategoryResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_subscriber
+
+> <SubscriberResponse> create_subscriber(create_subscriber_request)
+
+Create or update a subscriber
+
+Upsert a subscriber by external_id. If a subscriber with the given external_id already exists, it will be updated.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+create_subscriber_request = Zyphr::CreateSubscriberRequest.new({external_id: 'user_123'}) # CreateSubscriberRequest | 
+
+begin
+  # Create or update a subscriber
+  result = api_instance.create_subscriber(create_subscriber_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->create_subscriber: #{e}"
+end
+```
+
+#### Using the create_subscriber_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriberResponse>, Integer, Hash)> create_subscriber_with_http_info(create_subscriber_request)
+
+```ruby
+begin
+  # Create or update a subscriber
+  data, status_code, headers = api_instance.create_subscriber_with_http_info(create_subscriber_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriberResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->create_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_subscriber_request** | [**CreateSubscriberRequest**](CreateSubscriberRequest.md) |  |  |
+
+### Return type
+
+[**SubscriberResponse**](SubscriberResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_category
+
+> delete_category(id)
+
+Delete a category
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a category
+  api_instance.delete_category(id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->delete_category: #{e}"
+end
+```
+
+#### Using the delete_category_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_category_with_http_info(id)
+
+```ruby
+begin
+  # Delete a category
+  data, status_code, headers = api_instance.delete_category_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->delete_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_subscriber
+
+> delete_subscriber(id)
+
+Delete a subscriber
+
+Soft-deletes a subscriber by setting status to deleted.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete a subscriber
+  api_instance.delete_subscriber(id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->delete_subscriber: #{e}"
+end
+```
+
+#### Using the delete_subscriber_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_subscriber_with_http_info(id)
+
+```ruby
+begin
+  # Delete a subscriber
+  data, status_code, headers = api_instance.delete_subscriber_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->delete_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_category
+
+> <CategoryResponse> get_category(id_or_slug)
+
+Get a category by ID or slug
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id_or_slug = 'id_or_slug_example' # String | 
+
+begin
+  # Get a category by ID or slug
+  result = api_instance.get_category(id_or_slug)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_category: #{e}"
+end
+```
+
+#### Using the get_category_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoryResponse>, Integer, Hash)> get_category_with_http_info(id_or_slug)
+
+```ruby
+begin
+  # Get a category by ID or slug
+  data, status_code, headers = api_instance.get_category_with_http_info(id_or_slug)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoryResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_or_slug** | **String** |  |  |
+
+### Return type
+
+[**CategoryResponse**](CategoryResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriber
+
+> <SubscriberResponse> get_subscriber(id)
+
+Get a subscriber by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get a subscriber by ID
+  result = api_instance.get_subscriber(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber: #{e}"
+end
+```
+
+#### Using the get_subscriber_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriberResponse>, Integer, Hash)> get_subscriber_with_http_info(id)
+
+```ruby
+begin
+  # Get a subscriber by ID
+  data, status_code, headers = api_instance.get_subscriber_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriberResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**SubscriberResponse**](SubscriberResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriber_by_external_id
+
+> <SubscriberResponse> get_subscriber_by_external_id(external_id)
+
+Get subscriber by external ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+external_id = 'external_id_example' # String | 
+
+begin
+  # Get subscriber by external ID
+  result = api_instance.get_subscriber_by_external_id(external_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_by_external_id: #{e}"
+end
+```
+
+#### Using the get_subscriber_by_external_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriberResponse>, Integer, Hash)> get_subscriber_by_external_id_with_http_info(external_id)
+
+```ruby
+begin
+  # Get subscriber by external ID
+  data, status_code, headers = api_instance.get_subscriber_by_external_id_with_http_info(external_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriberResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_by_external_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** |  |  |
+
+### Return type
+
+[**SubscriberResponse**](SubscriberResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriber_consent
+
+> <ConsentStatusResponse> get_subscriber_consent(id)
+
+Get subscriber consent status
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get subscriber consent status
+  result = api_instance.get_subscriber_consent(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_consent: #{e}"
+end
+```
+
+#### Using the get_subscriber_consent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsentStatusResponse>, Integer, Hash)> get_subscriber_consent_with_http_info(id)
+
+```ruby
+begin
+  # Get subscriber consent status
+  data, status_code, headers = api_instance.get_subscriber_consent_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsentStatusResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_consent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**ConsentStatusResponse**](ConsentStatusResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriber_consent_history
+
+> <ConsentHistoryResponse> get_subscriber_consent_history(id, opts)
+
+Get subscriber consent history
+
+Returns paginated consent audit log for a subscriber.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  # Get subscriber consent history
+  result = api_instance.get_subscriber_consent_history(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_consent_history: #{e}"
+end
+```
+
+#### Using the get_subscriber_consent_history_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsentHistoryResponse>, Integer, Hash)> get_subscriber_consent_history_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get subscriber consent history
+  data, status_code, headers = api_instance.get_subscriber_consent_history_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsentHistoryResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_consent_history_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+[**ConsentHistoryResponse**](ConsentHistoryResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriber_preferences
+
+> <PreferenceListResponse> get_subscriber_preferences(id, opts)
+
+Get subscriber preferences
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  effective: true # Boolean | Return effective preferences (merged with category defaults)
+}
+
+begin
+  # Get subscriber preferences
+  result = api_instance.get_subscriber_preferences(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_preferences: #{e}"
+end
+```
+
+#### Using the get_subscriber_preferences_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreferenceListResponse>, Integer, Hash)> get_subscriber_preferences_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get subscriber preferences
+  data, status_code, headers = api_instance.get_subscriber_preferences_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreferenceListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_preferences_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **effective** | **Boolean** | Return effective preferences (merged with category defaults) | [optional] |
+
+### Return type
+
+[**PreferenceListResponse**](PreferenceListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriber_unsubscribes
+
+> <UnsubscribeListResponse> get_subscriber_unsubscribes(id)
+
+Get subscriber unsubscribes
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get subscriber unsubscribes
+  result = api_instance.get_subscriber_unsubscribes(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_unsubscribes: #{e}"
+end
+```
+
+#### Using the get_subscriber_unsubscribes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UnsubscribeListResponse>, Integer, Hash)> get_subscriber_unsubscribes_with_http_info(id)
+
+```ruby
+begin
+  # Get subscriber unsubscribes
+  data, status_code, headers = api_instance.get_subscriber_unsubscribes_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnsubscribeListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_unsubscribes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**UnsubscribeListResponse**](UnsubscribeListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_categories
+
+> <CategoryListResponse> list_categories
+
+List notification categories
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+
+begin
+  # List notification categories
+  result = api_instance.list_categories
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->list_categories: #{e}"
+end
+```
+
+#### Using the list_categories_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoryListResponse>, Integer, Hash)> list_categories_with_http_info
+
+```ruby
+begin
+  # List notification categories
+  data, status_code, headers = api_instance.list_categories_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoryListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->list_categories_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CategoryListResponse**](CategoryListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_subscribers
+
+> <SubscriberListResponse> list_subscribers(opts)
+
+List subscribers
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+opts = {
+  status: 'active', # String | 
+  email: 'email_example', # String | 
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  # List subscribers
+  result = api_instance.list_subscribers(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->list_subscribers: #{e}"
+end
+```
+
+#### Using the list_subscribers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriberListResponse>, Integer, Hash)> list_subscribers_with_http_info(opts)
+
+```ruby
+begin
+  # List subscribers
+  data, status_code, headers = api_instance.list_subscribers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriberListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->list_subscribers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+[**SubscriberListResponse**](SubscriberListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## record_subscriber_consent
+
+> <ConsentRecordResponse> record_subscriber_consent(id, body)
+
+Record subscriber consent
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+body = { ... } # Object | 
+
+begin
+  # Record subscriber consent
+  result = api_instance.record_subscriber_consent(id, body)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->record_subscriber_consent: #{e}"
+end
+```
+
+#### Using the record_subscriber_consent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsentRecordResponse>, Integer, Hash)> record_subscriber_consent_with_http_info(id, body)
+
+```ruby
+begin
+  # Record subscriber consent
+  data, status_code, headers = api_instance.record_subscriber_consent_with_http_info(id, body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsentRecordResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->record_subscriber_consent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **body** | **Object** |  |  |
+
+### Return type
+
+[**ConsentRecordResponse**](ConsentRecordResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## resubscribe_subscriber
+
+> <ResubscribeResponse> resubscribe_subscriber(id, opts)
+
+Resubscribe to a channel
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  resubscribe_request: Zyphr::ResubscribeRequest.new # ResubscribeRequest | 
+}
+
+begin
+  # Resubscribe to a channel
+  result = api_instance.resubscribe_subscriber(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->resubscribe_subscriber: #{e}"
+end
+```
+
+#### Using the resubscribe_subscriber_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResubscribeResponse>, Integer, Hash)> resubscribe_subscriber_with_http_info(id, opts)
+
+```ruby
+begin
+  # Resubscribe to a channel
+  data, status_code, headers = api_instance.resubscribe_subscriber_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResubscribeResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->resubscribe_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **resubscribe_request** | [**ResubscribeRequest**](ResubscribeRequest.md) |  | [optional] |
+
+### Return type
+
+[**ResubscribeResponse**](ResubscribeResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_subscriber_preferences
+
+> <PreferenceListResponse> set_subscriber_preferences(id, set_preferences_request)
+
+Set subscriber preferences
+
+Bulk set notification preferences for a subscriber.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+set_preferences_request = Zyphr::SetPreferencesRequest.new({preferences: [Zyphr::SetPreferencesRequestPreferencesInner.new]}) # SetPreferencesRequest | 
+
+begin
+  # Set subscriber preferences
+  result = api_instance.set_subscriber_preferences(id, set_preferences_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->set_subscriber_preferences: #{e}"
+end
+```
+
+#### Using the set_subscriber_preferences_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreferenceListResponse>, Integer, Hash)> set_subscriber_preferences_with_http_info(id, set_preferences_request)
+
+```ruby
+begin
+  # Set subscriber preferences
+  data, status_code, headers = api_instance.set_subscriber_preferences_with_http_info(id, set_preferences_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreferenceListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->set_subscriber_preferences_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **set_preferences_request** | [**SetPreferencesRequest**](SetPreferencesRequest.md) |  |  |
+
+### Return type
+
+[**PreferenceListResponse**](PreferenceListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## unsubscribe_subscriber
+
+> <UnsubscribeResponse> unsubscribe_subscriber(id, opts)
+
+Unsubscribe from a channel
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  unsubscribe_request: Zyphr::UnsubscribeRequest.new # UnsubscribeRequest | 
+}
+
+begin
+  # Unsubscribe from a channel
+  result = api_instance.unsubscribe_subscriber(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->unsubscribe_subscriber: #{e}"
+end
+```
+
+#### Using the unsubscribe_subscriber_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UnsubscribeResponse>, Integer, Hash)> unsubscribe_subscriber_with_http_info(id, opts)
+
+```ruby
+begin
+  # Unsubscribe from a channel
+  data, status_code, headers = api_instance.unsubscribe_subscriber_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnsubscribeResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->unsubscribe_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **unsubscribe_request** | [**UnsubscribeRequest**](UnsubscribeRequest.md) |  | [optional] |
+
+### Return type
+
+[**UnsubscribeResponse**](UnsubscribeResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_category
+
+> <CategoryResponse> update_category(id, update_category_request)
+
+Update a category
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = 'id_example' # String | 
+update_category_request = Zyphr::UpdateCategoryRequest.new # UpdateCategoryRequest | 
+
+begin
+  # Update a category
+  result = api_instance.update_category(id, update_category_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->update_category: #{e}"
+end
+```
+
+#### Using the update_category_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoryResponse>, Integer, Hash)> update_category_with_http_info(id, update_category_request)
+
+```ruby
+begin
+  # Update a category
+  data, status_code, headers = api_instance.update_category_with_http_info(id, update_category_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoryResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->update_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_category_request** | [**UpdateCategoryRequest**](UpdateCategoryRequest.md) |  |  |
+
+### Return type
+
+[**CategoryResponse**](CategoryResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_subscriber
+
+> <SubscriberResponse> update_subscriber(id, update_subscriber_request)
+
+Update a subscriber
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+update_subscriber_request = Zyphr::UpdateSubscriberRequest.new # UpdateSubscriberRequest | 
+
+begin
+  # Update a subscriber
+  result = api_instance.update_subscriber(id, update_subscriber_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->update_subscriber: #{e}"
+end
+```
+
+#### Using the update_subscriber_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriberResponse>, Integer, Hash)> update_subscriber_with_http_info(id, update_subscriber_request)
+
+```ruby
+begin
+  # Update a subscriber
+  data, status_code, headers = api_instance.update_subscriber_with_http_info(id, update_subscriber_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriberResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->update_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_subscriber_request** | [**UpdateSubscriberRequest**](UpdateSubscriberRequest.md) |  |  |
+
+### Return type
+
+[**SubscriberResponse**](SubscriberResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## withdraw_subscriber_consent
+
+> <ConsentWithdrawResponse> withdraw_subscriber_consent(id, opts)
+
+Withdraw subscriber consent
+
+Withdraw consent for a subscriber (GDPR right to withdraw).
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::SubscribersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  withdraw_subscriber_consent_request: Zyphr::WithdrawSubscriberConsentRequest.new # WithdrawSubscriberConsentRequest | 
+}
+
+begin
+  # Withdraw subscriber consent
+  result = api_instance.withdraw_subscriber_consent(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->withdraw_subscriber_consent: #{e}"
+end
+```
+
+#### Using the withdraw_subscriber_consent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsentWithdrawResponse>, Integer, Hash)> withdraw_subscriber_consent_with_http_info(id, opts)
+
+```ruby
+begin
+  # Withdraw subscriber consent
+  data, status_code, headers = api_instance.withdraw_subscriber_consent_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsentWithdrawResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SubscribersApi->withdraw_subscriber_consent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **withdraw_subscriber_consent_request** | [**WithdrawSubscriberConsentRequest**](WithdrawSubscriberConsentRequest.md) |  | [optional] |
+
+### Return type
+
+[**ConsentWithdrawResponse**](ConsentWithdrawResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+