zyphr 0.1.41 → 0.1.43

data/docs/SendTemplateTestEmail202ResponseData.md

@@ -0,0 +1,30 @@
+# Zyphr::SendTemplateTestEmail202ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **message_id** | **String** |  |  |
+| **to** | **String** |  |  |
+| **from** | **String** |  |  |
+| **subject** | **String** |  |  |
+| **template_id** | **String** |  |  |
+| **template_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SendTemplateTestEmail202ResponseData.new(
+  message: Test email queued for delivery,
+  message_id: null,
+  to: null,
+  from: null,
+  subject: null,
+  template_id: null,
+  template_name: null
+)
+```
+

data/docs/SendTemplateTestEmail202ResponseMeta.md

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

data/docs/SetEndUserClaims200Response.md

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

data/docs/SetEndUserClaims200ResponseData.md

@@ -0,0 +1,20 @@
+# Zyphr::SetEndUserClaims200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **claims** | **Object** |  | [optional] |
+| **claims_version** | **Integer** | Monotonic version bumped on each write; embedded in issued tokens. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SetEndUserClaims200ResponseData.new(
+  claims: null,
+  claims_version: null
+)
+```
+

data/docs/SmsListResponse.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **data** | [**Array<SmsMessage>**](SmsMessage.md) |  | [optional] |
-| **meta** | [**ListWorkflowExecutions200ResponseMeta**](ListWorkflowExecutions200ResponseMeta.md) |  | [optional] |
+| **meta** | [**ListEndUsers200ResponseMeta**](ListEndUsers200ResponseMeta.md) |  | [optional] |
 
 ## Example
 

data/docs/TemplatesApi.md

@@ -376,7 +376,7 @@ end
 
 ## send_template_test_email
 
-> send_template_test_email(id, send_template_test_email_request)
+> <SendTemplateTestEmail202Response> send_template_test_email(id, send_template_test_email_request)
 
 Send a test email using a template
 
@@ -399,7 +399,8 @@ send_template_test_email_request = Zyphr::SendTemplateTestEmailRequest.new({to:
 
 begin
   # Send a test email using a template
-  api_instance.send_template_test_email(id, send_template_test_email_request)
+  result = api_instance.send_template_test_email(id, send_template_test_email_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling TemplatesApi->send_template_test_email: #{e}"
 end
@@ -407,9 +408,9 @@ end
 
 #### Using the send_template_test_email_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> send_template_test_email_with_http_info(id, send_template_test_email_request)
+> <Array(<SendTemplateTestEmail202Response>, Integer, Hash)> send_template_test_email_with_http_info(id, send_template_test_email_request)
 
 ```ruby
 begin
@@ -417,7 +418,7 @@ begin
   data, status_code, headers = api_instance.send_template_test_email_with_http_info(id, send_template_test_email_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <SendTemplateTestEmail202Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling TemplatesApi->send_template_test_email_with_http_info: #{e}"
 end
@@ -432,7 +433,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**SendTemplateTestEmail202Response**](SendTemplateTestEmail202Response.md)
 
 ### Authorization
 

data/docs/UpdateSubscriberPreferences200Response.md

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

data/docs/UpdateSubscriberPreferences200ResponseData.md

@@ -0,0 +1,20 @@
+# Zyphr::UpdateSubscriberPreferences200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **updated** | **Integer** |  | [optional] |
+| **preferences** | [**Array<UpdateSubscriberPreferences200ResponseDataPreferencesInner>**](UpdateSubscriberPreferences200ResponseDataPreferencesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::UpdateSubscriberPreferences200ResponseData.new(
+  updated: null,
+  preferences: null
+)
+```
+

data/docs/UpdateSubscriberPreferences200ResponseDataPreferencesInner.md

@@ -0,0 +1,24 @@
+# Zyphr::UpdateSubscriberPreferences200ResponseDataPreferencesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_id** | **String** |  | [optional] |
+| **channel** | **String** |  | [optional] |
+| **enabled** | **Boolean** |  | [optional] |
+| **source** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::UpdateSubscriberPreferences200ResponseDataPreferencesInner.new(
+  category_id: null,
+  channel: null,
+  enabled: null,
+  source: null
+)
+```
+

data/docs/UpdateWaaSEndpoint200Response.md

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

data/docs/UpdateWaaSEventType200Response.md

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

data/docs/WaaSDeliveriesApi.md

@@ -12,7 +12,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 
 ## get_waa_s_delivery
 
-> get_waa_s_delivery(app_id, delivery_id)
+> <GetWaaSDelivery200Response> get_waa_s_delivery(app_id, delivery_id)
 
 Get delivery detail
 
@@ -37,7 +37,8 @@ delivery_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Get delivery detail
-  api_instance.get_waa_s_delivery(app_id, delivery_id)
+  result = api_instance.get_waa_s_delivery(app_id, delivery_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSDeliveriesApi->get_waa_s_delivery: #{e}"
 end
@@ -45,9 +46,9 @@ end
 
 #### Using the get_waa_s_delivery_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_waa_s_delivery_with_http_info(app_id, delivery_id)
+> <Array(<GetWaaSDelivery200Response>, Integer, Hash)> get_waa_s_delivery_with_http_info(app_id, delivery_id)
 
 ```ruby
 begin
@@ -55,7 +56,7 @@ begin
   data, status_code, headers = api_instance.get_waa_s_delivery_with_http_info(app_id, delivery_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetWaaSDelivery200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSDeliveriesApi->get_waa_s_delivery_with_http_info: #{e}"
 end
@@ -70,7 +71,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetWaaSDelivery200Response**](GetWaaSDelivery200Response.md)
 
 ### Authorization
 
@@ -79,7 +80,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## list_waa_s_deliveries
@@ -248,7 +249,7 @@ end
 
 ## retry_waa_s_delivery
 
-> retry_waa_s_delivery(app_id, delivery_id)
+> <GetWaaSDelivery200Response> retry_waa_s_delivery(app_id, delivery_id)
 
 Retry a delivery
 
@@ -273,7 +274,8 @@ delivery_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Retry a delivery
-  api_instance.retry_waa_s_delivery(app_id, delivery_id)
+  result = api_instance.retry_waa_s_delivery(app_id, delivery_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSDeliveriesApi->retry_waa_s_delivery: #{e}"
 end
@@ -281,9 +283,9 @@ end
 
 #### Using the retry_waa_s_delivery_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> retry_waa_s_delivery_with_http_info(app_id, delivery_id)
+> <Array(<GetWaaSDelivery200Response>, Integer, Hash)> retry_waa_s_delivery_with_http_info(app_id, delivery_id)
 
 ```ruby
 begin
@@ -291,7 +293,7 @@ begin
   data, status_code, headers = api_instance.retry_waa_s_delivery_with_http_info(app_id, delivery_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetWaaSDelivery200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSDeliveriesApi->retry_waa_s_delivery_with_http_info: #{e}"
 end
@@ -306,7 +308,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetWaaSDelivery200Response**](GetWaaSDelivery200Response.md)
 
 ### Authorization
 
@@ -315,5 +317,5 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 

data/docs/WaaSEndpointsApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 
 ## close_waa_s_endpoint_circuit
 
-> close_waa_s_endpoint_circuit(app_id, endpoint_id)
+> <CloseWaaSEndpointCircuit200Response> close_waa_s_endpoint_circuit(app_id, endpoint_id)
 
 Force-close circuit breaker
 
@@ -42,7 +42,8 @@ endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Force-close circuit breaker
-  api_instance.close_waa_s_endpoint_circuit(app_id, endpoint_id)
+  result = api_instance.close_waa_s_endpoint_circuit(app_id, endpoint_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->close_waa_s_endpoint_circuit: #{e}"
 end
@@ -50,9 +51,9 @@ end
 
 #### Using the close_waa_s_endpoint_circuit_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
+> <Array(<CloseWaaSEndpointCircuit200Response>, Integer, Hash)> close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
 
 ```ruby
 begin
@@ -60,7 +61,7 @@ begin
   data, status_code, headers = api_instance.close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <CloseWaaSEndpointCircuit200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->close_waa_s_endpoint_circuit_with_http_info: #{e}"
 end
@@ -75,7 +76,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**CloseWaaSEndpointCircuit200Response**](CloseWaaSEndpointCircuit200Response.md)
 
 ### Authorization
 
@@ -84,7 +85,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## create_waa_s_endpoint
@@ -305,7 +306,7 @@ end
 
 ## get_waa_s_endpoint_circuit
 
-> get_waa_s_endpoint_circuit(app_id, endpoint_id)
+> <GetWaaSEndpointCircuit200Response> get_waa_s_endpoint_circuit(app_id, endpoint_id)
 
 Get circuit breaker state
 
@@ -330,7 +331,8 @@ endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Get circuit breaker state
-  api_instance.get_waa_s_endpoint_circuit(app_id, endpoint_id)
+  result = api_instance.get_waa_s_endpoint_circuit(app_id, endpoint_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_circuit: #{e}"
 end
@@ -338,9 +340,9 @@ end
 
 #### Using the get_waa_s_endpoint_circuit_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
+> <Array(<GetWaaSEndpointCircuit200Response>, Integer, Hash)> get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
 
 ```ruby
 begin
@@ -348,7 +350,7 @@ begin
   data, status_code, headers = api_instance.get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetWaaSEndpointCircuit200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_circuit_with_http_info: #{e}"
 end
@@ -363,7 +365,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetWaaSEndpointCircuit200Response**](GetWaaSEndpointCircuit200Response.md)
 
 ### Authorization
 
@@ -372,12 +374,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## get_waa_s_endpoint_metrics
 
-> get_waa_s_endpoint_metrics(app_id, endpoint_id)
+> <GetWaaSEndpointMetrics200Response> get_waa_s_endpoint_metrics(app_id, endpoint_id)
 
 Get endpoint metrics
 
@@ -402,7 +404,8 @@ endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Get endpoint metrics
-  api_instance.get_waa_s_endpoint_metrics(app_id, endpoint_id)
+  result = api_instance.get_waa_s_endpoint_metrics(app_id, endpoint_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_metrics: #{e}"
 end
@@ -410,9 +413,9 @@ end
 
 #### Using the get_waa_s_endpoint_metrics_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id)
+> <Array(<GetWaaSEndpointMetrics200Response>, Integer, Hash)> get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id)
 
 ```ruby
 begin
@@ -420,7 +423,7 @@ begin
   data, status_code, headers = api_instance.get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <GetWaaSEndpointMetrics200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->get_waa_s_endpoint_metrics_with_http_info: #{e}"
 end
@@ -435,7 +438,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**GetWaaSEndpointMetrics200Response**](GetWaaSEndpointMetrics200Response.md)
 
 ### Authorization
 
@@ -444,7 +447,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## list_waa_s_endpoints
@@ -530,7 +533,7 @@ end
 
 ## rotate_waa_s_endpoint_secret
 
-> rotate_waa_s_endpoint_secret(app_id, endpoint_id)
+> <RotateWaaSEndpointSecret200Response> rotate_waa_s_endpoint_secret(app_id, endpoint_id)
 
 Rotate endpoint secret
 
@@ -555,7 +558,8 @@ endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Rotate endpoint secret
-  api_instance.rotate_waa_s_endpoint_secret(app_id, endpoint_id)
+  result = api_instance.rotate_waa_s_endpoint_secret(app_id, endpoint_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->rotate_waa_s_endpoint_secret: #{e}"
 end
@@ -563,9 +567,9 @@ end
 
 #### Using the rotate_waa_s_endpoint_secret_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id)
+> <Array(<RotateWaaSEndpointSecret200Response>, Integer, Hash)> rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id)
 
 ```ruby
 begin
@@ -573,7 +577,7 @@ begin
   data, status_code, headers = api_instance.rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <RotateWaaSEndpointSecret200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->rotate_waa_s_endpoint_secret_with_http_info: #{e}"
 end
@@ -588,7 +592,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**RotateWaaSEndpointSecret200Response**](RotateWaaSEndpointSecret200Response.md)
 
 ### Authorization
 
@@ -597,12 +601,12 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## update_waa_s_endpoint
 
-> update_waa_s_endpoint(app_id, endpoint_id, update_waa_s_endpoint_request)
+> <UpdateWaaSEndpoint200Response> update_waa_s_endpoint(app_id, endpoint_id, update_waa_s_endpoint_request)
 
 Update an endpoint
 
@@ -626,7 +630,8 @@ update_waa_s_endpoint_request = Zyphr::UpdateWaaSEndpointRequest.new # UpdateWaa
 
 begin
   # Update an endpoint
-  api_instance.update_waa_s_endpoint(app_id, endpoint_id, update_waa_s_endpoint_request)
+  result = api_instance.update_waa_s_endpoint(app_id, endpoint_id, update_waa_s_endpoint_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->update_waa_s_endpoint: #{e}"
 end
@@ -634,9 +639,9 @@ end
 
 #### Using the update_waa_s_endpoint_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request)
+> <Array(<UpdateWaaSEndpoint200Response>, Integer, Hash)> update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request)
 
 ```ruby
 begin
@@ -644,7 +649,7 @@ begin
   data, status_code, headers = api_instance.update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <UpdateWaaSEndpoint200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEndpointsApi->update_waa_s_endpoint_with_http_info: #{e}"
 end
@@ -660,7 +665,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**UpdateWaaSEndpoint200Response**](UpdateWaaSEndpoint200Response.md)
 
 ### Authorization
 
@@ -669,5 +674,5 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json