zyphr 0.1.41 → 0.1.43

data/docs/InboxApi.md

@@ -103,7 +103,7 @@ end
 
 ## archive_subscriber_notification
 
-> archive_subscriber_notification(id)
+> <GetSubscriberNotification200Response> archive_subscriber_notification(id)
 
 Archive a notification
 
@@ -123,7 +123,8 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Archive a notification
-  api_instance.archive_subscriber_notification(id)
+  result = api_instance.archive_subscriber_notification(id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->archive_subscriber_notification: #{e}"
 end
@@ -131,9 +132,9 @@ end
 
 #### Using the archive_subscriber_notification_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)> archive_subscriber_notification_with_http_info(id)
+> <Array(<GetSubscriberNotification200Response>, Integer, Hash)> archive_subscriber_notification_with_http_info(id)
 
 ```ruby
 begin
@@ -141,7 +142,7 @@ begin
   data, status_code, headers = api_instance.archive_subscriber_notification_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetSubscriberNotification200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->archive_subscriber_notification_with_http_info: #{e}"
 end
@@ -155,7 +156,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetSubscriberNotification200Response**](GetSubscriberNotification200Response.md)
 
 ### Authorization
 
@@ -164,7 +165,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## delete_inbox_notification
@@ -315,7 +316,7 @@ nil (empty response body)
 
 Generate a subscriber token
 
-Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
 
 ### Examples
 
@@ -459,7 +460,7 @@ end
 
 ## get_subscriber_inbox_preferences
 
-> get_subscriber_inbox_preferences
+> <GetSubscriberInboxPreferences200Response> get_subscriber_inbox_preferences
 
 Get subscriber preferences
 
@@ -480,7 +481,8 @@ api_instance = Zyphr::InboxApi.new
 
 begin
   # Get subscriber preferences
-  api_instance.get_subscriber_inbox_preferences
+  result = api_instance.get_subscriber_inbox_preferences
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->get_subscriber_inbox_preferences: #{e}"
 end
@@ -488,9 +490,9 @@ end
 
 #### Using the get_subscriber_inbox_preferences_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_subscriber_inbox_preferences_with_http_info
+> <Array(<GetSubscriberInboxPreferences200Response>, Integer, Hash)> get_subscriber_inbox_preferences_with_http_info
 
 ```ruby
 begin
@@ -498,7 +500,7 @@ begin
   data, status_code, headers = api_instance.get_subscriber_inbox_preferences_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetSubscriberInboxPreferences200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->get_subscriber_inbox_preferences_with_http_info: #{e}"
 end
@@ -510,7 +512,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-nil (empty response body)
+[**GetSubscriberInboxPreferences200Response**](GetSubscriberInboxPreferences200Response.md)
 
 ### Authorization
 
@@ -519,12 +521,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## get_subscriber_notification
 
-> get_subscriber_notification(id)
+> <GetSubscriberNotification200Response> get_subscriber_notification(id)
 
 Get a notification
 
@@ -546,7 +548,8 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Get a notification
-  api_instance.get_subscriber_notification(id)
+  result = api_instance.get_subscriber_notification(id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->get_subscriber_notification: #{e}"
 end
@@ -554,9 +557,9 @@ end
 
 #### Using the get_subscriber_notification_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_subscriber_notification_with_http_info(id)
+> <Array(<GetSubscriberNotification200Response>, Integer, Hash)> get_subscriber_notification_with_http_info(id)
 
 ```ruby
 begin
@@ -564,7 +567,7 @@ begin
   data, status_code, headers = api_instance.get_subscriber_notification_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetSubscriberNotification200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->get_subscriber_notification_with_http_info: #{e}"
 end
@@ -578,7 +581,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetSubscriberNotification200Response**](GetSubscriberNotification200Response.md)
 
 ### Authorization
 
@@ -587,12 +590,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## get_subscriber_unread_count
 
-> get_subscriber_unread_count
+> <GetSubscriberUnreadCount200Response> get_subscriber_unread_count
 
 Get unread count
 
@@ -613,7 +616,8 @@ api_instance = Zyphr::InboxApi.new
 
 begin
   # Get unread count
-  api_instance.get_subscriber_unread_count
+  result = api_instance.get_subscriber_unread_count
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->get_subscriber_unread_count: #{e}"
 end
@@ -621,9 +625,9 @@ end
 
 #### Using the get_subscriber_unread_count_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_subscriber_unread_count_with_http_info
+> <Array(<GetSubscriberUnreadCount200Response>, Integer, Hash)> get_subscriber_unread_count_with_http_info
 
 ```ruby
 begin
@@ -631,7 +635,7 @@ begin
   data, status_code, headers = api_instance.get_subscriber_unread_count_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetSubscriberUnreadCount200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->get_subscriber_unread_count_with_http_info: #{e}"
 end
@@ -643,7 +647,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-nil (empty response body)
+[**GetSubscriberUnreadCount200Response**](GetSubscriberUnreadCount200Response.md)
 
 ### Authorization
 
@@ -652,7 +656,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## get_unread_count
@@ -732,7 +736,7 @@ end
 
 ## list_all_inbox
 
-> list_all_inbox(opts)
+> <InboxListResponse> list_all_inbox(opts)
 
 List all project notifications
 
@@ -763,7 +767,8 @@ opts = {
 
 begin
   # List all project notifications
-  api_instance.list_all_inbox(opts)
+  result = api_instance.list_all_inbox(opts)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->list_all_inbox: #{e}"
 end
@@ -771,9 +776,9 @@ end
 
 #### Using the list_all_inbox_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_all_inbox_with_http_info(opts)
+> <Array(<InboxListResponse>, Integer, Hash)> list_all_inbox_with_http_info(opts)
 
 ```ruby
 begin
@@ -781,7 +786,7 @@ begin
   data, status_code, headers = api_instance.list_all_inbox_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <InboxListResponse>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->list_all_inbox_with_http_info: #{e}"
 end
@@ -800,7 +805,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**InboxListResponse**](InboxListResponse.md)
 
 ### Authorization
 
@@ -809,7 +814,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## list_inbox
@@ -901,7 +906,7 @@ end
 
 ## list_subscriber_notifications
 
-> list_subscriber_notifications(opts)
+> <InboxListResponse> list_subscriber_notifications(opts)
 
 List subscriber notifications
 
@@ -929,7 +934,8 @@ opts = {
 
 begin
   # List subscriber notifications
-  api_instance.list_subscriber_notifications(opts)
+  result = api_instance.list_subscriber_notifications(opts)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->list_subscriber_notifications: #{e}"
 end
@@ -937,9 +943,9 @@ end
 
 #### Using the list_subscriber_notifications_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_subscriber_notifications_with_http_info(opts)
+> <Array(<InboxListResponse>, Integer, Hash)> list_subscriber_notifications_with_http_info(opts)
 
 ```ruby
 begin
@@ -947,7 +953,7 @@ begin
   data, status_code, headers = api_instance.list_subscriber_notifications_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <InboxListResponse>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->list_subscriber_notifications_with_http_info: #{e}"
 end
@@ -965,7 +971,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**InboxListResponse**](InboxListResponse.md)
 
 ### Authorization
 
@@ -974,7 +980,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## mark_all_inbox_read
@@ -1050,7 +1056,7 @@ end
 
 ## mark_all_subscriber_notifications_read
 
-> mark_all_subscriber_notifications_read(opts)
+> <MarkAllSubscriberNotificationsRead200Response> mark_all_subscriber_notifications_read(opts)
 
 Mark all notifications as read
 
@@ -1072,7 +1078,8 @@ opts = {
 
 begin
   # Mark all notifications as read
-  api_instance.mark_all_subscriber_notifications_read(opts)
+  result = api_instance.mark_all_subscriber_notifications_read(opts)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->mark_all_subscriber_notifications_read: #{e}"
 end
@@ -1080,9 +1087,9 @@ end
 
 #### Using the mark_all_subscriber_notifications_read_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)> mark_all_subscriber_notifications_read_with_http_info(opts)
+> <Array(<MarkAllSubscriberNotificationsRead200Response>, Integer, Hash)> mark_all_subscriber_notifications_read_with_http_info(opts)
 
 ```ruby
 begin
@@ -1090,7 +1097,7 @@ begin
   data, status_code, headers = api_instance.mark_all_subscriber_notifications_read_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <MarkAllSubscriberNotificationsRead200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->mark_all_subscriber_notifications_read_with_http_info: #{e}"
 end
@@ -1104,7 +1111,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**MarkAllSubscriberNotificationsRead200Response**](MarkAllSubscriberNotificationsRead200Response.md)
 
 ### Authorization
 
@@ -1113,7 +1120,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## mark_inbox_read
@@ -1193,7 +1200,7 @@ end
 
 ## mark_subscriber_notification_read
 
-> mark_subscriber_notification_read(id)
+> <GetSubscriberNotification200Response> mark_subscriber_notification_read(id)
 
 Mark notification as read
 
@@ -1213,7 +1220,8 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Mark notification as read
-  api_instance.mark_subscriber_notification_read(id)
+  result = api_instance.mark_subscriber_notification_read(id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->mark_subscriber_notification_read: #{e}"
 end
@@ -1221,9 +1229,9 @@ end
 
 #### Using the mark_subscriber_notification_read_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)> mark_subscriber_notification_read_with_http_info(id)
+> <Array(<GetSubscriberNotification200Response>, Integer, Hash)> mark_subscriber_notification_read_with_http_info(id)
 
 ```ruby
 begin
@@ -1231,7 +1239,7 @@ begin
   data, status_code, headers = api_instance.mark_subscriber_notification_read_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetSubscriberNotification200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->mark_subscriber_notification_read_with_http_info: #{e}"
 end
@@ -1245,7 +1253,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetSubscriberNotification200Response**](GetSubscriberNotification200Response.md)
 
 ### Authorization
 
@@ -1254,7 +1262,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## send_batch_in_app
@@ -1401,7 +1409,7 @@ end
 
 ## update_subscriber_preferences
 
-> update_subscriber_preferences(update_subscriber_preferences_request)
+> <UpdateSubscriberPreferences200Response> update_subscriber_preferences(update_subscriber_preferences_request)
 
 Update subscriber preferences
 
@@ -1423,7 +1431,8 @@ update_subscriber_preferences_request = Zyphr::UpdateSubscriberPreferencesReques
 
 begin
   # Update subscriber preferences
-  api_instance.update_subscriber_preferences(update_subscriber_preferences_request)
+  result = api_instance.update_subscriber_preferences(update_subscriber_preferences_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->update_subscriber_preferences: #{e}"
 end
@@ -1431,9 +1440,9 @@ end
 
 #### Using the update_subscriber_preferences_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_subscriber_preferences_with_http_info(update_subscriber_preferences_request)
+> <Array(<UpdateSubscriberPreferences200Response>, Integer, Hash)> update_subscriber_preferences_with_http_info(update_subscriber_preferences_request)
 
 ```ruby
 begin
@@ -1441,7 +1450,7 @@ begin
   data, status_code, headers = api_instance.update_subscriber_preferences_with_http_info(update_subscriber_preferences_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <UpdateSubscriberPreferences200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling InboxApi->update_subscriber_preferences_with_http_info: #{e}"
 end
@@ -1455,7 +1464,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**UpdateSubscriberPreferences200Response**](UpdateSubscriberPreferences200Response.md)
 
 ### Authorization
 
@@ -1464,5 +1473,5 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 

data/docs/InviteEndUser200Response.md

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

data/docs/InviteEndUser200ResponseData.md

@@ -0,0 +1,22 @@
+# Zyphr::InviteEndUser200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  | [optional] |
+| **created** | **Boolean** | True when a new user was provisioned; false when an existing user was reused (idempotent on email). | [optional] |
+| **link_sent** | **Boolean** | True when a magic-link or password-reset email was successfully dispatched. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InviteEndUser200ResponseData.new(
+  user_id: null,
+  created: null,
+  link_sent: null
+)
+```
+

data/docs/ListEndUsers200Response.md

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

data/docs/{ListWorkflowExecutions200ResponseMeta.md → ListEndUsers200ResponseMeta.md}

@@ -1,4 +1,4 @@
-# Zyphr::ListWorkflowExecutions200ResponseMeta
+# Zyphr::ListEndUsers200ResponseMeta
 
 ## Properties
 
@@ -15,7 +15,7 @@
 ```ruby
 require 'zyphr'
 
-instance = Zyphr::ListWorkflowExecutions200ResponseMeta.new(
+instance = Zyphr::ListEndUsers200ResponseMeta.new(
   request_id: null,
   page: null,
   per_page: null,

data/docs/ListWorkflowExecutions200Response.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **data** | [**Array<WorkflowExecution>**](WorkflowExecution.md) |  | [optional] |
-| **meta** | [**ListWorkflowExecutions200ResponseMeta**](ListWorkflowExecutions200ResponseMeta.md) |  | [optional] |
+| **meta** | [**ListEndUsers200ResponseMeta**](ListEndUsers200ResponseMeta.md) |  | [optional] |
 
 ## Example
 

data/docs/MarkAllSubscriberNotificationsRead200Response.md

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

data/docs/RotateWaaSEndpointSecret200Response.md

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

data/docs/RotateWaaSEndpointSecret200ResponseData.md

@@ -0,0 +1,18 @@
+# Zyphr::RotateWaaSEndpointSecret200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **secret** | **String** | The newly generated signing secret. Returned only on rotation. |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::RotateWaaSEndpointSecret200ResponseData.new(
+  secret: null
+)
+```
+

data/docs/SendTemplateTestEmail202Response.md

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