notifo-io 1.0.1.2 → 1.1.0

data/docs/SystemUsersApi.md

@@ -0,0 +1,327 @@
+# Notifo::SystemUsersApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**system_users_delete_user**](SystemUsersApi.md#system_users_delete_user) | **DELETE** /api/system-users/{id} | Delete the user.
+[**system_users_get_user**](SystemUsersApi.md#system_users_get_user) | **GET** /api/system-users/{id} | Get a user.
+[**system_users_get_users**](SystemUsersApi.md#system_users_get_users) | **GET** /api/system-users | Query users.
+[**system_users_lock_user**](SystemUsersApi.md#system_users_lock_user) | **PUT** /api/system-users/{id}/lock | Lock the user.
+[**system_users_post_user**](SystemUsersApi.md#system_users_post_user) | **POST** /api/system-users | Create a user.
+[**system_users_put_user**](SystemUsersApi.md#system_users_put_user) | **PUT** /api/system-users/{id} | Update the user.
+[**system_users_unlock_user**](SystemUsersApi.md#system_users_unlock_user) | **PUT** /api/system-users/{id}/unlock | Unlock the user.
+
+# **system_users_delete_user**
+> system_users_delete_user(id)
+
+Delete the user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SystemUsersApi.new
+id = 'id_example' # String | The user ID.
+
+
+begin
+  #Delete the user.
+  api_instance.system_users_delete_user(id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling SystemUsersApi->system_users_delete_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The user ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **system_users_get_user**
+> system_users_get_user(id)
+
+Get a user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SystemUsersApi.new
+id = 'id_example' # String | The user ID.
+
+
+begin
+  #Get a user.
+  api_instance.system_users_get_user(id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling SystemUsersApi->system_users_get_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The user ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **system_users_get_users**
+> ListResponseDtoOfSystemUserDto system_users_get_users(opts)
+
+Query users.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SystemUsersApi.new
+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
+  #Query users.
+  result = api_instance.system_users_get_users(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SystemUsersApi->system_users_get_users: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+[**ListResponseDtoOfSystemUserDto**](ListResponseDtoOfSystemUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **system_users_lock_user**
+> SystemUserDto system_users_lock_user(id)
+
+Lock the user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SystemUsersApi.new
+id = 'id_example' # String | The user ID.
+
+
+begin
+  #Lock the user.
+  result = api_instance.system_users_lock_user(id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SystemUsersApi->system_users_lock_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The user ID. | 
+
+### Return type
+
+[**SystemUserDto**](SystemUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **system_users_post_user**
+> SystemUserDto system_users_post_user(body)
+
+Create a user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SystemUsersApi.new
+body = Notifo::CreateSystemUserDto.new # CreateSystemUserDto | The create request.
+
+
+begin
+  #Create a user.
+  result = api_instance.system_users_post_user(body)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SystemUsersApi->system_users_post_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateSystemUserDto**](CreateSystemUserDto.md)| The create request. | 
+
+### Return type
+
+[**SystemUserDto**](SystemUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **system_users_put_user**
+> SystemUserDto system_users_put_user(bodyid)
+
+Update the user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SystemUsersApi.new
+body = Notifo::UpdateSystemUserDto.new # UpdateSystemUserDto | The update request.
+id = 'id_example' # String | The user ID.
+
+
+begin
+  #Update the user.
+  result = api_instance.system_users_put_user(bodyid)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SystemUsersApi->system_users_put_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpdateSystemUserDto**](UpdateSystemUserDto.md)| The update request. | 
+ **id** | **String**| The user ID. | 
+
+### Return type
+
+[**SystemUserDto**](SystemUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **system_users_unlock_user**
+> SystemUserDto system_users_unlock_user(id)
+
+Unlock the user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SystemUsersApi.new
+id = 'id_example' # String | The user ID.
+
+
+begin
+  #Unlock the user.
+  result = api_instance.system_users_unlock_user(id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SystemUsersApi->system_users_unlock_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The user ID. | 
+
+### Return type
+
+[**SystemUserDto**](SystemUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/TemplateDto.md

@@ -4,6 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | The code of the 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. | 
 **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | 
-**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | 
 

data/docs/TemplatesApi.md

@@ -9,7 +9,7 @@ Method | HTTP request | Description
 [**templates_post_templates**](TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates.
 
 # **templates_delete_template**
-> ListResponseDtoOfTemplateDto templates_delete_template(app_id, code)
+> templates_delete_template(app_id, code)
 
 Delete a template.
 
@@ -25,8 +25,7 @@ code = 'code_example' # String | The template code to delete.
 
 begin
   #Delete a template.
-  result = api_instance.templates_delete_template(app_id, code)
-  p result
+  api_instance.templates_delete_template(app_id, code)
 rescue Notifo::ApiError => e
   puts "Exception when calling TemplatesApi->templates_delete_template: #{e}"
 end
@@ -41,7 +40,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ListResponseDtoOfTemplateDto**](ListResponseDtoOfTemplateDto.md)
+nil (empty response body)
 
 ### Authorization
 

data/docs/TopicChannel.md

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

data/docs/TopicDto.md

@@ -4,6 +4,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **path** | **String** | The topic path. | 
-**last_update** | **DateTime** | THe last update to the topic. | 
+**created** | **DateTime** | The date time (ISO 8601) when the topic has been created. | 
+**last_update** | **DateTime** | The date time (ISO 8601) when the topic has been updated. | 
+**is_explicit** | **BOOLEAN** | True when the topic is explicit. | [optional] 
+**name** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**description** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**show_automatically** | **BOOLEAN** | True to show the topic automatically to new users, e.g. when he accepts push notifications. | [optional] 
+**channels** | [**Hash<String, TopicChannel>**](TopicChannel.md) | The channel settings. | [optional] 
 **counters** | **Hash<String, Integer>** | The statistics counters. | 
 

data/docs/TopicQueryScope.md

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

data/docs/TopicsApi.md

@@ -4,7 +4,54 @@ All URIs are relative to *https://notifo.easierlife.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**topics_delete_topic**](TopicsApi.md#topics_delete_topic) | **DELETE** /api/apps/{appId}/topics/{id} | Delete a topic.
 [**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics.
+[**topics_post_topics**](TopicsApi.md#topics_post_topics) | **POST** /api/apps/{appId}/topics | Upsert topics.
+
+# **topics_delete_topic**
+> topics_delete_topic(app_id, id)
+
+Delete a topic.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::TopicsApi.new
+app_id = 'app_id_example' # String | The app where the topics belong to.
+id = 'id_example' # String | The ID of the topic to delete.
+
+
+begin
+  #Delete a topic.
+  api_instance.topics_delete_topic(app_id, id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling TopicsApi->topics_delete_topic: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the topics belong to. | 
+ **id** | **String**| The ID of the topic to delete. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 
 # **topics_get_topics**
 > ListResponseDtoOfTopicDto topics_get_topics(app_id, opts)
@@ -19,6 +66,7 @@ require 'notifo'
 api_instance = Notifo::TopicsApi.new
 app_id = 'app_id_example' # String | The app where the topics belongs to.
 opts = { 
+  scope: Notifo::TopicQueryScope.new, # TopicQueryScope | The scope of the query.
   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.
@@ -38,6 +86,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **app_id** | **String**| The app where the topics belongs to. | 
+ **scope** | [**TopicQueryScope**](.md)| The scope of the query. | [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] 
@@ -57,3 +106,49 @@ No authorization required
 
 
 
+# **topics_post_topics**
+> Array<TopicDto> topics_post_topics(bodyapp_id)
+
+Upsert topics.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::TopicsApi.new
+body = Notifo::UpsertTopicsDto.new # UpsertTopicsDto | The upsert request.
+app_id = 'app_id_example' # String | The app where the topics belong to.
+
+
+begin
+  #Upsert topics.
+  result = api_instance.topics_post_topics(bodyapp_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling TopicsApi->topics_post_topics: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpsertTopicsDto**](UpsertTopicsDto.md)| The upsert request. | 
+ **app_id** | **String**| The app where the topics belong to. | 
+
+### Return type
+
+[**Array<TopicDto>**](TopicDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UpdateChannelTemplateDtoOfEmailTemplateDto.md

@@ -0,0 +1,9 @@
+# Notifo::UpdateChannelTemplateDtoOfEmailTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the template. | [optional] 
+**primary** | **BOOLEAN** | True, when the template is the primary template. | [optional] 
+**languages** | [**Hash<String, EmailTemplateDto>**](EmailTemplateDto.md) | The language specific templates. | [optional] 
+

data/docs/UpdateChannelTemplateDtoOfMessagingTemplateDto.md

@@ -0,0 +1,9 @@
+# Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the template. | [optional] 
+**primary** | **BOOLEAN** | True, when the template is the primary template. | [optional] 
+**languages** | [**Hash<String, MessagingTemplateDto>**](MessagingTemplateDto.md) | The language specific templates. | [optional] 
+

data/docs/UpdateChannelTemplateDtoOfSmsTemplateDto.md

@@ -0,0 +1,9 @@
+# Notifo::UpdateChannelTemplateDtoOfSmsTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the template. | [optional] 
+**primary** | **BOOLEAN** | True, when the template is the primary template. | [optional] 
+**languages** | [**Hash<String, SmsTemplateDto>**](SmsTemplateDto.md) | The language specific templates. | [optional] 
+

data/docs/UpdateIntegrationDto.md

@@ -3,8 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**properties** | [**IntegrationProperties**](IntegrationProperties.md) |  | 
+**properties** | **Hash<String, String>** | The configured properties. | 
 **enabled** | **BOOLEAN** | True when enabled. | [optional] 
 **test** | **BOOLEAN** | True when used for test events. | [optional] 
+**condition** | **String** | The javascript condition. | [optional] 
 **priority** | **Integer** | The priority in which order the integrations must run. | [optional] 
 

data/docs/UpdateProfileDto.md

@@ -8,5 +8,5 @@ Name | Type | Description | Notes
 **phone_number** | **String** | The phone number. | [optional] 
 **preferred_language** | **String** | The preferred language of the user. | [optional] 
 **preferred_timezone** | **String** | The timezone of the user. | [optional] 
-**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | [optional] 
 

data/docs/UpdateSystemUserDto.md

@@ -0,0 +1,9 @@
+# Notifo::UpdateSystemUserDto
+
+## 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/UpsertTemplateDto.md

@@ -5,5 +5,5 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | The code of the template. | 
 **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | 
-**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | [optional] 
 

data/docs/UpsertTopicDto.md

@@ -0,0 +1,11 @@
+# Notifo::UpsertTopicDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | The path of the topic. | [optional] 
+**name** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**description** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**show_automatically** | **BOOLEAN** | True to show the topic automatically to new users, e.g. when he accepts push notifications. | [optional] 
+**channels** | [**Hash<String, TopicChannel>**](TopicChannel.md) | Settings per channel. | [optional] 
+

data/docs/UpsertTopicsDto.md

@@ -0,0 +1,7 @@
+# Notifo::UpsertTopicsDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**Array<UpsertTopicDto>**](UpsertTopicDto.md) | The topics to update. | 
+

data/docs/UpsertUserDto.md

@@ -7,9 +7,9 @@ Name | Type | Description | Notes
 **full_name** | **String** | The full name of the user. | [optional] 
 **email_address** | **String** | The email of the user. | [optional] 
 **phone_number** | **String** | The phone number. | [optional] 
-**threema_id** | **String** | The threema id. | [optional] 
 **preferred_language** | **String** | The preferred language of the user. | [optional] 
 **preferred_timezone** | **String** | The timezone of the user. | [optional] 
 **requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. | [optional] 
-**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] 
+**properties** | **Hash<String, String>** | The user properties. | [optional] 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | [optional]