zyphr 0.1.0

data/docs/PushApi.md

@@ -0,0 +1,674 @@
+# Zyphr::PushApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_push**](PushApi.md#get_push) | **GET** /push/{id} | Get push notification details |
+| [**get_push_stats**](PushApi.md#get_push_stats) | **GET** /push/stats | Get push notification statistics |
+| [**list_device_push_topics**](PushApi.md#list_device_push_topics) | **GET** /push/devices/{id}/topics | List topics for a device |
+| [**list_push**](PushApi.md#list_push) | **GET** /push | List push notifications |
+| [**list_push_topic_devices**](PushApi.md#list_push_topic_devices) | **GET** /push/topics/{key}/devices | List devices subscribed to a topic |
+| [**send_push**](PushApi.md#send_push) | **POST** /push | Send a push notification |
+| [**send_push_to_topic**](PushApi.md#send_push_to_topic) | **POST** /push/topics/{key}/send | Send push notification to a topic |
+| [**subscribe_push_topic**](PushApi.md#subscribe_push_topic) | **POST** /push/topics/{key}/subscribe | Subscribe devices to a push topic |
+| [**unsubscribe_push_topic**](PushApi.md#unsubscribe_push_topic) | **POST** /push/topics/{key}/unsubscribe | Unsubscribe devices from a push topic |
+
+
+## get_push
+
+> <PushDetailResponse> get_push(id)
+
+Get push notification details
+
+Get a specific push notification message with delivery events.
+
+### 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::PushApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get push notification details
+  result = api_instance.get_push(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->get_push: #{e}"
+end
+```
+
+#### Using the get_push_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PushDetailResponse>, Integer, Hash)> get_push_with_http_info(id)
+
+```ruby
+begin
+  # Get push notification details
+  data, status_code, headers = api_instance.get_push_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PushDetailResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->get_push_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**PushDetailResponse**](PushDetailResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_push_stats
+
+> <PushStatsResponse> get_push_stats
+
+Get push notification statistics
+
+Get aggregated push notification statistics for 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::PushApi.new
+
+begin
+  # Get push notification statistics
+  result = api_instance.get_push_stats
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->get_push_stats: #{e}"
+end
+```
+
+#### Using the get_push_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PushStatsResponse>, Integer, Hash)> get_push_stats_with_http_info
+
+```ruby
+begin
+  # Get push notification statistics
+  data, status_code, headers = api_instance.get_push_stats_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PushStatsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->get_push_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PushStatsResponse**](PushStatsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_device_push_topics
+
+> <DevicePushTopicListResponse> list_device_push_topics(id)
+
+List topics for a device
+
+Get all push notification topics a specific device is subscribed to.
+
+### 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::PushApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Device ID
+
+begin
+  # List topics for a device
+  result = api_instance.list_device_push_topics(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->list_device_push_topics: #{e}"
+end
+```
+
+#### Using the list_device_push_topics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DevicePushTopicListResponse>, Integer, Hash)> list_device_push_topics_with_http_info(id)
+
+```ruby
+begin
+  # List topics for a device
+  data, status_code, headers = api_instance.list_device_push_topics_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DevicePushTopicListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->list_device_push_topics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Device ID |  |
+
+### Return type
+
+[**DevicePushTopicListResponse**](DevicePushTopicListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_push
+
+> <PushListResponse> list_push(opts)
+
+List push notifications
+
+List push notification messages for the workspace with optional filtering.
+
+### 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::PushApi.new
+opts = {
+  user_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter by subscriber/user ID
+  device_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter by device ID
+  status: 'pending', # String | Filter by message status
+  limit: 56, # Integer | Maximum number of results
+  offset: 56 # Integer | Number of results to skip
+}
+
+begin
+  # List push notifications
+  result = api_instance.list_push(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->list_push: #{e}"
+end
+```
+
+#### Using the list_push_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PushListResponse>, Integer, Hash)> list_push_with_http_info(opts)
+
+```ruby
+begin
+  # List push notifications
+  data, status_code, headers = api_instance.list_push_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PushListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->list_push_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | Filter by subscriber/user ID | [optional] |
+| **device_id** | **String** | Filter by device ID | [optional] |
+| **status** | **String** | Filter by message status | [optional] |
+| **limit** | **Integer** | Maximum number of results | [optional][default to 50] |
+| **offset** | **Integer** | Number of results to skip | [optional][default to 0] |
+
+### Return type
+
+[**PushListResponse**](PushListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_push_topic_devices
+
+> <PushTopicDeviceListResponse> list_push_topic_devices(key, opts)
+
+List devices subscribed to a topic
+
+Get all devices subscribed to a push notification 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::PushApi.new
+key = 'key_example' # String | Topic key
+opts = {
+  limit: 56, # Integer | Maximum number of results
+  offset: 56 # Integer | Number of results to skip
+}
+
+begin
+  # List devices subscribed to a topic
+  result = api_instance.list_push_topic_devices(key, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->list_push_topic_devices: #{e}"
+end
+```
+
+#### Using the list_push_topic_devices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PushTopicDeviceListResponse>, Integer, Hash)> list_push_topic_devices_with_http_info(key, opts)
+
+```ruby
+begin
+  # List devices subscribed to a topic
+  data, status_code, headers = api_instance.list_push_topic_devices_with_http_info(key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PushTopicDeviceListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->list_push_topic_devices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Topic key |  |
+| **limit** | **Integer** | Maximum number of results | [optional][default to 100] |
+| **offset** | **Integer** | Number of results to skip | [optional][default to 0] |
+
+### Return type
+
+[**PushTopicDeviceListResponse**](PushTopicDeviceListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## send_push
+
+> <SendPushResponse> send_push(send_push_request)
+
+Send a push notification
+
+Send a push notification to a specific device, multiple devices, all devices for a subscriber, or to a topic. Supports scheduling via `send_at` or `delay`. 
+
+### 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::PushApi.new
+send_push_request = Zyphr::SendPushRequest.new({payload: Zyphr::PushPayload.new({title: 'New Message', body: 'You have a new notification'})}) # SendPushRequest | 
+
+begin
+  # Send a push notification
+  result = api_instance.send_push(send_push_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->send_push: #{e}"
+end
+```
+
+#### Using the send_push_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendPushResponse>, Integer, Hash)> send_push_with_http_info(send_push_request)
+
+```ruby
+begin
+  # Send a push notification
+  data, status_code, headers = api_instance.send_push_with_http_info(send_push_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendPushResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->send_push_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_push_request** | [**SendPushRequest**](SendPushRequest.md) |  |  |
+
+### Return type
+
+[**SendPushResponse**](SendPushResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_push_to_topic
+
+> <SendPushToTopicResponse> send_push_to_topic(key, send_push_to_topic_request)
+
+Send push notification to a topic
+
+Send a push notification to all devices subscribed to a topic.
+
+### 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::PushApi.new
+key = 'key_example' # String | Topic key
+send_push_to_topic_request = Zyphr::SendPushToTopicRequest.new # SendPushToTopicRequest | 
+
+begin
+  # Send push notification to a topic
+  result = api_instance.send_push_to_topic(key, send_push_to_topic_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->send_push_to_topic: #{e}"
+end
+```
+
+#### Using the send_push_to_topic_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendPushToTopicResponse>, Integer, Hash)> send_push_to_topic_with_http_info(key, send_push_to_topic_request)
+
+```ruby
+begin
+  # Send push notification to a topic
+  data, status_code, headers = api_instance.send_push_to_topic_with_http_info(key, send_push_to_topic_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendPushToTopicResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->send_push_to_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Topic key |  |
+| **send_push_to_topic_request** | [**SendPushToTopicRequest**](SendPushToTopicRequest.md) |  |  |
+
+### Return type
+
+[**SendPushToTopicResponse**](SendPushToTopicResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## subscribe_push_topic
+
+> <PushTopicSubscribeResponse> subscribe_push_topic(key, subscribe_push_topic_request)
+
+Subscribe devices to a push topic
+
+Subscribe one or more devices to a push notification topic. Maximum 100 devices 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::PushApi.new
+key = 'key_example' # String | Topic key
+subscribe_push_topic_request = Zyphr::SubscribePushTopicRequest.new({device_ids: ['device_ids_example']}) # SubscribePushTopicRequest | 
+
+begin
+  # Subscribe devices to a push topic
+  result = api_instance.subscribe_push_topic(key, subscribe_push_topic_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->subscribe_push_topic: #{e}"
+end
+```
+
+#### Using the subscribe_push_topic_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PushTopicSubscribeResponse>, Integer, Hash)> subscribe_push_topic_with_http_info(key, subscribe_push_topic_request)
+
+```ruby
+begin
+  # Subscribe devices to a push topic
+  data, status_code, headers = api_instance.subscribe_push_topic_with_http_info(key, subscribe_push_topic_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PushTopicSubscribeResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->subscribe_push_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Topic key |  |
+| **subscribe_push_topic_request** | [**SubscribePushTopicRequest**](SubscribePushTopicRequest.md) |  |  |
+
+### Return type
+
+[**PushTopicSubscribeResponse**](PushTopicSubscribeResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## unsubscribe_push_topic
+
+> <PushTopicUnsubscribeResponse> unsubscribe_push_topic(key, subscribe_push_topic_request)
+
+Unsubscribe devices from a push topic
+
+Unsubscribe one or more devices from a push notification topic. Maximum 100 devices 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::PushApi.new
+key = 'key_example' # String | Topic key
+subscribe_push_topic_request = Zyphr::SubscribePushTopicRequest.new({device_ids: ['device_ids_example']}) # SubscribePushTopicRequest | 
+
+begin
+  # Unsubscribe devices from a push topic
+  result = api_instance.unsubscribe_push_topic(key, subscribe_push_topic_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->unsubscribe_push_topic: #{e}"
+end
+```
+
+#### Using the unsubscribe_push_topic_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PushTopicUnsubscribeResponse>, Integer, Hash)> unsubscribe_push_topic_with_http_info(key, subscribe_push_topic_request)
+
+```ruby
+begin
+  # Unsubscribe devices from a push topic
+  data, status_code, headers = api_instance.unsubscribe_push_topic_with_http_info(key, subscribe_push_topic_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PushTopicUnsubscribeResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling PushApi->unsubscribe_push_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Topic key |  |
+| **subscribe_push_topic_request** | [**SubscribePushTopicRequest**](SubscribePushTopicRequest.md) |  |  |
+
+### Return type
+
+[**PushTopicUnsubscribeResponse**](PushTopicUnsubscribeResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PushDetailResponse.md

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

data/docs/PushEvent.md

@@ -0,0 +1,28 @@
+# Zyphr::PushEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **event_type** | **String** |  | [optional] |
+| **provider** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+| **event_timestamp** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::PushEvent.new(
+  id: null,
+  event_type: null,
+  provider: null,
+  error_code: null,
+  error_message: null,
+  event_timestamp: null
+)
+```
+