zyphr 0.1.0

data/docs/TopicsApi.md

@@ -0,0 +1,670 @@
+# Zyphr::TopicsApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_topic_subscribers**](TopicsApi.md#add_topic_subscribers) | **POST** /topics/{key}/subscribers | Add subscribers to a topic |
+| [**create_topic**](TopicsApi.md#create_topic) | **POST** /topics | Create a new topic |
+| [**delete_topic**](TopicsApi.md#delete_topic) | **DELETE** /topics/{key} | Delete a topic |
+| [**get_topic**](TopicsApi.md#get_topic) | **GET** /topics/{key} | Get a topic |
+| [**get_topic_stats**](TopicsApi.md#get_topic_stats) | **GET** /topics/stats | Get topic statistics |
+| [**list_topic_subscribers**](TopicsApi.md#list_topic_subscribers) | **GET** /topics/{key}/subscribers | List topic subscribers |
+| [**list_topics**](TopicsApi.md#list_topics) | **GET** /topics | List topics |
+| [**remove_topic_subscribers**](TopicsApi.md#remove_topic_subscribers) | **DELETE** /topics/{key}/subscribers | Remove subscribers from a topic |
+| [**update_topic**](TopicsApi.md#update_topic) | **PATCH** /topics/{key} | Update a topic |
+
+
+## add_topic_subscribers
+
+> <TopicSubscribersAddResponse> add_topic_subscribers(key, add_topic_subscribers_request)
+
+Add subscribers to a topic
+
+Add one or more subscribers to a topic. Maximum 1000 subscriber IDs per request.
+
+### 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::TopicsApi.new
+key = 'key_example' # String | The unique topic key
+add_topic_subscribers_request = Zyphr::AddTopicSubscribersRequest.new({subscriber_ids: ['subscriber_ids_example']}) # AddTopicSubscribersRequest | 
+
+begin
+  # Add subscribers to a topic
+  result = api_instance.add_topic_subscribers(key, add_topic_subscribers_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->add_topic_subscribers: #{e}"
+end
+```
+
+#### Using the add_topic_subscribers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicSubscribersAddResponse>, Integer, Hash)> add_topic_subscribers_with_http_info(key, add_topic_subscribers_request)
+
+```ruby
+begin
+  # Add subscribers to a topic
+  data, status_code, headers = api_instance.add_topic_subscribers_with_http_info(key, add_topic_subscribers_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicSubscribersAddResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->add_topic_subscribers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The unique topic key |  |
+| **add_topic_subscribers_request** | [**AddTopicSubscribersRequest**](AddTopicSubscribersRequest.md) |  |  |
+
+### Return type
+
+[**TopicSubscribersAddResponse**](TopicSubscribersAddResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_topic
+
+> <TopicResponse> create_topic(create_topic_request)
+
+Create a new topic
+
+Create a new notification topic for broadcasting to groups of 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::TopicsApi.new
+create_topic_request = Zyphr::CreateTopicRequest.new({key: 'product-updates', name: 'Product Updates'}) # CreateTopicRequest | 
+
+begin
+  # Create a new topic
+  result = api_instance.create_topic(create_topic_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->create_topic: #{e}"
+end
+```
+
+#### Using the create_topic_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicResponse>, Integer, Hash)> create_topic_with_http_info(create_topic_request)
+
+```ruby
+begin
+  # Create a new topic
+  data, status_code, headers = api_instance.create_topic_with_http_info(create_topic_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->create_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_topic_request** | [**CreateTopicRequest**](CreateTopicRequest.md) |  |  |
+
+### Return type
+
+[**TopicResponse**](TopicResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_topic
+
+> <TopicDeleteResponse> delete_topic(key)
+
+Delete a topic
+
+Delete a topic by its unique key. This cascades to all subscriptions.
+
+### 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::TopicsApi.new
+key = 'key_example' # String | The unique topic key
+
+begin
+  # Delete a topic
+  result = api_instance.delete_topic(key)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->delete_topic: #{e}"
+end
+```
+
+#### Using the delete_topic_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicDeleteResponse>, Integer, Hash)> delete_topic_with_http_info(key)
+
+```ruby
+begin
+  # Delete a topic
+  data, status_code, headers = api_instance.delete_topic_with_http_info(key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicDeleteResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->delete_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The unique topic key |  |
+
+### Return type
+
+[**TopicDeleteResponse**](TopicDeleteResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_topic
+
+> <TopicResponse> get_topic(key)
+
+Get a topic
+
+Retrieve a specific topic by its unique key.
+
+### 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::TopicsApi.new
+key = 'key_example' # String | The unique topic key
+
+begin
+  # Get a topic
+  result = api_instance.get_topic(key)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->get_topic: #{e}"
+end
+```
+
+#### Using the get_topic_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicResponse>, Integer, Hash)> get_topic_with_http_info(key)
+
+```ruby
+begin
+  # Get a topic
+  data, status_code, headers = api_instance.get_topic_with_http_info(key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->get_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The unique topic key |  |
+
+### Return type
+
+[**TopicResponse**](TopicResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_topic_stats
+
+> <TopicStatsResponse> get_topic_stats
+
+Get topic statistics
+
+Get aggregate statistics for all topics in the workspace.
+
+### 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::TopicsApi.new
+
+begin
+  # Get topic statistics
+  result = api_instance.get_topic_stats
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->get_topic_stats: #{e}"
+end
+```
+
+#### Using the get_topic_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicStatsResponse>, Integer, Hash)> get_topic_stats_with_http_info
+
+```ruby
+begin
+  # Get topic statistics
+  data, status_code, headers = api_instance.get_topic_stats_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicStatsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->get_topic_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TopicStatsResponse**](TopicStatsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_topic_subscribers
+
+> <TopicSubscriberListResponse> list_topic_subscribers(key, opts)
+
+List topic subscribers
+
+List all subscribers for a specific topic with pagination.
+
+### 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::TopicsApi.new
+key = 'key_example' # String | The unique topic key
+opts = {
+  page: 56, # Integer | Page number
+  per_page: 56 # Integer | Items per page (max 1000)
+}
+
+begin
+  # List topic subscribers
+  result = api_instance.list_topic_subscribers(key, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->list_topic_subscribers: #{e}"
+end
+```
+
+#### Using the list_topic_subscribers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicSubscriberListResponse>, Integer, Hash)> list_topic_subscribers_with_http_info(key, opts)
+
+```ruby
+begin
+  # List topic subscribers
+  data, status_code, headers = api_instance.list_topic_subscribers_with_http_info(key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicSubscriberListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->list_topic_subscribers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The unique topic key |  |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page (max 1000) | [optional][default to 100] |
+
+### Return type
+
+[**TopicSubscriberListResponse**](TopicSubscriberListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_topics
+
+> <TopicListResponse> list_topics(opts)
+
+List topics
+
+List all topics for the workspace with pagination and optional search.
+
+### 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::TopicsApi.new
+opts = {
+  page: 56, # Integer | Page number
+  per_page: 56, # Integer | Items per page (max 100)
+  search: 'search_example' # String | Search topics by name or key
+}
+
+begin
+  # List topics
+  result = api_instance.list_topics(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->list_topics: #{e}"
+end
+```
+
+#### Using the list_topics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicListResponse>, Integer, Hash)> list_topics_with_http_info(opts)
+
+```ruby
+begin
+  # List topics
+  data, status_code, headers = api_instance.list_topics_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->list_topics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page (max 100) | [optional][default to 25] |
+| **search** | **String** | Search topics by name or key | [optional] |
+
+### Return type
+
+[**TopicListResponse**](TopicListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_topic_subscribers
+
+> <TopicSubscribersRemoveResponse> remove_topic_subscribers(key, remove_topic_subscribers_request)
+
+Remove subscribers from a topic
+
+Remove one or more subscribers from a topic. Maximum 1000 subscriber IDs per request.
+
+### 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::TopicsApi.new
+key = 'key_example' # String | The unique topic key
+remove_topic_subscribers_request = Zyphr::RemoveTopicSubscribersRequest.new({subscriber_ids: ['subscriber_ids_example']}) # RemoveTopicSubscribersRequest | 
+
+begin
+  # Remove subscribers from a topic
+  result = api_instance.remove_topic_subscribers(key, remove_topic_subscribers_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->remove_topic_subscribers: #{e}"
+end
+```
+
+#### Using the remove_topic_subscribers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicSubscribersRemoveResponse>, Integer, Hash)> remove_topic_subscribers_with_http_info(key, remove_topic_subscribers_request)
+
+```ruby
+begin
+  # Remove subscribers from a topic
+  data, status_code, headers = api_instance.remove_topic_subscribers_with_http_info(key, remove_topic_subscribers_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicSubscribersRemoveResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->remove_topic_subscribers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The unique topic key |  |
+| **remove_topic_subscribers_request** | [**RemoveTopicSubscribersRequest**](RemoveTopicSubscribersRequest.md) |  |  |
+
+### Return type
+
+[**TopicSubscribersRemoveResponse**](TopicSubscribersRemoveResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_topic
+
+> <TopicResponse> update_topic(key, update_topic_request)
+
+Update a topic
+
+Update a topic's name or description by its unique key.
+
+### 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::TopicsApi.new
+key = 'key_example' # String | The unique topic key
+update_topic_request = Zyphr::UpdateTopicRequest.new # UpdateTopicRequest | 
+
+begin
+  # Update a topic
+  result = api_instance.update_topic(key, update_topic_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->update_topic: #{e}"
+end
+```
+
+#### Using the update_topic_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopicResponse>, Integer, Hash)> update_topic_with_http_info(key, update_topic_request)
+
+```ruby
+begin
+  # Update a topic
+  data, status_code, headers = api_instance.update_topic_with_http_info(key, update_topic_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopicResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling TopicsApi->update_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The unique topic key |  |
+| **update_topic_request** | [**UpdateTopicRequest**](UpdateTopicRequest.md) |  |  |
+
+### Return type
+
+[**TopicResponse**](TopicResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UnreadCountData.md

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

data/docs/UnreadCountResponse.md

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