zyphr 0.1.0 → 0.1.2

data/docs/WaaSDeliveriesApi.md

@@ -0,0 +1,319 @@
+# Zyphr::WaaSDeliveriesApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_waa_s_delivery**](WaaSDeliveriesApi.md#get_waa_s_delivery) | **GET** /v1/waas/applications/{appId}/deliveries/{deliveryId} | Get delivery detail |
+| [**list_waa_s_deliveries**](WaaSDeliveriesApi.md#list_waa_s_deliveries) | **GET** /v1/waas/applications/{appId}/deliveries | List deliveries |
+| [**list_waa_s_endpoint_deliveries**](WaaSDeliveriesApi.md#list_waa_s_endpoint_deliveries) | **GET** /v1/waas/applications/{appId}/endpoints/{endpointId}/deliveries | List endpoint deliveries |
+| [**retry_waa_s_delivery**](WaaSDeliveriesApi.md#retry_waa_s_delivery) | **POST** /v1/waas/applications/{appId}/deliveries/{deliveryId}/retry | Retry a delivery |
+
+
+## get_waa_s_delivery
+
+> get_waa_s_delivery(app_id, delivery_id)
+
+Get delivery detail
+
+Get full delivery details including request/response data.
+
+### 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::WaaSDeliveriesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+delivery_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get delivery detail
+  api_instance.get_waa_s_delivery(app_id, delivery_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->get_waa_s_delivery: #{e}"
+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.
+
+> <Array(nil, Integer, Hash)> get_waa_s_delivery_with_http_info(app_id, delivery_id)
+
+```ruby
+begin
+  # Get delivery detail
+  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
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->get_waa_s_delivery_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **delivery_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list_waa_s_deliveries
+
+> <ListWaaSEndpointDeliveries200Response> list_waa_s_deliveries(app_id, opts)
+
+List deliveries
+
+List delivery records for a WaaS application. Filter by tenant, event type, or status.
+
+### 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::WaaSDeliveriesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  limit: 56, # Integer | 
+  offset: 56, # Integer | 
+  tenant_id: 'tenant_id_example', # String | 
+  event_type: 'event_type_example', # String | 
+  status: 'pending' # String | 
+}
+
+begin
+  # List deliveries
+  result = api_instance.list_waa_s_deliveries(app_id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->list_waa_s_deliveries: #{e}"
+end
+```
+
+#### Using the list_waa_s_deliveries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWaaSEndpointDeliveries200Response>, Integer, Hash)> list_waa_s_deliveries_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # List deliveries
+  data, status_code, headers = api_instance.list_waa_s_deliveries_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWaaSEndpointDeliveries200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->list_waa_s_deliveries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+| **tenant_id** | **String** |  | [optional] |
+| **event_type** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+### Return type
+
+[**ListWaaSEndpointDeliveries200Response**](ListWaaSEndpointDeliveries200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_waa_s_endpoint_deliveries
+
+> <ListWaaSEndpointDeliveries200Response> list_waa_s_endpoint_deliveries(app_id, endpoint_id, opts)
+
+List endpoint deliveries
+
+List deliveries for a specific endpoint.
+
+### 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::WaaSDeliveriesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+endpoint_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  limit: 56, # Integer | 
+  offset: 56, # Integer | 
+  status: 'status_example' # String | 
+}
+
+begin
+  # List endpoint deliveries
+  result = api_instance.list_waa_s_endpoint_deliveries(app_id, endpoint_id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->list_waa_s_endpoint_deliveries: #{e}"
+end
+```
+
+#### Using the list_waa_s_endpoint_deliveries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWaaSEndpointDeliveries200Response>, Integer, Hash)> list_waa_s_endpoint_deliveries_with_http_info(app_id, endpoint_id, opts)
+
+```ruby
+begin
+  # List endpoint deliveries
+  data, status_code, headers = api_instance.list_waa_s_endpoint_deliveries_with_http_info(app_id, endpoint_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWaaSEndpointDeliveries200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->list_waa_s_endpoint_deliveries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **endpoint_id** | **String** |  |  |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+| **status** | **String** |  | [optional] |
+
+### Return type
+
+[**ListWaaSEndpointDeliveries200Response**](ListWaaSEndpointDeliveries200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## retry_waa_s_delivery
+
+> retry_waa_s_delivery(app_id, delivery_id)
+
+Retry a delivery
+
+Retry a failed or exhausted delivery. Resets the delivery status and re-queues 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::WaaSDeliveriesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+delivery_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Retry a delivery
+  api_instance.retry_waa_s_delivery(app_id, delivery_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->retry_waa_s_delivery: #{e}"
+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.
+
+> <Array(nil, Integer, Hash)> retry_waa_s_delivery_with_http_info(app_id, delivery_id)
+
+```ruby
+begin
+  # Retry a delivery
+  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
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSDeliveriesApi->retry_waa_s_delivery_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **delivery_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/WaaSDelivery.md

@@ -0,0 +1,38 @@
+# Zyphr::WaaSDelivery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **application_id** | **String** |  | [optional] |
+| **endpoint_id** | **String** |  | [optional] |
+| **event_id** | **String** |  | [optional] |
+| **event_type** | **String** |  | [optional] |
+| **tenant_id** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **attempts** | **Integer** |  | [optional] |
+| **last_attempt_at** | **Time** |  | [optional] |
+| **next_retry_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSDelivery.new(
+  id: null,
+  application_id: null,
+  endpoint_id: null,
+  event_id: null,
+  event_type: null,
+  tenant_id: null,
+  status: null,
+  attempts: null,
+  last_attempt_at: null,
+  next_retry_at: null,
+  created_at: null
+)
+```
+

data/docs/WaaSEndpoint.md

@@ -0,0 +1,32 @@
+# Zyphr::WaaSEndpoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **application_id** | **String** |  | [optional] |
+| **tenant_id** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **events** | **Array<String>** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSEndpoint.new(
+  id: null,
+  application_id: null,
+  tenant_id: tenant_abc,
+  url: https://customer.example.com/webhooks,
+  events: ["order.created","order.updated"],
+  status: null,
+  created_at: null,
+  updated_at: null
+)
+```
+