zyphr 0.1.42 → 0.1.44

data/docs/AuthUserDirectoryApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**delete_end_user_by_application**](AuthUserDirectoryApi.md#delete_end_user_by_application) | **DELETE** /auth/users/{user_id} | Delete an end user (server-side admin) |
+| [**get_end_user_auth_methods**](AuthUserDirectoryApi.md#get_end_user_auth_methods) | **GET** /auth/users/{user_id}/auth-methods | Get an end user's sign-in methods (server-side admin) |
 | [**get_end_user_by_email**](AuthUserDirectoryApi.md#get_end_user_by_email) | **GET** /auth/users/by-email | Look up an end user by email (server-side admin) |
 | [**get_end_user_by_id**](AuthUserDirectoryApi.md#get_end_user_by_id) | **GET** /auth/users/{user_id} | Get an end user by id (server-side admin) |
 | [**get_end_user_claims**](AuthUserDirectoryApi.md#get_end_user_claims) | **GET** /auth/users/{user_id}/claims | Get an end user's stored custom claims (server-side admin) |
@@ -89,9 +90,85 @@ nil (empty response body)
 - **Accept**: Not defined
 
 
+## get_end_user_auth_methods
+
+> <GetEndUserAuthMethods200Response> get_end_user_auth_methods(user_id)
+
+Get an end user's sign-in methods (server-side admin)
+
+Secret-key-scoped, aggregate view of the sign-in methods configured for a single end user within the authenticating application. Reports whether the user has a password, which OAuth providers are linked, whether MFA is enabled, whether email/phone are verified, and how many passkeys are registered — everything a customer admin needs to build a \"sign-in methods\" screen. Scoped to the application — a caller can never read a user belonging to another application. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthUserDirectoryApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get an end user's sign-in methods (server-side admin)
+  result = api_instance.get_end_user_auth_methods(user_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthUserDirectoryApi->get_end_user_auth_methods: #{e}"
+end
+```
+
+#### Using the get_end_user_auth_methods_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetEndUserAuthMethods200Response>, Integer, Hash)> get_end_user_auth_methods_with_http_info(user_id)
+
+```ruby
+begin
+  # Get an end user's sign-in methods (server-side admin)
+  data, status_code, headers = api_instance.get_end_user_auth_methods_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetEndUserAuthMethods200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthUserDirectoryApi->get_end_user_auth_methods_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+
+### Return type
+
+[**GetEndUserAuthMethods200Response**](GetEndUserAuthMethods200Response.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_end_user_by_email
 
-> get_end_user_by_email(email)
+> <GetEndUserById200Response> get_end_user_by_email(email)
 
 Look up an end user by email (server-side admin)
 
@@ -120,7 +197,8 @@ email = 'email_example' # String |
 
 begin
   # Look up an end user by email (server-side admin)
-  api_instance.get_end_user_by_email(email)
+  result = api_instance.get_end_user_by_email(email)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->get_end_user_by_email: #{e}"
 end
@@ -128,9 +206,9 @@ end
 
 #### Using the get_end_user_by_email_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_end_user_by_email_with_http_info(email)
+> <Array(<GetEndUserById200Response>, Integer, Hash)> get_end_user_by_email_with_http_info(email)
 
 ```ruby
 begin
@@ -138,7 +216,7 @@ begin
   data, status_code, headers = api_instance.get_end_user_by_email_with_http_info(email)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetEndUserById200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->get_end_user_by_email_with_http_info: #{e}"
 end
@@ -152,7 +230,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetEndUserById200Response**](GetEndUserById200Response.md)
 
 ### Authorization
 
@@ -161,12 +239,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## get_end_user_by_id
 
-> get_end_user_by_id(user_id)
+> <GetEndUserById200Response> get_end_user_by_id(user_id)
 
 Get an end user by id (server-side admin)
 
@@ -195,7 +273,8 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Get an end user by id (server-side admin)
-  api_instance.get_end_user_by_id(user_id)
+  result = api_instance.get_end_user_by_id(user_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->get_end_user_by_id: #{e}"
 end
@@ -203,9 +282,9 @@ end
 
 #### Using the get_end_user_by_id_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_end_user_by_id_with_http_info(user_id)
+> <Array(<GetEndUserById200Response>, Integer, Hash)> get_end_user_by_id_with_http_info(user_id)
 
 ```ruby
 begin
@@ -213,7 +292,7 @@ begin
   data, status_code, headers = api_instance.get_end_user_by_id_with_http_info(user_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetEndUserById200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->get_end_user_by_id_with_http_info: #{e}"
 end
@@ -227,7 +306,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetEndUserById200Response**](GetEndUserById200Response.md)
 
 ### Authorization
 
@@ -236,12 +315,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## get_end_user_claims
 
-> get_end_user_claims(user_id)
+> <GetEndUserClaims200Response> get_end_user_claims(user_id)
 
 Get an end user's stored custom claims (server-side admin)
 
@@ -270,7 +349,8 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Get an end user's stored custom claims (server-side admin)
-  api_instance.get_end_user_claims(user_id)
+  result = api_instance.get_end_user_claims(user_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->get_end_user_claims: #{e}"
 end
@@ -278,9 +358,9 @@ end
 
 #### Using the get_end_user_claims_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_end_user_claims_with_http_info(user_id)
+> <Array(<GetEndUserClaims200Response>, Integer, Hash)> get_end_user_claims_with_http_info(user_id)
 
 ```ruby
 begin
@@ -288,7 +368,7 @@ begin
   data, status_code, headers = api_instance.get_end_user_claims_with_http_info(user_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetEndUserClaims200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->get_end_user_claims_with_http_info: #{e}"
 end
@@ -302,7 +382,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetEndUserClaims200Response**](GetEndUserClaims200Response.md)
 
 ### Authorization
 
@@ -311,12 +391,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## invite_end_user
 
-> invite_end_user(invite_end_user_request)
+> <InviteEndUser200Response> invite_end_user(invite_end_user_request)
 
 Pre-provision (invite) an end user (server-side admin)
 
@@ -345,7 +425,8 @@ invite_end_user_request = Zyphr::InviteEndUserRequest.new({email: 'email_example
 
 begin
   # Pre-provision (invite) an end user (server-side admin)
-  api_instance.invite_end_user(invite_end_user_request)
+  result = api_instance.invite_end_user(invite_end_user_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->invite_end_user: #{e}"
 end
@@ -353,9 +434,9 @@ end
 
 #### Using the invite_end_user_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> invite_end_user_with_http_info(invite_end_user_request)
+> <Array(<InviteEndUser200Response>, Integer, Hash)> invite_end_user_with_http_info(invite_end_user_request)
 
 ```ruby
 begin
@@ -363,7 +444,7 @@ begin
   data, status_code, headers = api_instance.invite_end_user_with_http_info(invite_end_user_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <InviteEndUser200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->invite_end_user_with_http_info: #{e}"
 end
@@ -377,7 +458,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**InviteEndUser200Response**](InviteEndUser200Response.md)
 
 ### Authorization
 
@@ -386,12 +467,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## list_end_users
 
-> list_end_users(opts)
+> <ListEndUsers200Response> list_end_users(opts)
 
 List / search end users (server-side admin)
 
@@ -425,7 +506,8 @@ opts = {
 
 begin
   # List / search end users (server-side admin)
-  api_instance.list_end_users(opts)
+  result = api_instance.list_end_users(opts)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->list_end_users: #{e}"
 end
@@ -433,9 +515,9 @@ end
 
 #### Using the list_end_users_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> list_end_users_with_http_info(opts)
+> <Array(<ListEndUsers200Response>, Integer, Hash)> list_end_users_with_http_info(opts)
 
 ```ruby
 begin
@@ -443,7 +525,7 @@ begin
   data, status_code, headers = api_instance.list_end_users_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <ListEndUsers200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->list_end_users_with_http_info: #{e}"
 end
@@ -460,7 +542,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**ListEndUsers200Response**](ListEndUsers200Response.md)
 
 ### Authorization
 
@@ -469,7 +551,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## set_end_user_claims
@@ -552,7 +634,7 @@ end
 
 ## update_end_user_by_application
 
-> update_end_user_by_application(user_id, update_end_user_by_application_request)
+> <GetEndUserById200Response> update_end_user_by_application(user_id, update_end_user_by_application_request)
 
 Update an end user (server-side admin)
 
@@ -582,7 +664,8 @@ update_end_user_by_application_request = Zyphr::UpdateEndUserByApplicationReques
 
 begin
   # Update an end user (server-side admin)
-  api_instance.update_end_user_by_application(user_id, update_end_user_by_application_request)
+  result = api_instance.update_end_user_by_application(user_id, update_end_user_by_application_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->update_end_user_by_application: #{e}"
 end
@@ -590,9 +673,9 @@ end
 
 #### Using the update_end_user_by_application_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request)
+> <Array(<GetEndUserById200Response>, Integer, Hash)> update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request)
 
 ```ruby
 begin
@@ -600,7 +683,7 @@ begin
   data, status_code, headers = api_instance.update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetEndUserById200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->update_end_user_by_application_with_http_info: #{e}"
 end
@@ -615,7 +698,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetEndUserById200Response**](GetEndUserById200Response.md)
 
 ### Authorization
 
@@ -624,5 +707,5 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 

data/docs/CloseWaaSEndpointCircuit200Response.md

@@ -0,0 +1,20 @@
+# Zyphr::CloseWaaSEndpointCircuit200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CloseWaaSEndpointCircuit200ResponseData**](CloseWaaSEndpointCircuit200ResponseData.md) |  | [optional] |
+| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::CloseWaaSEndpointCircuit200Response.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/CloseWaaSEndpointCircuit200ResponseData.md

@@ -0,0 +1,18 @@
+# Zyphr::CloseWaaSEndpointCircuit200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::CloseWaaSEndpointCircuit200ResponseData.new(
+  state: null
+)
+```
+

data/docs/DomainsApi.md

@@ -367,7 +367,7 @@ This endpoint does not need any parameter.
 
 ## set_domain_inbound
 
-> set_domain_inbound(id, set_domain_inbound_request)
+> <GetDomain200Response> set_domain_inbound(id, set_domain_inbound_request)
 
 Enable or disable inbound email for a domain
 
@@ -392,7 +392,8 @@ set_domain_inbound_request = Zyphr::SetDomainInboundRequest.new # SetDomainInbou
 
 begin
   # Enable or disable inbound email for a domain
-  api_instance.set_domain_inbound(id, set_domain_inbound_request)
+  result = api_instance.set_domain_inbound(id, set_domain_inbound_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling DomainsApi->set_domain_inbound: #{e}"
 end
@@ -400,9 +401,9 @@ end
 
 #### Using the set_domain_inbound_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> set_domain_inbound_with_http_info(id, set_domain_inbound_request)
+> <Array(<GetDomain200Response>, Integer, Hash)> set_domain_inbound_with_http_info(id, set_domain_inbound_request)
 
 ```ruby
 begin
@@ -410,7 +411,7 @@ begin
   data, status_code, headers = api_instance.set_domain_inbound_with_http_info(id, set_domain_inbound_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetDomain200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling DomainsApi->set_domain_inbound_with_http_info: #{e}"
 end
@@ -425,7 +426,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetDomain200Response**](GetDomain200Response.md)
 
 ### Authorization
 
@@ -434,7 +435,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## verify_domain

data/docs/GetEndUserAuthMethods200Response.md

@@ -0,0 +1,20 @@
+# Zyphr::GetEndUserAuthMethods200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**AuthMethods**](AuthMethods.md) |  | [optional] |
+| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetEndUserAuthMethods200Response.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/GetEndUserById200Response.md

@@ -0,0 +1,20 @@
+# Zyphr::GetEndUserById200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**AuthUser**](AuthUser.md) |  | [optional] |
+| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetEndUserById200Response.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/GetEndUserClaims200Response.md

@@ -0,0 +1,20 @@
+# Zyphr::GetEndUserClaims200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**GetEndUserClaims200ResponseData**](GetEndUserClaims200ResponseData.md) |  | [optional] |
+| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetEndUserClaims200Response.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/GetEndUserClaims200ResponseData.md

@@ -0,0 +1,18 @@
+# Zyphr::GetEndUserClaims200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **claims** | **Hash<String, Object>** | Stored custom_claims for the user; empty object when none are set. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetEndUserClaims200ResponseData.new(
+  claims: null
+)
+```
+

data/docs/GetSubscriberInboxPreferences200Response.md

@@ -0,0 +1,18 @@
+# Zyphr::GetSubscriberInboxPreferences200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**GetSubscriberInboxPreferences200ResponseData**](GetSubscriberInboxPreferences200ResponseData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetSubscriberInboxPreferences200Response.new(
+  data: null
+)
+```
+

data/docs/GetSubscriberInboxPreferences200ResponseData.md

@@ -0,0 +1,20 @@
+# Zyphr::GetSubscriberInboxPreferences200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **global** | [**GetSubscriberInboxPreferences200ResponseDataGlobal**](GetSubscriberInboxPreferences200ResponseDataGlobal.md) |  | [optional] |
+| **categories** | [**Array<GetSubscriberInboxPreferences200ResponseDataCategoriesInner>**](GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetSubscriberInboxPreferences200ResponseData.new(
+  global: null,
+  categories: null
+)
+```
+

data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.md

@@ -0,0 +1,20 @@
+# Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | [**GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory**](GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md) |  | [optional] |
+| **channels** | [**Array<GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner>**](GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInner.new(
+  category: null,
+  channels: null
+)
+```
+

data/docs/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.md

@@ -0,0 +1,26 @@
+# Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **slug** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **allow_unsubscribe** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.new(
+  id: null,
+  name: null,
+  slug: null,
+  description: null,
+  allow_unsubscribe: null
+)
+```
+