notifo-io 1.0.1 → 1.1.0

data/docs/ChannelCondition.md

@@ -0,0 +1,6 @@
+# Notifo::ChannelCondition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/ChannelSend.md

@@ -0,0 +1,6 @@
+# Notifo::ChannelSend
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/ChannelSendInfoDto.md

@@ -0,0 +1,9 @@
+# Notifo::ChannelSendInfoDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**ProcessStatus**](ProcessStatus.md) |  | [optional] 
+**last_update** | **DateTime** | The last update. | [optional] 
+**detail** | **String** | The details. | [optional] 
+

data/docs/ChannelSettingDto.md

@@ -0,0 +1,11 @@
+# Notifo::ChannelSettingDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**send** | [**ChannelSend**](ChannelSend.md) |  | 
+**condition** | [**ChannelCondition**](ChannelCondition.md) |  | 
+**delay_in_seconds** | **Integer** | The delay in seconds. | [optional] 
+**template** | **String** | The template if the channel supports it. | [optional] 
+**properties** | [**NotificationProperties**](NotificationProperties.md) |  | [optional] 
+

data/docs/ChannelTemplateDetailsDtoOfEmailTemplateDto.md

@@ -0,0 +1,12 @@
+# Notifo::ChannelTemplateDetailsDtoOfEmailTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the template. | 
+**name** | **String** | The optional name of the template. | [optional] 
+**primary** | **BOOLEAN** | True, when the template is the primary template. | 
+**created** | **DateTime** | The date time (ISO 8601) when the template has been created. | 
+**last_update** | **DateTime** | The date time (ISO 8601) when the template has been updated. | 
+**languages** | [**Hash<String, EmailTemplateDto>**](EmailTemplateDto.md) | The language specific templates. | 
+

data/docs/ChannelTemplateDetailsDtoOfMessagingTemplateDto.md

@@ -0,0 +1,12 @@
+# Notifo::ChannelTemplateDetailsDtoOfMessagingTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the template. | 
+**name** | **String** | The optional name of the template. | [optional] 
+**primary** | **BOOLEAN** | True, when the template is the primary template. | 
+**created** | **DateTime** | The date time (ISO 8601) when the template has been created. | 
+**last_update** | **DateTime** | The date time (ISO 8601) when the template has been updated. | 
+**languages** | [**Hash<String, MessagingTemplateDto>**](MessagingTemplateDto.md) | The language specific templates. | 
+

data/docs/ChannelTemplateDetailsDtoOfSmsTemplateDto.md

@@ -0,0 +1,12 @@
+# Notifo::ChannelTemplateDetailsDtoOfSmsTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the template. | 
+**name** | **String** | The optional name of the template. | [optional] 
+**primary** | **BOOLEAN** | True, when the template is the primary template. | 
+**created** | **DateTime** | The date time (ISO 8601) when the template has been created. | 
+**last_update** | **DateTime** | The date time (ISO 8601) when the template has been updated. | 
+**languages** | [**Hash<String, SmsTemplateDto>**](SmsTemplateDto.md) | The language specific templates. | 
+

data/docs/ChannelTemplateDto.md

@@ -0,0 +1,11 @@
+# Notifo::ChannelTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the template. | 
+**name** | **String** | The optional name of the template. | [optional] 
+**kind** | **String** | The kind of the template. | [optional] 
+**primary** | **BOOLEAN** | True, when the template is the primary template. | 
+**last_update** | **DateTime** | The last time the template has been updated. | 
+

data/docs/ConfigsApi.md

@@ -1,56 +1,34 @@
 # Notifo::ConfigsApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://notifo.easierlife.com*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**configs_get_languages**](ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages. |
-| [**configs_get_timezones**](ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones. |
-
-
-## configs_get_languages
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**configs_get_languages**](ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages.
+[**configs_get_timezones**](ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones.
 
+# **configs_get_languages**
 > Array<String> configs_get_languages
 
 Get all supported languages.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::ConfigsApi.new
 
 begin
-  # Get all supported languages.
+  #Get all supported languages.
   result = api_instance.configs_get_languages
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_languages: #{e}"
-end
-```
-
-#### Using the configs_get_languages_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_languages_with_http_info
-
-```ruby
-begin
-  # Get all supported languages.
-  data, status_code, headers = api_instance.configs_get_languages_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;String&gt;
-rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_languages_with_http_info: #{e}"
+  puts "Exception when calling ConfigsApi->configs_get_languages: #{e}"
 end
 ```
 
 ### Parameters
-
 This endpoint does not need any parameter.
 
 ### Return type
@@ -63,53 +41,33 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## configs_get_timezones
 
+# **configs_get_timezones**
 > Array&lt;String&gt; configs_get_timezones
 
 Get all supported timezones.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::ConfigsApi.new
 
 begin
-  # Get all supported timezones.
+  #Get all supported timezones.
   result = api_instance.configs_get_timezones
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_timezones: #{e}"
-end
-```
-
-#### Using the configs_get_timezones_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_timezones_with_http_info
-
-```ruby
-begin
-  # Get all supported timezones.
-  data, status_code, headers = api_instance.configs_get_timezones_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;String&gt;
-rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_timezones_with_http_info: #{e}"
+  puts "Exception when calling ConfigsApi->configs_get_timezones: #{e}"
 end
 ```
 
 ### Parameters
-
 This endpoint does not need any parameter.
 
 ### Return type
@@ -122,6 +80,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 

data/docs/ConfiguredIntegrationDto.md

@@ -0,0 +1,13 @@
+# Notifo::ConfiguredIntegrationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The integration type. | 
+**properties** | **Hash<String, String>** | The configured properties. | 
+**enabled** | **BOOLEAN** | True when enabled. | [optional] 
+**test** | **BOOLEAN** | True or false when only used for test or production mode. | [optional] 
+**condition** | **String** | The javascript condition. | [optional] 
+**priority** | **Integer** | The priority in which order the integrations must run. | [optional] 
+**status** | [**IntegrationStatus**](IntegrationStatus.md) |  | 
+

data/docs/ConfiguredIntegrationsDto.md

@@ -0,0 +1,8 @@
+# Notifo::ConfiguredIntegrationsDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**configured** | [**Hash<String, ConfiguredIntegrationDto>**](ConfiguredIntegrationDto.md) | The configured integrations. | 
+**supported** | [**Hash<String, IntegrationDefinitionDto>**](IntegrationDefinitionDto.md) | The supported integrations. | 
+

data/docs/ConfirmMode.md

@@ -1,15 +1,6 @@
 # Notifo::ConfirmMode
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::ConfirmMode.new()
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
 

data/docs/CreateChannelTemplateDto.md

@@ -0,0 +1,7 @@
+# Notifo::CreateChannelTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **String** | The kind of the template. | [optional] 
+

data/docs/CreateChannelTemplateLanguageDto.md

@@ -0,0 +1,7 @@
+# Notifo::CreateChannelTemplateLanguageDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **String** | The new language. | 
+

data/docs/CreateIntegrationDto.md

@@ -0,0 +1,11 @@
+# Notifo::CreateIntegrationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The integration type. | 
+**properties** | **Hash<String, String>** | The configured properties. | 
+**enabled** | **BOOLEAN** | True when enabled. | [optional] 
+**test** | **BOOLEAN** | True when used for test events. | [optional] 
+**priority** | **Integer** | The priority in which order the integrations must run. | [optional] 
+

data/docs/CreateSystemUserDto.md

@@ -0,0 +1,9 @@
+# Notifo::CreateSystemUserDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email of the user. Unique value. | 
+**password** | **String** | The password of the user. | [optional] 
+**roles** | **Array<String>** | Additional role for the user. | 
+

data/docs/EmailFormattingError.md

@@ -0,0 +1,10 @@
+# Notifo::EmailFormattingError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**template** | [**EmailTemplateType**](EmailTemplateType.md) |  | [optional] 
+**line** | **Integer** |  | [optional] 
+**column** | **Integer** |  | [optional] 
+

data/docs/EmailPreviewDto.md

@@ -0,0 +1,8 @@
+# Notifo::EmailPreviewDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **String** | The rendered preview. | [optional] 
+**errors** | [**Array<EmailFormattingError>**](EmailFormattingError.md) | The errors when rendering a preview. | [optional] 
+

data/docs/EmailPreviewRequestDto.md

@@ -0,0 +1,9 @@
+# Notifo::EmailPreviewRequestDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template** | **String** | The preview to render. | 
+**type** | [**EmailPreviewType**](EmailPreviewType.md) |  | [optional] 
+**kind** | **String** | The kind of the template. | [optional] 
+

data/docs/EmailPreviewType.md

@@ -0,0 +1,6 @@
+# Notifo::EmailPreviewType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/EmailTemplateDto.md

@@ -1,22 +1,12 @@
 # Notifo::EmailTemplateDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | **String** | The subject text. |  |
-| **body_html** | **String** | The body html template. |  |
-| **body_text** | **String** | The body text template. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::EmailTemplateDto.new(
-  subject: null,
-  body_html: null,
-  body_text: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subject** | **String** | The subject text. | 
+**body_html** | **String** | The body html template. | 
+**body_text** | **String** | The body text template. | [optional] 
+**from_email** | **String** | The optional from email. | [optional] 
+**from_name** | **String** | The optional from name. | [optional] 
+**kind** | **String** | The type of the template. | [optional] 
 

data/docs/EmailTemplateType.md

@@ -0,0 +1,6 @@
+# Notifo::EmailTemplateType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+