zyphr 0.1.0

data/docs/DevicesApi.md

@@ -0,0 +1,444 @@
+# Zyphr::DevicesApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_device**](DevicesApi.md#delete_device) | **DELETE** /devices/{id} | Delete a device |
+| [**delete_user_devices**](DevicesApi.md#delete_user_devices) | **DELETE** /devices/user/{user_id} | Delete all devices for a user |
+| [**get_device**](DevicesApi.md#get_device) | **GET** /devices/{id} | Get device details |
+| [**get_device_stats**](DevicesApi.md#get_device_stats) | **GET** /devices/stats | Get device statistics |
+| [**list_devices**](DevicesApi.md#list_devices) | **GET** /devices | List devices |
+| [**register_device**](DevicesApi.md#register_device) | **POST** /devices | Register a device |
+
+
+## delete_device
+
+> <DeleteResult> delete_device(id)
+
+Delete a device
+
+Unregister and delete a specific device.
+
+### 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::DevicesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete a device
+  result = api_instance.delete_device(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->delete_device: #{e}"
+end
+```
+
+#### Using the delete_device_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteResult>, Integer, Hash)> delete_device_with_http_info(id)
+
+```ruby
+begin
+  # Delete a device
+  data, status_code, headers = api_instance.delete_device_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteResult>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->delete_device_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**DeleteResult**](DeleteResult.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_user_devices
+
+> <UserDevicesDeleteResponse> delete_user_devices(user_id)
+
+Delete all devices for a user
+
+Unregister and delete all devices belonging to a specific user.
+
+### 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::DevicesApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete all devices for a user
+  result = api_instance.delete_user_devices(user_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->delete_user_devices: #{e}"
+end
+```
+
+#### Using the delete_user_devices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserDevicesDeleteResponse>, Integer, Hash)> delete_user_devices_with_http_info(user_id)
+
+```ruby
+begin
+  # Delete all devices for a user
+  data, status_code, headers = api_instance.delete_user_devices_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserDevicesDeleteResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->delete_user_devices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+
+### Return type
+
+[**UserDevicesDeleteResponse**](UserDevicesDeleteResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_device
+
+> <DeviceResponse> get_device(id)
+
+Get device details
+
+Get a specific registered device 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::DevicesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get device details
+  result = api_instance.get_device(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->get_device: #{e}"
+end
+```
+
+#### Using the get_device_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeviceResponse>, Integer, Hash)> get_device_with_http_info(id)
+
+```ruby
+begin
+  # Get device details
+  data, status_code, headers = api_instance.get_device_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeviceResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->get_device_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_device_stats
+
+> <DeviceStatsResponse> get_device_stats
+
+Get device statistics
+
+Get aggregated device 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::DevicesApi.new
+
+begin
+  # Get device statistics
+  result = api_instance.get_device_stats
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->get_device_stats: #{e}"
+end
+```
+
+#### Using the get_device_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeviceStatsResponse>, Integer, Hash)> get_device_stats_with_http_info
+
+```ruby
+begin
+  # Get device statistics
+  data, status_code, headers = api_instance.get_device_stats_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeviceStatsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->get_device_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DeviceStatsResponse**](DeviceStatsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_devices
+
+> <DeviceListResponse> list_devices(opts)
+
+List devices
+
+List registered devices 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::DevicesApi.new
+opts = {
+  user_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter by subscriber/user ID
+  platform: 'ios', # String | 
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  # List devices
+  result = api_instance.list_devices(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->list_devices: #{e}"
+end
+```
+
+#### Using the list_devices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeviceListResponse>, Integer, Hash)> list_devices_with_http_info(opts)
+
+```ruby
+begin
+  # List devices
+  data, status_code, headers = api_instance.list_devices_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeviceListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->list_devices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | Filter by subscriber/user ID | [optional] |
+| **platform** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+[**DeviceListResponse**](DeviceListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## register_device
+
+> <DeviceResponse> register_device(register_device_request)
+
+Register a device
+
+Register a device for push notifications. If the token already exists, updates it.
+
+### 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::DevicesApi.new
+register_device_request = Zyphr::RegisterDeviceRequest.new({platform: 'ios', token: 'token_example'}) # RegisterDeviceRequest | 
+
+begin
+  # Register a device
+  result = api_instance.register_device(register_device_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->register_device: #{e}"
+end
+```
+
+#### Using the register_device_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeviceResponse>, Integer, Hash)> register_device_with_http_info(register_device_request)
+
+```ruby
+begin
+  # Register a device
+  data, status_code, headers = api_instance.register_device_with_http_info(register_device_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeviceResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DevicesApi->register_device_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **register_device_request** | [**RegisterDeviceRequest**](RegisterDeviceRequest.md) |  |  |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmailAddress.md

@@ -0,0 +1,20 @@
+# Zyphr::EmailAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::EmailAddress.new(
+  email: user@example.com,
+  name: John Doe
+)
+```
+

data/docs/EmailAttachment.md

@@ -0,0 +1,26 @@
+# Zyphr::EmailAttachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** |  |  |
+| **content** | **String** | Base64 encoded file content |  |
+| **content_type** | **String** |  | [optional] |
+| **disposition** | **String** |  | [optional][default to 'attachment'] |
+| **content_id** | **String** | Content ID for inline attachments | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::EmailAttachment.new(
+  filename: document.pdf,
+  content: null,
+  content_type: application/pdf,
+  disposition: null,
+  content_id: null
+)
+```
+

data/docs/EmailEvent.md

@@ -0,0 +1,32 @@
+# Zyphr::EmailEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **event_type** | **String** |  | [optional] |
+| **recipient_email** | **String** |  | [optional] |
+| **bounce_type** | **String** |  | [optional] |
+| **bounce_subtype** | **String** |  | [optional] |
+| **complaint_feedback_type** | **String** |  | [optional] |
+| **event_timestamp** | **Time** |  | [optional] |
+| **processed_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::EmailEvent.new(
+  id: null,
+  event_type: null,
+  recipient_email: null,
+  bounce_type: null,
+  bounce_subtype: null,
+  complaint_feedback_type: null,
+  event_timestamp: null,
+  processed_at: null
+)
+```
+

data/docs/EmailEventsResponse.md

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

data/docs/EmailListResponse.md

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

data/docs/EmailMessage.md

@@ -0,0 +1,42 @@
+# Zyphr::EmailMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **from** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
+| **to** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **queued_at** | **Time** |  | [optional] |
+| **sent_at** | **Time** |  | [optional] |
+| **delivered_at** | **Time** |  | [optional] |
+| **bounced_at** | **Time** |  | [optional] |
+| **opened_at** | **Time** |  | [optional] |
+| **clicked_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::EmailMessage.new(
+  id: null,
+  from: null,
+  to: null,
+  subject: null,
+  status: null,
+  tags: null,
+  queued_at: null,
+  sent_at: null,
+  delivered_at: null,
+  bounced_at: null,
+  opened_at: null,
+  clicked_at: null,
+  created_at: null
+)
+```
+

data/docs/EmailResponse.md

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

data/docs/EmailTrackingClickLink.md

@@ -0,0 +1,22 @@
+# Zyphr::EmailTrackingClickLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **first_clicked_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::EmailTrackingClickLink.new(
+  url: null,
+  count: null,
+  first_clicked_at: null
+)
+```
+

data/docs/EmailTrackingClicks.md

@@ -0,0 +1,22 @@
+# Zyphr::EmailTrackingClicks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  | [optional] |
+| **first_clicked_at** | **Time** |  | [optional] |
+| **urls** | [**Array<EmailTrackingClickLink>**](EmailTrackingClickLink.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::EmailTrackingClicks.new(
+  count: null,
+  first_clicked_at: null,
+  urls: null
+)
+```
+

data/docs/EmailTrackingData.md

@@ -0,0 +1,20 @@
+# Zyphr::EmailTrackingData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **opens** | [**EmailTrackingOpens**](EmailTrackingOpens.md) |  | [optional] |
+| **clicks** | [**EmailTrackingClicks**](EmailTrackingClicks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::EmailTrackingData.new(
+  opens: null,
+  clicks: null
+)
+```
+