notifo-io 1.0.0.pre → 1.0.1.2

data/docs/AuthorizationApi.md

@@ -0,0 +1,121 @@
+# Notifo::AuthorizationApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**authorization_authorize**](AuthorizationApi.md#authorization_authorize) | **GET** /connect/authorize | 
+[**authorization_exchange**](AuthorizationApi.md#authorization_exchange) | **POST** /connect/token | 
+[**authorization_logout**](AuthorizationApi.md#authorization_logout) | **GET** /connect/logout | 
+
+# **authorization_authorize**
+> authorization_authorize
+
+
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::AuthorizationApi.new
+
+begin
+  api_instance.authorization_authorize
+rescue Notifo::ApiError => e
+  puts "Exception when calling AuthorizationApi->authorization_authorize: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **authorization_exchange**
+> authorization_exchange
+
+
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::AuthorizationApi.new
+
+begin
+  api_instance.authorization_exchange
+rescue Notifo::ApiError => e
+  puts "Exception when calling AuthorizationApi->authorization_exchange: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **authorization_logout**
+> authorization_logout
+
+
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::AuthorizationApi.new
+
+begin
+  api_instance.authorization_logout
+rescue Notifo::ApiError => e
+  puts "Exception when calling AuthorizationApi->authorization_logout: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Body.md

@@ -0,0 +1,7 @@
+# Notifo::Body
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **String** |  | [optional] 
+

data/docs/ConfigsApi.md

@@ -1,56 +1,34 @@
 # Notifo::ConfigsApi
 
-All URIs are relative to *https://app.notifo.io*
+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,12 @@
+# Notifo::ConfiguredIntegrationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The integration type. | 
+**properties** | [**IntegrationProperties**](IntegrationProperties.md) |  | 
+**enabled** | **BOOLEAN** | True when enabled. | [optional] 
+**test** | **BOOLEAN** | True or false when only used for test or production mode. | [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/CreateEmailTemplateDto.md

@@ -1,18 +1,7 @@
 # Notifo::CreateEmailTemplateDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **language** | **String** | The new language. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::CreateEmailTemplateDto.new(
-  language: null
-)
-```
+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** | [**IntegrationProperties**](IntegrationProperties.md) |  | 
+**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/EmailTemplateDto.md

@@ -1,22 +1,9 @@
 # Notifo::EmailTemplateDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | **String** | The subject text. | [optional] |
-| **body_html** | **String** | The body html template. | [optional] |
-| **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] 
 

data/docs/EmailTemplatesDto.md

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

data/docs/EmailVerificationStatus.md

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

data/docs/ErrorDto.md

@@ -1,26 +1,11 @@
 # Notifo::ErrorDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | The error message. | [optional] |
-| **trace_id** | **String** | The optional trace id. | [optional] |
-| **type** | **String** | The error type, usually a link. | [optional] |
-| **details** | **Array<String>** | Detailed error messages. | [optional] |
-| **status_code** | **Integer** | Status code of the http response. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::ErrorDto.new(
-  message: null,
-  trace_id: null,
-  type: null,
-  details: null,
-  status_code: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | The error message. | [optional] 
+**trace_id** | **String** | The optional trace id. | [optional] 
+**type** | **String** | The error type, usually a link. | [optional] 
+**details** | **Array<String>** | Detailed error messages. | [optional] 
+**status_code** | **Integer** | Status code of the http response. | [optional] 
 

data/docs/EventDto.md

@@ -1,40 +1,19 @@
 # Notifo::EventDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the event. | [optional] |
-| **topic** | **String** | The topic path. | [optional] |
-| **creator_id** | **String** | A custom id to identity the creator. | [optional] |
-| **display_name** | **String** | The display name. | [optional] |
-| **data** | **String** | Additional user defined data. | [optional] |
-| **created** | **Time** | The time when the event has been created. | [optional] |
-| **formatting** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | The final formatting infos. | [optional] |
-| **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
-| **properties** | [**OneOfmap**](OneOfmap.md) | User defined properties. | [optional] |
-| **scheduling** | [**OneOfSchedulingDto**](OneOfSchedulingDto.md) | The scheduling options. | [optional] |
-| **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
-| **silent** | **Boolean** | True when silent. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::EventDto.new(
-  id: null,
-  topic: null,
-  creator_id: null,
-  display_name: null,
-  data: null,
-  created: null,
-  formatting: null,
-  settings: null,
-  properties: null,
-  scheduling: null,
-  counters: null,
-  silent: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the event. | 
+**topic** | **String** | The topic path. | 
+**creator_id** | **String** | A custom id to identity the creator. | [optional] 
+**display_name** | **String** | The display name. | 
+**data** | **String** | Additional user defined data. | [optional] 
+**created** | **DateTime** | The time when the event has been created. | 
+**formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | 
+**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | 
+**properties** | **Hash<String, String>** | User defined properties. | 
+**scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] 
+**counters** | **Hash<String, Integer>** | The statistics counters. | 
+**silent** | **BOOLEAN** | True when silent. | 
+**time_to_live_in_seconds** | **Integer** | The time to live in seconds. | [optional]