notifo-io 1.0.1 → 1.1.0

data/docs/EmailTemplatesApi.md

@@ -0,0 +1,488 @@
+# Notifo::EmailTemplatesApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**email_template_preview_get_preview**](EmailTemplatesApi.md#email_template_preview_get_preview) | **GET** /api/apps/{appId}/email-templates/{id}/preview | Get the HTML preview for a channel template.
+[**email_template_preview_post_preview**](EmailTemplatesApi.md#email_template_preview_post_preview) | **POST** /api/apps/{appId}/email-templates/render | Render a preview for a email template.
+[**email_templates_delete_template**](EmailTemplatesApi.md#email_templates_delete_template) | **DELETE** /api/apps/{appId}/email-templates/{id} | Delete a channel template.
+[**email_templates_delete_template_language**](EmailTemplatesApi.md#email_templates_delete_template_language) | **DELETE** /api/apps/{appId}/email-templates/{id}/{language} | Delete a language channel template.
+[**email_templates_get_template**](EmailTemplatesApi.md#email_templates_get_template) | **GET** /api/apps/{appId}/email-templates/{id} | Get the channel template by id.
+[**email_templates_get_templates**](EmailTemplatesApi.md#email_templates_get_templates) | **GET** /api/apps/{appId}/email-templates | Get the channel templates.
+[**email_templates_post_template**](EmailTemplatesApi.md#email_templates_post_template) | **POST** /api/apps/{appId}/email-templates | Create a channel template.
+[**email_templates_post_template_language**](EmailTemplatesApi.md#email_templates_post_template_language) | **POST** /api/apps/{appId}/email-templates/{id} | Create an app template language.
+[**email_templates_put_template**](EmailTemplatesApi.md#email_templates_put_template) | **PUT** /api/apps/{appId}/email-templates/{id} | Update an app template.
+[**email_templates_put_template_language**](EmailTemplatesApi.md#email_templates_put_template_language) | **PUT** /api/apps/{appId}/email-templates/{id}/{language} | Update a channel template language.
+
+# **email_template_preview_get_preview**
+> String email_template_preview_get_preview(app_id, id)
+
+Get the HTML preview for a channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Get the HTML preview for a channel template.
+  result = api_instance.email_template_preview_get_preview(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_template_preview_get_preview: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream, application/json
+
+
+
+# **email_template_preview_post_preview**
+> EmailPreviewDto email_template_preview_post_preview(bodyapp_id)
+
+Render a preview for a email template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+body = Notifo::EmailPreviewRequestDto.new # EmailPreviewRequestDto | The template to render.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+
+
+begin
+  #Render a preview for a email template.
+  result = api_instance.email_template_preview_post_preview(bodyapp_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_template_preview_post_preview: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**EmailPreviewRequestDto**](EmailPreviewRequestDto.md)| The template to render. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+
+### Return type
+
+[**EmailPreviewDto**](EmailPreviewDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_templates_delete_template**
+> email_templates_delete_template(app_id, id)
+
+Delete a channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Delete a channel template.
+  api_instance.email_templates_delete_template(app_id, id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_delete_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **email_templates_delete_template_language**
+> email_templates_delete_template_language(app_id, id, language)
+
+Delete a language channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Delete a language channel template.
+  api_instance.email_templates_delete_template_language(app_id, id, language)
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_delete_template_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+ **language** | **String**| The language. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **email_templates_get_template**
+> ChannelTemplateDetailsDtoOfEmailTemplateDto email_templates_get_template(app_id, id)
+
+Get the channel template by id.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Get the channel template by id.
+  result = api_instance.email_templates_get_template(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_get_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+[**ChannelTemplateDetailsDtoOfEmailTemplateDto**](ChannelTemplateDetailsDtoOfEmailTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **email_templates_get_templates**
+> ListResponseDtoOfChannelTemplateDto email_templates_get_templates(app_id, opts)
+
+Get the channel templates.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Get the channel templates.
+  result = api_instance.email_templates_get_templates(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_get_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **query** | **String**| The optional query to search for items. | [optional] 
+ **take** | **Integer**| The number of items to return. | [optional] 
+ **skip** | **Integer**| The number of items to skip. | [optional] 
+
+### Return type
+
+[**ListResponseDtoOfChannelTemplateDto**](ListResponseDtoOfChannelTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **email_templates_post_template**
+> ChannelTemplateDetailsDtoOfEmailTemplateDto email_templates_post_template(bodyapp_id)
+
+Create a channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+
+
+begin
+  #Create a channel template.
+  result = api_instance.email_templates_post_template(bodyapp_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_post_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateChannelTemplateDto**](CreateChannelTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+
+### Return type
+
+[**ChannelTemplateDetailsDtoOfEmailTemplateDto**](ChannelTemplateDetailsDtoOfEmailTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_templates_post_template_language**
+> EmailTemplateDto email_templates_post_template_language(bodyapp_idid)
+
+Create an app template language.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Create an app template language.
+  result = api_instance.email_templates_post_template_language(bodyapp_idid)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_post_template_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateChannelTemplateLanguageDto**](CreateChannelTemplateLanguageDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+[**EmailTemplateDto**](EmailTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_templates_put_template**
+> email_templates_put_template(bodyapp_idid)
+
+Update an app template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+body = Notifo::UpdateChannelTemplateDtoOfEmailTemplateDto.new # UpdateChannelTemplateDtoOfEmailTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Update an app template.
+  api_instance.email_templates_put_template(bodyapp_idid)
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_put_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpdateChannelTemplateDtoOfEmailTemplateDto**](UpdateChannelTemplateDtoOfEmailTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_templates_put_template_language**
+> email_templates_put_template_language(bodyapp_ididlanguage)
+
+Update a channel template language.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EmailTemplatesApi.new
+body = Notifo::EmailTemplateDto.new # EmailTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Update a channel template language.
+  api_instance.email_templates_put_template_language(bodyapp_ididlanguage)
+rescue Notifo::ApiError => e
+  puts "Exception when calling EmailTemplatesApi->email_templates_put_template_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**EmailTemplateDto**](EmailTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+ **language** | **String**| The language. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ErrorDto.md

@@ -1,26 +1,12 @@
 # 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] 
+**error_code** | **String** | The error code. | [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,21 @@
 # Notifo::EventDto
 
 ## Properties
-
-| 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** | **Time** | 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. |  |
-
-## 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] 
+**email_template** | **String** | The optional name of the Email template. | [optional] 
+**sms_template** | **String** | The optional name of the SMS template. | [optional] 
+**created** | **DateTime** | The time when the event has been created. | 
+**formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.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]