zyphr 0.1.0 → 0.1.2

data/docs/WaaSEventTypesApi.md

@@ -0,0 +1,454 @@
+# Zyphr::WaaSEventTypesApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_waa_s_event_type**](WaaSEventTypesApi.md#create_waa_s_event_type) | **POST** /v1/waas/applications/{appId}/event-types | Register an event type |
+| [**delete_waa_s_event_type**](WaaSEventTypesApi.md#delete_waa_s_event_type) | **DELETE** /v1/waas/applications/{appId}/event-types/{eventTypeId} | Delete an event type |
+| [**deprecate_waa_s_event_type**](WaaSEventTypesApi.md#deprecate_waa_s_event_type) | **POST** /v1/waas/applications/{appId}/event-types/{eventTypeId}/deprecate | Deprecate an event type |
+| [**get_waa_s_event_type**](WaaSEventTypesApi.md#get_waa_s_event_type) | **GET** /v1/waas/applications/{appId}/event-types/{eventTypeId} | Get an event type |
+| [**list_waa_s_event_types**](WaaSEventTypesApi.md#list_waa_s_event_types) | **GET** /v1/waas/applications/{appId}/event-types | List event types |
+| [**update_waa_s_event_type**](WaaSEventTypesApi.md#update_waa_s_event_type) | **PUT** /v1/waas/applications/{appId}/event-types/{eventTypeId} | Update an event type |
+
+
+## create_waa_s_event_type
+
+> <CreateWaaSEventType201Response> create_waa_s_event_type(app_id, create_waa_s_event_type_request)
+
+Register an event type
+
+Register a new custom event type for 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::WaaSEventTypesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+create_waa_s_event_type_request = Zyphr::CreateWaaSEventTypeRequest.new({event_type: 'order.created', name: 'Order Created'}) # CreateWaaSEventTypeRequest | 
+
+begin
+  # Register an event type
+  result = api_instance.create_waa_s_event_type(app_id, create_waa_s_event_type_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->create_waa_s_event_type: #{e}"
+end
+```
+
+#### Using the create_waa_s_event_type_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWaaSEventType201Response>, Integer, Hash)> create_waa_s_event_type_with_http_info(app_id, create_waa_s_event_type_request)
+
+```ruby
+begin
+  # Register an event type
+  data, status_code, headers = api_instance.create_waa_s_event_type_with_http_info(app_id, create_waa_s_event_type_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWaaSEventType201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->create_waa_s_event_type_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **create_waa_s_event_type_request** | [**CreateWaaSEventTypeRequest**](CreateWaaSEventTypeRequest.md) |  |  |
+
+### Return type
+
+[**CreateWaaSEventType201Response**](CreateWaaSEventType201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_waa_s_event_type
+
+> delete_waa_s_event_type(app_id, event_type_id)
+
+Delete an event type
+
+Permanently delete an event type. Endpoints subscribed to this type will stop receiving deliveries.
+
+### 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::WaaSEventTypesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+event_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete an event type
+  api_instance.delete_waa_s_event_type(app_id, event_type_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->delete_waa_s_event_type: #{e}"
+end
+```
+
+#### Using the delete_waa_s_event_type_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_event_type_with_http_info(app_id, event_type_id)
+
+```ruby
+begin
+  # Delete an event type
+  data, status_code, headers = api_instance.delete_waa_s_event_type_with_http_info(app_id, event_type_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->delete_waa_s_event_type_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **event_type_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## deprecate_waa_s_event_type
+
+> deprecate_waa_s_event_type(app_id, event_type_id)
+
+Deprecate an event type
+
+Mark an event type as deprecated. Existing subscriptions continue to receive deliveries, but new subscriptions are blocked.
+
+### 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::WaaSEventTypesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+event_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Deprecate an event type
+  api_instance.deprecate_waa_s_event_type(app_id, event_type_id)
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->deprecate_waa_s_event_type: #{e}"
+end
+```
+
+#### Using the deprecate_waa_s_event_type_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)> deprecate_waa_s_event_type_with_http_info(app_id, event_type_id)
+
+```ruby
+begin
+  # Deprecate an event type
+  data, status_code, headers = api_instance.deprecate_waa_s_event_type_with_http_info(app_id, event_type_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->deprecate_waa_s_event_type_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **event_type_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_event_type
+
+> <CreateWaaSEventType201Response> get_waa_s_event_type(app_id, event_type_id)
+
+Get an event type
+
+### 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::WaaSEventTypesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+event_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get an event type
+  result = api_instance.get_waa_s_event_type(app_id, event_type_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->get_waa_s_event_type: #{e}"
+end
+```
+
+#### Using the get_waa_s_event_type_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWaaSEventType201Response>, Integer, Hash)> get_waa_s_event_type_with_http_info(app_id, event_type_id)
+
+```ruby
+begin
+  # Get an event type
+  data, status_code, headers = api_instance.get_waa_s_event_type_with_http_info(app_id, event_type_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWaaSEventType201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->get_waa_s_event_type_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **event_type_id** | **String** |  |  |
+
+### Return type
+
+[**CreateWaaSEventType201Response**](CreateWaaSEventType201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_waa_s_event_types
+
+> <ListWaaSEventTypes200Response> list_waa_s_event_types(app_id, opts)
+
+List event types
+
+List all event types registered for 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::WaaSEventTypesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  limit: 56, # Integer | 
+  offset: 56, # Integer | 
+  category: 'category_example', # String | 
+  status: 'active' # String | 
+}
+
+begin
+  # List event types
+  result = api_instance.list_waa_s_event_types(app_id, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->list_waa_s_event_types: #{e}"
+end
+```
+
+#### Using the list_waa_s_event_types_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWaaSEventTypes200Response>, Integer, Hash)> list_waa_s_event_types_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # List event types
+  data, status_code, headers = api_instance.list_waa_s_event_types_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWaaSEventTypes200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->list_waa_s_event_types_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] |
+| **category** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+### Return type
+
+[**ListWaaSEventTypes200Response**](ListWaaSEventTypes200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_waa_s_event_type
+
+> update_waa_s_event_type(app_id, event_type_id, update_waa_s_event_type_request)
+
+Update an event type
+
+### 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::WaaSEventTypesApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+event_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+update_waa_s_event_type_request = Zyphr::UpdateWaaSEventTypeRequest.new # UpdateWaaSEventTypeRequest | 
+
+begin
+  # Update an event type
+  api_instance.update_waa_s_event_type(app_id, event_type_id, update_waa_s_event_type_request)
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->update_waa_s_event_type: #{e}"
+end
+```
+
+#### Using the update_waa_s_event_type_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)> update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request)
+
+```ruby
+begin
+  # Update an event type
+  data, status_code, headers = api_instance.update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventTypesApi->update_waa_s_event_type_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **event_type_id** | **String** |  |  |
+| **update_waa_s_event_type_request** | [**UpdateWaaSEventTypeRequest**](UpdateWaaSEventTypeRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+

data/docs/WaaSEventsApi.md

@@ -0,0 +1,155 @@
+# Zyphr::WaaSEventsApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**batch_publish_waa_s_events**](WaaSEventsApi.md#batch_publish_waa_s_events) | **POST** /v1/waas/applications/{appId}/events/batch | Batch publish events |
+| [**publish_waa_s_event**](WaaSEventsApi.md#publish_waa_s_event) | **POST** /v1/waas/applications/{appId}/events | Publish an event |
+
+
+## batch_publish_waa_s_events
+
+> <BatchPublishWaaSEvents201Response> batch_publish_waa_s_events(app_id, waa_s_batch_publish_request)
+
+Batch publish events
+
+Publish up to 100 events in a single request. Requires Starter plan or higher.
+
+### 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::WaaSEventsApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+waa_s_batch_publish_request = Zyphr::WaaSBatchPublishRequest.new({events: [Zyphr::WaaSPublishEventRequest.new({event_type: 'order.created', tenant_id: 'tenant_abc', data: 3.56})]}) # WaaSBatchPublishRequest | 
+
+begin
+  # Batch publish events
+  result = api_instance.batch_publish_waa_s_events(app_id, waa_s_batch_publish_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventsApi->batch_publish_waa_s_events: #{e}"
+end
+```
+
+#### Using the batch_publish_waa_s_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BatchPublishWaaSEvents201Response>, Integer, Hash)> batch_publish_waa_s_events_with_http_info(app_id, waa_s_batch_publish_request)
+
+```ruby
+begin
+  # Batch publish events
+  data, status_code, headers = api_instance.batch_publish_waa_s_events_with_http_info(app_id, waa_s_batch_publish_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BatchPublishWaaSEvents201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventsApi->batch_publish_waa_s_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **waa_s_batch_publish_request** | [**WaaSBatchPublishRequest**](WaaSBatchPublishRequest.md) |  |  |
+
+### Return type
+
+[**BatchPublishWaaSEvents201Response**](BatchPublishWaaSEvents201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## publish_waa_s_event
+
+> <PublishWaaSEvent201Response> publish_waa_s_event(app_id, waa_s_publish_event_request)
+
+Publish an event
+
+Publish an event to all subscribed endpoints for the specified tenant. Zyphr creates delivery records and queues them for delivery.
+
+### 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::WaaSEventsApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+waa_s_publish_event_request = Zyphr::WaaSPublishEventRequest.new({event_type: 'order.created', tenant_id: 'tenant_abc', data: 3.56}) # WaaSPublishEventRequest | 
+
+begin
+  # Publish an event
+  result = api_instance.publish_waa_s_event(app_id, waa_s_publish_event_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventsApi->publish_waa_s_event: #{e}"
+end
+```
+
+#### Using the publish_waa_s_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PublishWaaSEvent201Response>, Integer, Hash)> publish_waa_s_event_with_http_info(app_id, waa_s_publish_event_request)
+
+```ruby
+begin
+  # Publish an event
+  data, status_code, headers = api_instance.publish_waa_s_event_with_http_info(app_id, waa_s_publish_event_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PublishWaaSEvent201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSEventsApi->publish_waa_s_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **waa_s_publish_event_request** | [**WaaSPublishEventRequest**](WaaSPublishEventRequest.md) |  |  |
+
+### Return type
+
+[**PublishWaaSEvent201Response**](PublishWaaSEvent201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/WaaSPortalApi.md

@@ -0,0 +1,81 @@
+# Zyphr::WaaSPortalApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_waa_s_portal_token**](WaaSPortalApi.md#generate_waa_s_portal_token) | **POST** /v1/waas/applications/{appId}/portal/token | Generate portal token |
+
+
+## generate_waa_s_portal_token
+
+> <GenerateWaaSPortalToken201Response> generate_waa_s_portal_token(app_id, waa_s_portal_token_request)
+
+Generate portal token
+
+Generate a time-limited token for the embeddable webhook management portal. Requires Starter plan or higher.
+
+### 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::WaaSPortalApi.new
+app_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+waa_s_portal_token_request = Zyphr::WaaSPortalTokenRequest.new({tenant_id: 'tenant_abc'}) # WaaSPortalTokenRequest | 
+
+begin
+  # Generate portal token
+  result = api_instance.generate_waa_s_portal_token(app_id, waa_s_portal_token_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSPortalApi->generate_waa_s_portal_token: #{e}"
+end
+```
+
+#### Using the generate_waa_s_portal_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateWaaSPortalToken201Response>, Integer, Hash)> generate_waa_s_portal_token_with_http_info(app_id, waa_s_portal_token_request)
+
+```ruby
+begin
+  # Generate portal token
+  data, status_code, headers = api_instance.generate_waa_s_portal_token_with_http_info(app_id, waa_s_portal_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateWaaSPortalToken201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WaaSPortalApi->generate_waa_s_portal_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** |  |  |
+| **waa_s_portal_token_request** | [**WaaSPortalTokenRequest**](WaaSPortalTokenRequest.md) |  |  |
+
+### Return type
+
+[**GenerateWaaSPortalToken201Response**](GenerateWaaSPortalToken201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/WaaSPortalTokenRequest.md

@@ -0,0 +1,24 @@
+# Zyphr::WaaSPortalTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** |  |  |
+| **allowed_event_types** | **Array<String>** |  | [optional] |
+| **expires_in** | **Integer** | Token TTL in seconds (default 3600) | [optional] |
+| **theme** | [**WaaSPortalTokenRequestTheme**](WaaSPortalTokenRequestTheme.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSPortalTokenRequest.new(
+  tenant_id: tenant_abc,
+  allowed_event_types: null,
+  expires_in: 3600,
+  theme: null
+)
+```
+