notifo-io 1.0.1 → 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

@@ -1,22 +1,11 @@
 # Notifo::TemplateDto
 
 ## 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. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::TemplateDto.new(
-  code: null,
-  formatting: null,
-  settings: null
-)
-```
+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, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | 
 

data/docs/TemplatesApi.md

@@ -1,67 +1,46 @@
 # Notifo::TemplatesApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://notifo.easierlife.com*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**templates_delete_template**](TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template. |
-| [**templates_get_templates**](TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates. |
-| [**templates_post_templates**](TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates. |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**templates_delete_template**](TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
+[**templates_get_templates**](TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates.
+[**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**
+> templates_delete_template(app_id, code)
 
 Delete a template.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TemplatesApi.new
 app_id = 'app_id_example' # String | The app where the templates belong to.
 code = 'code_example' # String | The template code to delete.
 
-begin
-  # Delete a template.
-  result = api_instance.templates_delete_template(app_id, code)
-  p result
-rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_delete_template: #{e}"
-end
-```
-
-#### Using the templates_delete_template_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_delete_template_with_http_info(app_id, code)
-
-```ruby
 begin
-  # Delete a template.
-  data, status_code, headers = api_instance.templates_delete_template_with_http_info(app_id, code)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfTemplateDto>
+  #Delete a template.
+  api_instance.templates_delete_template(app_id, code)
 rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_delete_template_with_http_info: #{e}"
+  puts "Exception when calling TemplatesApi->templates_delete_template: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the templates belong to. |  |
-| **code** | **String** | The template code to delete. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the templates belong to. | 
+ **code** | **String**| The template code to delete. | 
 
 ### Return type
 
-[**ListResponseDtoOfTemplateDto**](ListResponseDtoOfTemplateDto.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -69,65 +48,46 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## templates_get_templates
 
-> <ListResponseDtoOfTemplateDto> templates_get_templates(app_id, opts)
+# **templates_get_templates**
+> ListResponseDtoOfTemplateDto templates_get_templates(app_id, opts)
 
 Query templates.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TemplatesApi.new
 app_id = 'app_id_example' # String | The app where the templates belongs to.
-opts = {
+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 templates.
+  #Query templates.
   result = api_instance.templates_get_templates(app_id, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_get_templates: #{e}"
-end
-```
-
-#### Using the templates_get_templates_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_get_templates_with_http_info(app_id, opts)
-
-```ruby
-begin
-  # Query templates.
-  data, status_code, headers = api_instance.templates_get_templates_with_http_info(app_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfTemplateDto>
-rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_get_templates_with_http_info: #{e}"
+  puts "Exception when calling TemplatesApi->templates_get_templates: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the templates 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
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the templates 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] 
 
 ### Return type
 
@@ -139,59 +99,41 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## templates_post_templates
 
-> <Array<TemplateDto>> templates_post_templates(app_id, upsert_templates_dto)
+# **templates_post_templates**
+> Array&lt;TemplateDto&gt; templates_post_templates(bodyapp_id)
 
 Upsert templates.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TemplatesApi.new
+body = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
 app_id = 'app_id_example' # String | The app where the templates belong to.
-upsert_templates_dto = Notifo::UpsertTemplatesDto.new({requests: [Notifo::UpsertTemplateDto.new({code: 'code_example', formatting: Notifo::NotificationFormattingDto.new({subject: { key: 'inner_example'}, confirm_mode: Notifo::ConfirmMode::SEEN})})]}) # UpsertTemplatesDto | The upsert request.
-
-begin
-  # Upsert templates.
-  result = api_instance.templates_post_templates(app_id, upsert_templates_dto)
-  p result
-rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_post_templates: #{e}"
-end
-```
-
-#### Using the templates_post_templates_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<TemplateDto>>, Integer, Hash)> templates_post_templates_with_http_info(app_id, upsert_templates_dto)
 
-```ruby
 begin
-  # Upsert templates.
-  data, status_code, headers = api_instance.templates_post_templates_with_http_info(app_id, upsert_templates_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<TemplateDto>>
+  #Upsert templates.
+  result = api_instance.templates_post_templates(bodyapp_id)
+  p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_post_templates_with_http_info: #{e}"
+  puts "Exception when calling TemplatesApi->templates_post_templates: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the templates belong to. |  |
-| **upsert_templates_dto** | [**UpsertTemplatesDto**](UpsertTemplatesDto.md) | The upsert request. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpsertTemplatesDto**](UpsertTemplatesDto.md)| The upsert request. | 
+ **app_id** | **String**| The app where the templates belong to. | 
 
 ### Return type
 
@@ -203,6 +145,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 

data/docs/TopicChannel.md

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

data/docs/TopicDto.md

@@ -1,22 +1,15 @@
 # Notifo::TopicDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **path** | **String** | The topic path. |  |
-| **last_update** | **Time** | THe last update to the topic. |  |
-| **counters** | **Hash<String, Integer>** | The statistics counters. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::TopicDto.new(
-  path: null,
-  last_update: null,
-  counters: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | The topic path. | 
+**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
+------------ | ------------- | ------------- | -------------
+