zyphr 0.1.0

data/docs/RevokeAllSessionsResponseData.md

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

data/docs/RevokeSessionRequest.md

@@ -0,0 +1,18 @@
+# Zyphr::RevokeSessionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refresh_token** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::RevokeSessionRequest.new(
+  refresh_token: null
+)
+```
+

data/docs/SMSApi.md

@@ -0,0 +1,654 @@
+# Zyphr::SMSApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_sms_config**](SMSApi.md#delete_sms_config) | **DELETE** /sms/config | Delete SMS configuration |
+| [**get_sms**](SMSApi.md#get_sms) | **GET** /sms/{id} | Get SMS message details |
+| [**get_sms_config**](SMSApi.md#get_sms_config) | **GET** /sms/config | Get SMS configuration |
+| [**list_sms**](SMSApi.md#list_sms) | **GET** /sms | List SMS messages |
+| [**send_batch_sms**](SMSApi.md#send_batch_sms) | **POST** /sms/batch | Send batch SMS messages |
+| [**send_sms**](SMSApi.md#send_sms) | **POST** /sms | Send an SMS message |
+| [**send_test_sms**](SMSApi.md#send_test_sms) | **POST** /sms/test | Send a test SMS |
+| [**upsert_sms_config**](SMSApi.md#upsert_sms_config) | **POST** /sms/config | Create or update SMS configuration |
+| [**verify_sms_config**](SMSApi.md#verify_sms_config) | **POST** /sms/config/verify | Verify SMS configuration |
+
+
+## delete_sms_config
+
+> <SmsConfigDeleteResponse> delete_sms_config
+
+Delete SMS configuration
+
+Remove the SMS provider configuration 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::SMSApi.new
+
+begin
+  # Delete SMS configuration
+  result = api_instance.delete_sms_config
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->delete_sms_config: #{e}"
+end
+```
+
+#### Using the delete_sms_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SmsConfigDeleteResponse>, Integer, Hash)> delete_sms_config_with_http_info
+
+```ruby
+begin
+  # Delete SMS configuration
+  data, status_code, headers = api_instance.delete_sms_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SmsConfigDeleteResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->delete_sms_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SmsConfigDeleteResponse**](SmsConfigDeleteResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sms
+
+> <SmsDetailResponse> get_sms(id)
+
+Get SMS message details
+
+Get detailed information about a specific SMS message.
+
+### 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::SMSApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get SMS message details
+  result = api_instance.get_sms(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->get_sms: #{e}"
+end
+```
+
+#### Using the get_sms_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SmsDetailResponse>, Integer, Hash)> get_sms_with_http_info(id)
+
+```ruby
+begin
+  # Get SMS message details
+  data, status_code, headers = api_instance.get_sms_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SmsDetailResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->get_sms_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**SmsDetailResponse**](SmsDetailResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sms_config
+
+> <SmsConfigResponse> get_sms_config
+
+Get SMS configuration
+
+Get the current SMS provider configuration 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::SMSApi.new
+
+begin
+  # Get SMS configuration
+  result = api_instance.get_sms_config
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->get_sms_config: #{e}"
+end
+```
+
+#### Using the get_sms_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SmsConfigResponse>, Integer, Hash)> get_sms_config_with_http_info
+
+```ruby
+begin
+  # Get SMS configuration
+  data, status_code, headers = api_instance.get_sms_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SmsConfigResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->get_sms_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SmsConfigResponse**](SmsConfigResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_sms
+
+> <SmsListResponse> list_sms(opts)
+
+List SMS messages
+
+List SMS messages for the workspace with optional filtering and 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::SMSApi.new
+opts = {
+  page: 56, # Integer | 
+  per_page: 56, # Integer | 
+  status: 'queued', # String | 
+  search: 'search_example' # String | Search by phone number or message body
+}
+
+begin
+  # List SMS messages
+  result = api_instance.list_sms(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->list_sms: #{e}"
+end
+```
+
+#### Using the list_sms_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SmsListResponse>, Integer, Hash)> list_sms_with_http_info(opts)
+
+```ruby
+begin
+  # List SMS messages
+  data, status_code, headers = api_instance.list_sms_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SmsListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->list_sms_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **per_page** | **Integer** |  | [optional][default to 25] |
+| **status** | **String** |  | [optional] |
+| **search** | **String** | Search by phone number or message body | [optional] |
+
+### Return type
+
+[**SmsListResponse**](SmsListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## send_batch_sms
+
+> <SendBatchSmsResponse> send_batch_sms(send_batch_sms_request)
+
+Send batch SMS messages
+
+Send SMS messages to multiple recipients (up to 100) in a single 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::SMSApi.new
+send_batch_sms_request = Zyphr::SendBatchSmsRequest.new({to: ['to_example'], body: 'body_example'}) # SendBatchSmsRequest | 
+
+begin
+  # Send batch SMS messages
+  result = api_instance.send_batch_sms(send_batch_sms_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->send_batch_sms: #{e}"
+end
+```
+
+#### Using the send_batch_sms_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendBatchSmsResponse>, Integer, Hash)> send_batch_sms_with_http_info(send_batch_sms_request)
+
+```ruby
+begin
+  # Send batch SMS messages
+  data, status_code, headers = api_instance.send_batch_sms_with_http_info(send_batch_sms_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendBatchSmsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->send_batch_sms_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_batch_sms_request** | [**SendBatchSmsRequest**](SendBatchSmsRequest.md) |  |  |
+
+### Return type
+
+[**SendBatchSmsResponse**](SendBatchSmsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_sms
+
+> <SendSmsResponse> send_sms(send_sms_request)
+
+Send an SMS message
+
+Send a single SMS text message. Supports subscriber preference checks and scheduling.
+
+### 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::SMSApi.new
+send_sms_request = Zyphr::SendSmsRequest.new({to: '+14155551234', body: 'Your verification code is 123456'}) # SendSmsRequest | 
+
+begin
+  # Send an SMS message
+  result = api_instance.send_sms(send_sms_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->send_sms: #{e}"
+end
+```
+
+#### Using the send_sms_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendSmsResponse>, Integer, Hash)> send_sms_with_http_info(send_sms_request)
+
+```ruby
+begin
+  # Send an SMS message
+  data, status_code, headers = api_instance.send_sms_with_http_info(send_sms_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendSmsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->send_sms_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_sms_request** | [**SendSmsRequest**](SendSmsRequest.md) |  |  |
+
+### Return type
+
+[**SendSmsResponse**](SendSmsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_test_sms
+
+> <SendTestSmsResponse> send_test_sms(send_test_sms_request)
+
+Send a test SMS
+
+Send a test SMS message to verify the provider configuration is working.
+
+### 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::SMSApi.new
+send_test_sms_request = Zyphr::SendTestSmsRequest.new({to: 'to_example'}) # SendTestSmsRequest | 
+
+begin
+  # Send a test SMS
+  result = api_instance.send_test_sms(send_test_sms_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->send_test_sms: #{e}"
+end
+```
+
+#### Using the send_test_sms_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SendTestSmsResponse>, Integer, Hash)> send_test_sms_with_http_info(send_test_sms_request)
+
+```ruby
+begin
+  # Send a test SMS
+  data, status_code, headers = api_instance.send_test_sms_with_http_info(send_test_sms_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SendTestSmsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->send_test_sms_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_test_sms_request** | [**SendTestSmsRequest**](SendTestSmsRequest.md) |  |  |
+
+### Return type
+
+[**SendTestSmsResponse**](SendTestSmsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## upsert_sms_config
+
+> <SmsConfigResponse> upsert_sms_config(upsert_sms_config_request)
+
+Create or update SMS configuration
+
+Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
+
+### 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::SMSApi.new
+upsert_sms_config_request = Zyphr::UpsertSmsConfigRequest.new({account_sid: 'account_sid_example', auth_token: 'auth_token_example', from_phone: 'from_phone_example'}) # UpsertSmsConfigRequest | 
+
+begin
+  # Create or update SMS configuration
+  result = api_instance.upsert_sms_config(upsert_sms_config_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->upsert_sms_config: #{e}"
+end
+```
+
+#### Using the upsert_sms_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SmsConfigResponse>, Integer, Hash)> upsert_sms_config_with_http_info(upsert_sms_config_request)
+
+```ruby
+begin
+  # Create or update SMS configuration
+  data, status_code, headers = api_instance.upsert_sms_config_with_http_info(upsert_sms_config_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SmsConfigResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->upsert_sms_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **upsert_sms_config_request** | [**UpsertSmsConfigRequest**](UpsertSmsConfigRequest.md) |  |  |
+
+### Return type
+
+[**SmsConfigResponse**](SmsConfigResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_sms_config
+
+> <VerifySmsConfigResponse> verify_sms_config
+
+Verify SMS configuration
+
+Verify the SMS provider credentials are valid and working.
+
+### 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::SMSApi.new
+
+begin
+  # Verify SMS configuration
+  result = api_instance.verify_sms_config
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->verify_sms_config: #{e}"
+end
+```
+
+#### Using the verify_sms_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifySmsConfigResponse>, Integer, Hash)> verify_sms_config_with_http_info
+
+```ruby
+begin
+  # Verify SMS configuration
+  data, status_code, headers = api_instance.verify_sms_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifySmsConfigResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling SMSApi->verify_sms_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VerifySmsConfigResponse**](VerifySmsConfigResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SendBatchEmailRequest.md

@@ -0,0 +1,18 @@
+# Zyphr::SendBatchEmailRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **messages** | [**Array<SendEmailRequest>**](SendEmailRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SendBatchEmailRequest.new(
+  messages: null
+)
+```
+