zyphr 0.1.0

data/docs/InboxApi.md

@@ -0,0 +1,694 @@
+# Zyphr::InboxApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**archive_inbox_notification**](InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification |
+| [**delete_inbox_notification**](InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification |
+| [**get_inbox_notification**](InboxApi.md#get_inbox_notification) | **GET** /inbox/{id} | Get a notification |
+| [**get_unread_count**](InboxApi.md#get_unread_count) | **GET** /inbox/unread-count | Get unread notification count |
+| [**list_inbox**](InboxApi.md#list_inbox) | **GET** /inbox | List inbox notifications |
+| [**mark_all_inbox_read**](InboxApi.md#mark_all_inbox_read) | **POST** /inbox/read-all | Mark all notifications as read |
+| [**mark_inbox_read**](InboxApi.md#mark_inbox_read) | **POST** /inbox/{id}/read | Mark notification as read |
+| [**send_batch_in_app**](InboxApi.md#send_batch_in_app) | **POST** /inbox/send/batch | Send batch in-app notifications |
+| [**send_in_app**](InboxApi.md#send_in_app) | **POST** /inbox/send | Send an in-app notification |
+
+
+## archive_inbox_notification
+
+> <InboxNotificationResponse> archive_inbox_notification(id, opts)
+
+Archive a notification
+
+Archive a specific in-app notification.
+
+### 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::InboxApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  mark_inbox_read_request: Zyphr::MarkInboxReadRequest.new # MarkInboxReadRequest | 
+}
+
+begin
+  # Archive a notification
+  result = api_instance.archive_inbox_notification(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->archive_inbox_notification: #{e}"
+end
+```
+
+#### Using the archive_inbox_notification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxNotificationResponse>, Integer, Hash)> archive_inbox_notification_with_http_info(id, opts)
+
+```ruby
+begin
+  # Archive a notification
+  data, status_code, headers = api_instance.archive_inbox_notification_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxNotificationResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->archive_inbox_notification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **mark_inbox_read_request** | [**MarkInboxReadRequest**](MarkInboxReadRequest.md) |  | [optional] |
+
+### Return type
+
+[**InboxNotificationResponse**](InboxNotificationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_inbox_notification
+
+> delete_inbox_notification(id, opts)
+
+Delete a notification
+
+Permanently delete an in-app notification.
+
+### 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::InboxApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  subscriber_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | 
+  external_id: 'external_id_example' # String | 
+}
+
+begin
+  # Delete a notification
+  api_instance.delete_inbox_notification(id, opts)
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->delete_inbox_notification: #{e}"
+end
+```
+
+#### Using the delete_inbox_notification_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_inbox_notification_with_http_info(id, opts)
+
+```ruby
+begin
+  # Delete a notification
+  data, status_code, headers = api_instance.delete_inbox_notification_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->delete_inbox_notification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **subscriber_id** | **String** |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_inbox_notification
+
+> <InboxNotificationResponse> get_inbox_notification(id, opts)
+
+Get a notification
+
+Get a specific in-app notification 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::InboxApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  subscriber_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | 
+  external_id: 'external_id_example' # String | 
+}
+
+begin
+  # Get a notification
+  result = api_instance.get_inbox_notification(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->get_inbox_notification: #{e}"
+end
+```
+
+#### Using the get_inbox_notification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxNotificationResponse>, Integer, Hash)> get_inbox_notification_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get a notification
+  data, status_code, headers = api_instance.get_inbox_notification_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxNotificationResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->get_inbox_notification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **subscriber_id** | **String** |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+
+### Return type
+
+[**InboxNotificationResponse**](InboxNotificationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_unread_count
+
+> <UnreadCountResponse> get_unread_count(opts)
+
+Get unread notification count
+
+Get the count of unread in-app notifications 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::InboxApi.new
+opts = {
+  subscriber_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | 
+  external_id: 'external_id_example' # String | 
+}
+
+begin
+  # Get unread notification count
+  result = api_instance.get_unread_count(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->get_unread_count: #{e}"
+end
+```
+
+#### Using the get_unread_count_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UnreadCountResponse>, Integer, Hash)> get_unread_count_with_http_info(opts)
+
+```ruby
+begin
+  # Get unread notification count
+  data, status_code, headers = api_instance.get_unread_count_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnreadCountResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->get_unread_count_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscriber_id** | **String** |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+
+### Return type
+
+[**UnreadCountResponse**](UnreadCountResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_inbox
+
+> <InboxListResponse> list_inbox(opts)
+
+List inbox notifications
+
+Retrieve in-app notifications for a subscriber. Requires subscriber_id or 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::InboxApi.new
+opts = {
+  subscriber_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Subscriber ID
+  external_id: 'external_id_example', # String | Subscriber external ID
+  category: 'category_example', # String | Filter by notification category
+  include_read: true, # Boolean | 
+  include_archived: true, # Boolean | 
+  limit: 56, # Integer | 
+  offset: 56, # Integer | 
+  cursor: 'cursor_example' # String | Cursor for pagination
+}
+
+begin
+  # List inbox notifications
+  result = api_instance.list_inbox(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->list_inbox: #{e}"
+end
+```
+
+#### Using the list_inbox_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxListResponse>, Integer, Hash)> list_inbox_with_http_info(opts)
+
+```ruby
+begin
+  # List inbox notifications
+  data, status_code, headers = api_instance.list_inbox_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->list_inbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscriber_id** | **String** | Subscriber ID | [optional] |
+| **external_id** | **String** | Subscriber external ID | [optional] |
+| **category** | **String** | Filter by notification category | [optional] |
+| **include_read** | **Boolean** |  | [optional][default to false] |
+| **include_archived** | **Boolean** |  | [optional][default to false] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+| **cursor** | **String** | Cursor for pagination | [optional] |
+
+### Return type
+
+[**InboxListResponse**](InboxListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## mark_all_inbox_read
+
+> <MarkAllReadResponse> mark_all_inbox_read(mark_all_inbox_read_request)
+
+Mark all notifications as read
+
+Mark all unread in-app notifications as read for a subscriber. Optionally filter by 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::InboxApi.new
+mark_all_inbox_read_request = Zyphr::MarkAllInboxReadRequest.new # MarkAllInboxReadRequest | 
+
+begin
+  # Mark all notifications as read
+  result = api_instance.mark_all_inbox_read(mark_all_inbox_read_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->mark_all_inbox_read: #{e}"
+end
+```
+
+#### Using the mark_all_inbox_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MarkAllReadResponse>, Integer, Hash)> mark_all_inbox_read_with_http_info(mark_all_inbox_read_request)
+
+```ruby
+begin
+  # Mark all notifications as read
+  data, status_code, headers = api_instance.mark_all_inbox_read_with_http_info(mark_all_inbox_read_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MarkAllReadResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->mark_all_inbox_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mark_all_inbox_read_request** | [**MarkAllInboxReadRequest**](MarkAllInboxReadRequest.md) |  |  |
+
+### Return type
+
+[**MarkAllReadResponse**](MarkAllReadResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## mark_inbox_read
+
+> <InboxNotificationResponse> mark_inbox_read(id, opts)
+
+Mark notification as read
+
+Mark a specific in-app notification as read.
+
+### 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::InboxApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  mark_inbox_read_request: Zyphr::MarkInboxReadRequest.new # MarkInboxReadRequest | 
+}
+
+begin
+  # Mark notification as read
+  result = api_instance.mark_inbox_read(id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->mark_inbox_read: #{e}"
+end
+```
+
+#### Using the mark_inbox_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InboxNotificationResponse>, Integer, Hash)> mark_inbox_read_with_http_info(id, opts)
+
+```ruby
+begin
+  # Mark notification as read
+  data, status_code, headers = api_instance.mark_inbox_read_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InboxNotificationResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->mark_inbox_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **mark_inbox_read_request** | [**MarkInboxReadRequest**](MarkInboxReadRequest.md) |  | [optional] |
+
+### Return type
+
+[**InboxNotificationResponse**](InboxNotificationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_batch_in_app
+
+> <SendBatchInAppResponse> send_batch_in_app(send_batch_in_app_request)
+
+Send batch in-app notifications
+
+Send in-app notifications to multiple subscribers in a single request (max 100).
+
+### 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::InboxApi.new
+send_batch_in_app_request = Zyphr::SendBatchInAppRequest.new({notifications: [Zyphr::SendInAppRequest.new({subscriber_id: 'subscriber_id_example', title: 'New feature available!'})]}) # SendBatchInAppRequest | 
+
+begin
+  # Send batch in-app notifications
+  result = api_instance.send_batch_in_app(send_batch_in_app_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->send_batch_in_app: #{e}"
+end
+```
+
+#### Using the send_batch_in_app_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendBatchInAppResponse>, Integer, Hash)> send_batch_in_app_with_http_info(send_batch_in_app_request)
+
+```ruby
+begin
+  # Send batch in-app notifications
+  data, status_code, headers = api_instance.send_batch_in_app_with_http_info(send_batch_in_app_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendBatchInAppResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->send_batch_in_app_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_batch_in_app_request** | [**SendBatchInAppRequest**](SendBatchInAppRequest.md) |  |  |
+
+### Return type
+
+[**SendBatchInAppResponse**](SendBatchInAppResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_in_app
+
+> <SendInAppResponse> send_in_app(send_in_app_request)
+
+Send an in-app notification
+
+Create and deliver an in-app notification to a subscriber. Checks subscriber preferences before delivery.
+
+### 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::InboxApi.new
+send_in_app_request = Zyphr::SendInAppRequest.new({subscriber_id: 'subscriber_id_example', title: 'New feature available!'}) # SendInAppRequest | 
+
+begin
+  # Send an in-app notification
+  result = api_instance.send_in_app(send_in_app_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->send_in_app: #{e}"
+end
+```
+
+#### Using the send_in_app_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendInAppResponse>, Integer, Hash)> send_in_app_with_http_info(send_in_app_request)
+
+```ruby
+begin
+  # Send an in-app notification
+  data, status_code, headers = api_instance.send_in_app_with_http_info(send_in_app_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendInAppResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->send_in_app_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_in_app_request** | [**SendInAppRequest**](SendInAppRequest.md) |  |  |
+
+### Return type
+
+[**SendInAppResponse**](SendInAppResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/InboxListMeta.md

@@ -0,0 +1,28 @@
+# Zyphr::InboxListMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **unread_count** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **has_more** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::InboxListMeta.new(
+  total: null,
+  unread_count: null,
+  limit: null,
+  offset: null,
+  next_cursor: null,
+  has_more: null
+)
+```
+