notifo-io 1.0.1.2 → 1.2.0

data/docs/EmailTemplatesApi.md

@@ -0,0 +1,488 @@
+# Notifo::EmailTemplatesApi
+
+All URIs are relative to *https://notifo-dev.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/{code} | Delete a channel template.
+[**email_templates_delete_template_language**](EmailTemplatesApi.md#email_templates_delete_template_language) | **DELETE** /api/apps/{appId}/email-templates/{code}/{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/{code} | Create an app template language.
+[**email_templates_put_template**](EmailTemplatesApi.md#email_templates_put_template) | **PUT** /api/apps/{appId}/email-templates/{code} | Update an app template.
+[**email_templates_put_template_language**](EmailTemplatesApi.md#email_templates_put_template_language) | **PUT** /api/apps/{appId}/email-templates/{code}/{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, code)
+
+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.
+code = 'code_example' # String | The template ID.
+
+
+begin
+  #Delete a channel template.
+  api_instance.email_templates_delete_template(app_id, code)
+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. | 
+ **code** | **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, code, 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.
+code = 'code_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, code, 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. | 
+ **code** | **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_idcode)
+
+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.
+code = 'code_example' # String | The template code.
+
+
+begin
+  #Create an app template language.
+  result = api_instance.email_templates_post_template_language(bodyapp_idcode)
+  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. | 
+ **code** | **String**| The template code. | 
+
+### 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_idcode)
+
+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.
+code = 'code_example' # String | The template code.
+
+
+begin
+  #Update an app template.
+  api_instance.email_templates_put_template(bodyapp_idcode)
+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. | 
+ **code** | **String**| The template code. | 
+
+### 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_idcodelanguage)
+
+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.
+code = 'code_example' # String | The template code.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Update a channel template language.
+  api_instance.email_templates_put_template_language(bodyapp_idcodelanguage)
+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. | 
+ **code** | **String**| The template code. | 
+ **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

@@ -4,6 +4,7 @@
 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] 

data/docs/EventDto.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **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. | 
+**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. | 

data/docs/EventsApi.md

@@ -1,12 +1,12 @@
 # Notifo::EventsApi
 
-All URIs are relative to *https://notifo.easierlife.com*
+All URIs are relative to *https://notifo-dev.easierlife.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**events_get_events**](EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events.
 [**events_post_events**](EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events.
-[**events_post_events2**](EventsApi.md#events_post_events2) | **POST** /api/me/events | Publish an event for the current user.
+[**events_post_my_events**](EventsApi.md#events_post_my_events) | **POST** /api/me/events | Publish an event for the current user.
 
 # **events_get_events**
 > ListResponseDtoOfEventDto events_get_events(app_id, opts)
@@ -21,6 +21,7 @@ require 'notifo'
 api_instance = Notifo::EventsApi.new
 app_id = 'app_id_example' # String | The app where the events belongs to.
 opts = { 
+  channels: ['channels_example'], # Array<String> | The active channels.
   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.
@@ -40,6 +41,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **app_id** | **String**| The app where the events belongs to. | 
+ **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional] 
  **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] 
@@ -104,8 +106,8 @@ No authorization required
 
 
 
-# **events_post_events2**
-> events_post_events2(body)
+# **events_post_my_events**
+> events_post_my_events(body)
 
 Publish an event for the current user.
 
@@ -120,9 +122,9 @@ body = Notifo::PublishDto.new # PublishDto | The publish request.
 
 begin
   #Publish an event for the current user.
-  api_instance.events_post_events2(body)
+  api_instance.events_post_my_events(body)
 rescue Notifo::ApiError => e
-  puts "Exception when calling EventsApi->events_post_events2: #{e}"
+  puts "Exception when calling EventsApi->events_post_my_events: #{e}"
 end
 ```
 

data/docs/HandledInfoDto.md

@@ -0,0 +1,8 @@
+# Notifo::HandledInfoDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **DateTime** | The timestamp. | [optional] 
+**channel** | **String** | The channel over which the notification was marked as seen or confirmed. | [optional] 
+

data/docs/{EmailVerificationStatus.md → InfoDto.md}

@@ -1,6 +1,7 @@
-# Notifo::EmailVerificationStatus
+# Notifo::InfoDto
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**version** | **String** | The actual version. | 
 

data/docs/IntegrationPropertyDto.md

@@ -4,14 +4,16 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The field name for the property. | 
-**type** | [**IntegrationPropertyType**](IntegrationPropertyType.md) |  | 
+**type** | [**PropertyType**](PropertyType.md) |  | 
 **editor_description** | **String** | The optional description. | [optional] 
 **editor_label** | **String** | The optional label. | [optional] 
 **summary** | **BOOLEAN** | True to show this property in the summary. | [optional] 
+**allowed_values** | **Array<String>** | The allowed values. | [optional] 
 **is_required** | **BOOLEAN** | True when required. | [optional] 
 **min_value** | **Integer** | The min value (for numbers). | [optional] 
 **max_value** | **Integer** | The max value (for numbers). | [optional] 
 **min_length** | **Integer** | The min length (for strings). | [optional] 
 **max_length** | **Integer** | The min length (for strings). | [optional] 
+**pattern** | **String** | The pattern (for strings). | [optional] 
 **default_value** | [****](.md) | The default value. | [optional] 
 

data/docs/ListResponseDtoOfChannelTemplateDto.md

@@ -0,0 +1,8 @@
+# Notifo::ListResponseDtoOfChannelTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<ChannelTemplateDto>**](ChannelTemplateDto.md) | The items. | 
+**total** | **Integer** | The total number of items. | 
+

data/docs/ListResponseDtoOfMobilePushTokenDto.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**items** | [**Array<MobilePushTokenDto>**](MobilePushTokenDto.md) | The items. | 
+**items** | [**Array<MobilePushTokenDto2>**](MobilePushTokenDto2.md) | The items. | 
 **total** | **Integer** | The total number of items. | 
 

data/docs/{ListResponseDtoOfNotificationDto.md → ListResponseDtoOfSystemUserDto.md}

@@ -1,8 +1,8 @@
-# Notifo::ListResponseDtoOfNotificationDto
+# Notifo::ListResponseDtoOfSystemUserDto
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**items** | [**Array<NotificationDto>**](NotificationDto.md) | The items. | 
+**items** | [**Array<SystemUserDto>**](SystemUserDto.md) | The items. | 
 **total** | **Integer** | The total number of items. | 
 

data/docs/ListResponseDtoOfUserNotificationDetailsDto.md

@@ -0,0 +1,8 @@
+# Notifo::ListResponseDtoOfUserNotificationDetailsDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<UserNotificationDetailsDto>**](UserNotificationDetailsDto.md) | The items. | 
+**total** | **Integer** | The total number of items. | 
+

data/docs/ListResponseDtoOfUserNotificationDto.md

@@ -0,0 +1,8 @@
+# Notifo::ListResponseDtoOfUserNotificationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<UserNotificationDto>**](UserNotificationDto.md) | The items. | 
+**total** | **Integer** | The total number of items. | 
+

data/docs/LogsApi.md

@@ -1,6 +1,6 @@
 # Notifo::LogsApi
 
-All URIs are relative to *https://notifo.easierlife.com*
+All URIs are relative to *https://notifo-dev.easierlife.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------