notifo-io 1.0.1 → 1.1.0

data/docs/TopicsApi.md

@@ -1,71 +1,145 @@
 # Notifo::TopicsApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://notifo.easierlife.com*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics. |
+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)
 
-## topics_get_topics
+Delete a topic.
 
-> <ListResponseDtoOfTopicDto> topics_get_topics(app_id, opts)
+### Example
+```ruby
+# load the gem
+require 'notifo'
 
-Query topics.
+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. | 
 
-### Examples
+### 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)
+
+Query topics.
+
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TopicsApi.new
 app_id = 'app_id_example' # String | The app where the topics belongs to.
-opts = {
+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.
 }
 
 begin
-  # Query topics.
+  #Query topics.
   result = api_instance.topics_get_topics(app_id, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TopicsApi->topics_get_topics: #{e}"
+  puts "Exception when calling TopicsApi->topics_get_topics: #{e}"
 end
 ```
 
-#### Using the topics_get_topics_with_http_info variant
+### Parameters
+
+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] 
+
+### Return type
+
+[**ListResponseDtoOfTopicDto**](ListResponseDtoOfTopicDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
 
-This returns an Array which contains the response data, status code and headers.
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
-> <Array(<ListResponseDtoOfTopicDto>, Integer, Hash)> topics_get_topics_with_http_info(app_id, opts)
 
+
+# **topics_post_topics**
+> Array&lt;TopicDto&gt; 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
-  # Query topics.
-  data, status_code, headers = api_instance.topics_get_topics_with_http_info(app_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfTopicDto>
+  #Upsert topics.
+  result = api_instance.topics_post_topics(bodyapp_id)
+  p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TopicsApi->topics_get_topics_with_http_info: #{e}"
+  puts "Exception when calling TopicsApi->topics_post_topics: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the topics belongs 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] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpsertTopicsDto**](UpsertTopicsDto.md)| The upsert request. | 
+ **app_id** | **String**| The app where the topics belong to. | 
 
 ### Return type
 
-[**ListResponseDtoOfTopicDto**](ListResponseDtoOfTopicDto.md)
+[**Array&lt;TopicDto&gt;**](TopicDto.md)
 
 ### Authorization
 
@@ -73,6 +147,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 

data/docs/TrackNotificationDto.md

@@ -0,0 +1,10 @@
+# Notifo::TrackNotificationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**confirmed** | **String** | The id of the noitifications to mark as confirmed. | [optional] 
+**seen** | **Array<String>** | The id of the noitifications to mark as seen. | [optional] 
+**channel** | **String** | The channel name. | [optional] 
+**device_identifier** | **String** | The device identifier. | [optional] 
+

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

@@ -0,0 +1,11 @@
+# Notifo::UpdateIntegrationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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

@@ -1,28 +1,12 @@
 # Notifo::UpdateProfileDto
 
 ## Properties
-
-| 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] |
-| **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] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpdateProfileDto.new(
-  full_name: null,
-  email_address: null,
-  phone_number: null,
-  preferred_language: null,
-  preferred_timezone: null,
-  settings: null
-)
-```
+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] 
+**preferred_language** | **String** | The preferred language of the user. | [optional] 
+**preferred_timezone** | **String** | The timezone of the user. | [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/UpsertAppDto.md

@@ -1,36 +1,16 @@
 # Notifo::UpsertAppDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | The app name. | [optional] |
-| **languages** | **Array<String>** | The supported languages. | [optional] |
-| **email_address** | **String** | The sender email address. | [optional] |
-| **email_name** | **String** | The sender email name. | [optional] |
-| **firebase_project** | **String** | The firebase project ID. | [optional] |
-| **firebase_credential** | **String** | The firebase credentials. | [optional] |
-| **webhook_url** | **String** | The webhook URL. | [optional] |
-| **confirm_url** | **String** | The confirm URL. | [optional] |
-| **allow_email** | **Boolean** | True, when emails are allowed. | [optional] |
-| **allow_sms** | **Boolean** | True, when SMS are allowed. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertAppDto.new(
-  name: null,
-  languages: null,
-  email_address: null,
-  email_name: null,
-  firebase_project: null,
-  firebase_credential: null,
-  webhook_url: null,
-  confirm_url: null,
-  allow_email: null,
-  allow_sms: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The app name. | [optional] 
+**languages** | **Array<String>** | The supported languages. | [optional] 
+**email_address** | **String** | The sender email address. | [optional] 
+**email_name** | **String** | The sender email name. | [optional] 
+**firebase_project** | **String** | The firebase project ID. | [optional] 
+**firebase_credential** | **String** | The firebase credentials. | [optional] 
+**webhook_url** | **String** | The webhook URL. | [optional] 
+**confirm_url** | **String** | The confirm URL. | [optional] 
+**allow_email** | **BOOLEAN** | True, when emails are allowed. | [optional] 
+**allow_sms** | **BOOLEAN** | True, when SMS are allowed. | [optional] 
 

data/docs/UpsertTemplateDto.md

@@ -1,22 +1,9 @@
 # Notifo::UpsertTemplateDto
 
 ## Properties
-
-| 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] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertTemplateDto.new(
-  code: null,
-  formatting: null,
-  settings: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The code of the template. | 
+**formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | [optional] 
 

data/docs/UpsertTemplatesDto.md

@@ -1,18 +1,7 @@
 # Notifo::UpsertTemplatesDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **requests** | [**Array<UpsertTemplateDto>**](UpsertTemplateDto.md) | The templates to update. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertTemplatesDto.new(
-  requests: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**Array<UpsertTemplateDto>**](UpsertTemplateDto.md) | The templates to update. | 
 

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

@@ -1,32 +1,15 @@
 # Notifo::UpsertUserDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the user. | [optional] |
-| **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] |
-| **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] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertUserDto.new(
-  id: null,
-  full_name: null,
-  email_address: null,
-  phone_number: null,
-  preferred_language: null,
-  preferred_timezone: null,
-  requires_whitelisted_topics: null,
-  settings: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the user. | [optional] 
+**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] 
+**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] 
+**properties** | **Hash<String, String>** | The user properties. | [optional] 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | [optional] 
 

data/docs/UpsertUsersDto.md

@@ -1,18 +1,7 @@
 # Notifo::UpsertUsersDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **requests** | [**Array<UpsertUserDto>**](UpsertUserDto.md) | The users to update. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertUsersDto.new(
-  requests: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**Array<UpsertUserDto>**](UpsertUserDto.md) | The users to update. |