zyphr 0.1.19 → 0.1.21

data/docs/AuthEmailTemplatesApi.md

@@ -0,0 +1,782 @@
+# Zyphr::AuthEmailTemplatesApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_upsert_auth_email_templates**](AuthEmailTemplatesApi.md#bulk_upsert_auth_email_templates) | **PUT** /auth/email-templates | Bulk-upsert auth email templates |
+| [**delete_auth_email_template**](AuthEmailTemplatesApi.md#delete_auth_email_template) | **DELETE** /auth/email-templates/{type} | Remove a tenant override |
+| [**get_auth_email_template**](AuthEmailTemplatesApi.md#get_auth_email_template) | **GET** /auth/email-templates/{type} | Get an auth email template |
+| [**get_auth_email_template_default**](AuthEmailTemplatesApi.md#get_auth_email_template_default) | **GET** /auth/email-templates/{type}/default | Get the system default template |
+| [**list_auth_email_template_versions**](AuthEmailTemplatesApi.md#list_auth_email_template_versions) | **GET** /auth/email-templates/{type}/versions | List version history for a template |
+| [**list_auth_email_templates**](AuthEmailTemplatesApi.md#list_auth_email_templates) | **GET** /auth/email-templates | List auth email templates |
+| [**preview_auth_email_template**](AuthEmailTemplatesApi.md#preview_auth_email_template) | **POST** /auth/email-templates/{type}/preview | Render a template with sample variables |
+| [**restore_auth_email_template_version**](AuthEmailTemplatesApi.md#restore_auth_email_template_version) | **POST** /auth/email-templates/{type}/versions/{version}/restore | Restore a previous version |
+| [**send_auth_email_template_test**](AuthEmailTemplatesApi.md#send_auth_email_template_test) | **POST** /auth/email-templates/{type}/test | Send a test render of a template |
+| [**upsert_auth_email_template**](AuthEmailTemplatesApi.md#upsert_auth_email_template) | **PUT** /auth/email-templates/{type} | Create or update an auth email template |
+
+
+## bulk_upsert_auth_email_templates
+
+> <BulkUpsertAuthEmailTemplatesResponse> bulk_upsert_auth_email_templates(bulk_upsert_auth_email_templates_request)
+
+Bulk-upsert auth email templates
+
+Atomic upsert of any subset of magic_link, password_reset, email_verification. Validates all inputs before any write; if any one fails validation or MJML compile, none are saved. Designed for one-shot migration imports from Auth0/Firebase/Clerk/Cognito. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+bulk_upsert_auth_email_templates_request = Zyphr::BulkUpsertAuthEmailTemplatesRequest.new # BulkUpsertAuthEmailTemplatesRequest | 
+
+begin
+  # Bulk-upsert auth email templates
+  result = api_instance.bulk_upsert_auth_email_templates(bulk_upsert_auth_email_templates_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->bulk_upsert_auth_email_templates: #{e}"
+end
+```
+
+#### Using the bulk_upsert_auth_email_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkUpsertAuthEmailTemplatesResponse>, Integer, Hash)> bulk_upsert_auth_email_templates_with_http_info(bulk_upsert_auth_email_templates_request)
+
+```ruby
+begin
+  # Bulk-upsert auth email templates
+  data, status_code, headers = api_instance.bulk_upsert_auth_email_templates_with_http_info(bulk_upsert_auth_email_templates_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkUpsertAuthEmailTemplatesResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->bulk_upsert_auth_email_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_upsert_auth_email_templates_request** | [**BulkUpsertAuthEmailTemplatesRequest**](BulkUpsertAuthEmailTemplatesRequest.md) |  |  |
+
+### Return type
+
+[**BulkUpsertAuthEmailTemplatesResponse**](BulkUpsertAuthEmailTemplatesResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_auth_email_template
+
+> <AuthEmailTemplateDeleteResponse> delete_auth_email_template(type)
+
+Remove a tenant override
+
+Reverts the application to the system default for this type
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+
+begin
+  # Remove a tenant override
+  result = api_instance.delete_auth_email_template(type)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->delete_auth_email_template: #{e}"
+end
+```
+
+#### Using the delete_auth_email_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateDeleteResponse>, Integer, Hash)> delete_auth_email_template_with_http_info(type)
+
+```ruby
+begin
+  # Remove a tenant override
+  data, status_code, headers = api_instance.delete_auth_email_template_with_http_info(type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateDeleteResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->delete_auth_email_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+
+### Return type
+
+[**AuthEmailTemplateDeleteResponse**](AuthEmailTemplateDeleteResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_auth_email_template
+
+> <AuthEmailTemplateResponse> get_auth_email_template(type)
+
+Get an auth email template
+
+Returns the override row for the given `type` if one exists, otherwise the system default. Use `is_default` to distinguish. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+
+begin
+  # Get an auth email template
+  result = api_instance.get_auth_email_template(type)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->get_auth_email_template: #{e}"
+end
+```
+
+#### Using the get_auth_email_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateResponse>, Integer, Hash)> get_auth_email_template_with_http_info(type)
+
+```ruby
+begin
+  # Get an auth email template
+  data, status_code, headers = api_instance.get_auth_email_template_with_http_info(type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->get_auth_email_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+
+### Return type
+
+[**AuthEmailTemplateResponse**](AuthEmailTemplateResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_auth_email_template_default
+
+> <AuthEmailTemplateDefaultResponse> get_auth_email_template_default(type)
+
+Get the system default template
+
+Returns the system default for the given type with Handlebars variables un-rendered. Useful for migration tooling fetch, modify, then PUT. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+
+begin
+  # Get the system default template
+  result = api_instance.get_auth_email_template_default(type)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->get_auth_email_template_default: #{e}"
+end
+```
+
+#### Using the get_auth_email_template_default_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateDefaultResponse>, Integer, Hash)> get_auth_email_template_default_with_http_info(type)
+
+```ruby
+begin
+  # Get the system default template
+  data, status_code, headers = api_instance.get_auth_email_template_default_with_http_info(type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateDefaultResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->get_auth_email_template_default_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+
+### Return type
+
+[**AuthEmailTemplateDefaultResponse**](AuthEmailTemplateDefaultResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_auth_email_template_versions
+
+> <AuthEmailTemplateVersionsResponse> list_auth_email_template_versions(type)
+
+List version history for a template
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+
+begin
+  # List version history for a template
+  result = api_instance.list_auth_email_template_versions(type)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->list_auth_email_template_versions: #{e}"
+end
+```
+
+#### Using the list_auth_email_template_versions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateVersionsResponse>, Integer, Hash)> list_auth_email_template_versions_with_http_info(type)
+
+```ruby
+begin
+  # List version history for a template
+  data, status_code, headers = api_instance.list_auth_email_template_versions_with_http_info(type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateVersionsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->list_auth_email_template_versions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+
+### Return type
+
+[**AuthEmailTemplateVersionsResponse**](AuthEmailTemplateVersionsResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_auth_email_templates
+
+> <AuthEmailTemplateListResponse> list_auth_email_templates
+
+List auth email templates
+
+List the application's auth email templates. Returns one entry per email type; when no override exists for a type, the system default is returned with `is_default: true`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+
+begin
+  # List auth email templates
+  result = api_instance.list_auth_email_templates
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->list_auth_email_templates: #{e}"
+end
+```
+
+#### Using the list_auth_email_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateListResponse>, Integer, Hash)> list_auth_email_templates_with_http_info
+
+```ruby
+begin
+  # List auth email templates
+  data, status_code, headers = api_instance.list_auth_email_templates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->list_auth_email_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AuthEmailTemplateListResponse**](AuthEmailTemplateListResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## preview_auth_email_template
+
+> <AuthEmailTemplatePreviewResponse> preview_auth_email_template(type, opts)
+
+Render a template with sample variables
+
+Returns subject/html/text rendered using sample variables (or caller-provided variables). No email is sent. Useful for dashboard previews and migration import validation. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+opts = {
+  auth_email_template_preview_request: Zyphr::AuthEmailTemplatePreviewRequest.new # AuthEmailTemplatePreviewRequest | 
+}
+
+begin
+  # Render a template with sample variables
+  result = api_instance.preview_auth_email_template(type, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->preview_auth_email_template: #{e}"
+end
+```
+
+#### Using the preview_auth_email_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplatePreviewResponse>, Integer, Hash)> preview_auth_email_template_with_http_info(type, opts)
+
+```ruby
+begin
+  # Render a template with sample variables
+  data, status_code, headers = api_instance.preview_auth_email_template_with_http_info(type, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplatePreviewResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->preview_auth_email_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+| **auth_email_template_preview_request** | [**AuthEmailTemplatePreviewRequest**](AuthEmailTemplatePreviewRequest.md) |  | [optional] |
+
+### Return type
+
+[**AuthEmailTemplatePreviewResponse**](AuthEmailTemplatePreviewResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## restore_auth_email_template_version
+
+> <AuthEmailTemplateResponse> restore_auth_email_template_version(type, version)
+
+Restore a previous version
+
+Snapshots current state, then overwrites with the contents of the specified historical version. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+version = 56 # Integer | 
+
+begin
+  # Restore a previous version
+  result = api_instance.restore_auth_email_template_version(type, version)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->restore_auth_email_template_version: #{e}"
+end
+```
+
+#### Using the restore_auth_email_template_version_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateResponse>, Integer, Hash)> restore_auth_email_template_version_with_http_info(type, version)
+
+```ruby
+begin
+  # Restore a previous version
+  data, status_code, headers = api_instance.restore_auth_email_template_version_with_http_info(type, version)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->restore_auth_email_template_version_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+| **version** | **Integer** |  |  |
+
+### Return type
+
+[**AuthEmailTemplateResponse**](AuthEmailTemplateResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## send_auth_email_template_test
+
+> <AuthEmailTemplateTestResponse> send_auth_email_template_test(type, auth_email_template_test_request)
+
+Send a test render of a template
+
+Renders the template (override or default) using sample/provided variables and sends to the recipient. The recipient must be in the application `test_recipients` allowlist. Rate-limited. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+auth_email_template_test_request = Zyphr::AuthEmailTemplateTestRequest.new({to: 'to_example'}) # AuthEmailTemplateTestRequest | 
+
+begin
+  # Send a test render of a template
+  result = api_instance.send_auth_email_template_test(type, auth_email_template_test_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->send_auth_email_template_test: #{e}"
+end
+```
+
+#### Using the send_auth_email_template_test_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateTestResponse>, Integer, Hash)> send_auth_email_template_test_with_http_info(type, auth_email_template_test_request)
+
+```ruby
+begin
+  # Send a test render of a template
+  data, status_code, headers = api_instance.send_auth_email_template_test_with_http_info(type, auth_email_template_test_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateTestResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->send_auth_email_template_test_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+| **auth_email_template_test_request** | [**AuthEmailTemplateTestRequest**](AuthEmailTemplateTestRequest.md) |  |  |
+
+### Return type
+
+[**AuthEmailTemplateTestResponse**](AuthEmailTemplateTestResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## upsert_auth_email_template
+
+> <AuthEmailTemplateResponse> upsert_auth_email_template(type, upsert_auth_email_template_request)
+
+Create or update an auth email template
+
+Idempotent upsert keyed by application + type. MJML sources are compiled to HTML on save; compile errors return 400 with `details`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = '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-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-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-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthEmailTemplatesApi.new
+type = Zyphr::AuthEmailType::MAGIC_LINK # AuthEmailType | 
+upsert_auth_email_template_request = Zyphr::UpsertAuthEmailTemplateRequest.new # UpsertAuthEmailTemplateRequest | 
+
+begin
+  # Create or update an auth email template
+  result = api_instance.upsert_auth_email_template(type, upsert_auth_email_template_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->upsert_auth_email_template: #{e}"
+end
+```
+
+#### Using the upsert_auth_email_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthEmailTemplateResponse>, Integer, Hash)> upsert_auth_email_template_with_http_info(type, upsert_auth_email_template_request)
+
+```ruby
+begin
+  # Create or update an auth email template
+  data, status_code, headers = api_instance.upsert_auth_email_template_with_http_info(type, upsert_auth_email_template_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthEmailTemplateResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailTemplatesApi->upsert_auth_email_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AuthEmailType**](.md) |  |  |
+| **upsert_auth_email_template_request** | [**UpsertAuthEmailTemplateRequest**](UpsertAuthEmailTemplateRequest.md) |  |  |
+
+### Return type
+
+[**AuthEmailTemplateResponse**](AuthEmailTemplateResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+