zyphr 0.1.0 → 0.1.2

data/docs/WaaSApplicationsApi.md

@@ -0,0 +1,446 @@
+# Zyphr::WaaSApplicationsApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_waa_s_application**](WaaSApplicationsApi.md#create_waa_s_application) | **POST** /v1/waas/applications | Create a WaaS application |
+| [**delete_waa_s_application**](WaaSApplicationsApi.md#delete_waa_s_application) | **DELETE** /v1/waas/applications/{appId} | Delete a WaaS application |
+| [**get_waa_s_application**](WaaSApplicationsApi.md#get_waa_s_application) | **GET** /v1/waas/applications/{appId} | Get a WaaS application |
+| [**get_waa_s_usage**](WaaSApplicationsApi.md#get_waa_s_usage) | **GET** /v1/waas/applications/{appId}/usage | Get WaaS usage |
+| [**list_waa_s_applications**](WaaSApplicationsApi.md#list_waa_s_applications) | **GET** /v1/waas/applications | List WaaS applications |
+| [**update_waa_s_application**](WaaSApplicationsApi.md#update_waa_s_application) | **PUT** /v1/waas/applications/{appId} | Update a WaaS application |
+
+
+## create_waa_s_application
+
+> <CreateWaaSApplication201Response> create_waa_s_application(create_waa_s_application_request)
+
+Create a WaaS application
+
+Create a new Webhooks-as-a-Service application.
+
+### 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::WaaSApplicationsApi.new
+create_waa_s_application_request = Zyphr::CreateWaaSApplicationRequest.new({name: 'My Platform', slug: 'my-platform'}) # CreateWaaSApplicationRequest | 
+
+begin
+  # Create a WaaS application
+  result = api_instance.create_waa_s_application(create_waa_s_application_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->create_waa_s_application: #{e}"
+end
+```
+
+#### Using the create_waa_s_application_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWaaSApplication201Response>, Integer, Hash)> create_waa_s_application_with_http_info(create_waa_s_application_request)
+
+```ruby
+begin
+  # Create a WaaS application
+  data, status_code, headers = api_instance.create_waa_s_application_with_http_info(create_waa_s_application_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWaaSApplication201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->create_waa_s_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_waa_s_application_request** | [**CreateWaaSApplicationRequest**](CreateWaaSApplicationRequest.md) |  |  |
+
+### Return type
+
+[**CreateWaaSApplication201Response**](CreateWaaSApplication201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_waa_s_application
+
+> delete_waa_s_application(app_id)
+
+Delete a WaaS application
+
+Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+
+### 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::WaaSApplicationsApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete a WaaS application
+  api_instance.delete_waa_s_application(app_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->delete_waa_s_application: #{e}"
+end
+```
+
+#### Using the delete_waa_s_application_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)> delete_waa_s_application_with_http_info(app_id)
+
+```ruby
+begin
+  # Delete a WaaS application
+  data, status_code, headers = api_instance.delete_waa_s_application_with_http_info(app_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->delete_waa_s_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_waa_s_application
+
+> <CreateWaaSApplication201Response> get_waa_s_application(app_id)
+
+Get a WaaS application
+
+Get a specific Webhooks-as-a-Service application 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::WaaSApplicationsApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get a WaaS application
+  result = api_instance.get_waa_s_application(app_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->get_waa_s_application: #{e}"
+end
+```
+
+#### Using the get_waa_s_application_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWaaSApplication201Response>, Integer, Hash)> get_waa_s_application_with_http_info(app_id)
+
+```ruby
+begin
+  # Get a WaaS application
+  data, status_code, headers = api_instance.get_waa_s_application_with_http_info(app_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWaaSApplication201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->get_waa_s_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+
+### Return type
+
+[**CreateWaaSApplication201Response**](CreateWaaSApplication201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_waa_s_usage
+
+> <GetWaaSUsage200Response> get_waa_s_usage(app_id)
+
+Get WaaS usage
+
+Get current usage counts and plan limits for WaaS resources.
+
+### 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::WaaSApplicationsApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get WaaS usage
+  result = api_instance.get_waa_s_usage(app_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->get_waa_s_usage: #{e}"
+end
+```
+
+#### Using the get_waa_s_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWaaSUsage200Response>, Integer, Hash)> get_waa_s_usage_with_http_info(app_id)
+
+```ruby
+begin
+  # Get WaaS usage
+  data, status_code, headers = api_instance.get_waa_s_usage_with_http_info(app_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWaaSUsage200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->get_waa_s_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+
+### Return type
+
+[**GetWaaSUsage200Response**](GetWaaSUsage200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_waa_s_applications
+
+> <ListWaaSApplications200Response> list_waa_s_applications(opts)
+
+List WaaS applications
+
+List all Webhooks-as-a-Service applications in 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::WaaSApplicationsApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56, # Integer | 
+  status: 'active' # String | 
+}
+
+begin
+  # List WaaS applications
+  result = api_instance.list_waa_s_applications(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->list_waa_s_applications: #{e}"
+end
+```
+
+#### Using the list_waa_s_applications_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWaaSApplications200Response>, Integer, Hash)> list_waa_s_applications_with_http_info(opts)
+
+```ruby
+begin
+  # List WaaS applications
+  data, status_code, headers = api_instance.list_waa_s_applications_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWaaSApplications200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->list_waa_s_applications_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+| **status** | **String** |  | [optional] |
+
+### Return type
+
+[**ListWaaSApplications200Response**](ListWaaSApplications200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_waa_s_application
+
+> <CreateWaaSApplication201Response> update_waa_s_application(app_id, update_waa_s_application_request)
+
+Update a WaaS application
+
+Update the name, description, or status of a WaaS application.
+
+### 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::WaaSApplicationsApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+update_waa_s_application_request = Zyphr::UpdateWaaSApplicationRequest.new # UpdateWaaSApplicationRequest | 
+
+begin
+  # Update a WaaS application
+  result = api_instance.update_waa_s_application(app_id, update_waa_s_application_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->update_waa_s_application: #{e}"
+end
+```
+
+#### Using the update_waa_s_application_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWaaSApplication201Response>, Integer, Hash)> update_waa_s_application_with_http_info(app_id, update_waa_s_application_request)
+
+```ruby
+begin
+  # Update a WaaS application
+  data, status_code, headers = api_instance.update_waa_s_application_with_http_info(app_id, update_waa_s_application_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWaaSApplication201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSApplicationsApi->update_waa_s_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **update_waa_s_application_request** | [**UpdateWaaSApplicationRequest**](UpdateWaaSApplicationRequest.md) |  |  |
+
+### Return type
+
+[**CreateWaaSApplication201Response**](CreateWaaSApplication201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/WaaSBatchPublishRequest.md

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

data/docs/WaaSBatchPublishResponse.md

@@ -0,0 +1,22 @@
+# Zyphr::WaaSBatchPublishResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **published** | **Integer** |  | [optional] |
+| **failed** | **Integer** |  | [optional] |
+| **results** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSBatchPublishResponse.new(
+  published: null,
+  failed: null,
+  results: null
+)
+```
+