notifo-io 1.0.1.2 → 1.2.0

data/docs/MobilePushApi.md

@@ -1,15 +1,15 @@
 # Notifo::MobilePushApi
 
-All URIs are relative to *https://notifo.easierlife.com*
+All URIs are relative to *https://notifo-dev.easierlife.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**mobile_push_delete_token**](MobilePushApi.md#mobile_push_delete_token) | **DELETE** /api/me/mobilepush/{token} | Deletes a mobile push token for the current user.
-[**mobile_push_get_tokens**](MobilePushApi.md#mobile_push_get_tokens) | **GET** /api/me/mobilepush | Returns the mobile push tokens.
-[**mobile_push_post_token**](MobilePushApi.md#mobile_push_post_token) | **POST** /api/me/mobilepush | Register a mobile push token for the current user.
+[**mobile_push_delete_my_token**](MobilePushApi.md#mobile_push_delete_my_token) | **DELETE** /api/me/mobilepush/{token} | Deletes a mobile push token for the current user.
+[**mobile_push_get_my_token**](MobilePushApi.md#mobile_push_get_my_token) | **GET** /api/me/mobilepush | Returns the mobile push tokens.
+[**mobile_push_post_my_token**](MobilePushApi.md#mobile_push_post_my_token) | **POST** /api/me/mobilepush | Register a mobile push token for the current user.
 
-# **mobile_push_delete_token**
-> mobile_push_delete_token(token)
+# **mobile_push_delete_my_token**
+> mobile_push_delete_my_token(token)
 
 Deletes a mobile push token for the current user.
 
@@ -24,9 +24,9 @@ token = 'token_example' # String | The token to remove.
 
 begin
   #Deletes a mobile push token for the current user.
-  api_instance.mobile_push_delete_token(token)
+  api_instance.mobile_push_delete_my_token(token)
 rescue Notifo::ApiError => e
-  puts "Exception when calling MobilePushApi->mobile_push_delete_token: #{e}"
+  puts "Exception when calling MobilePushApi->mobile_push_delete_my_token: #{e}"
 end
 ```
 
@@ -51,8 +51,8 @@ No authorization required
 
 
 
-# **mobile_push_get_tokens**
-> ListResponseDtoOfMobilePushTokenDto mobile_push_get_tokens
+# **mobile_push_get_my_token**
+> ListResponseDtoOfMobilePushTokenDto mobile_push_get_my_token
 
 Returns the mobile push tokens.
 
@@ -65,10 +65,10 @@ api_instance = Notifo::MobilePushApi.new
 
 begin
   #Returns the mobile push tokens.
-  result = api_instance.mobile_push_get_tokens
+  result = api_instance.mobile_push_get_my_token
   p result
 rescue Notifo::ApiError => e
-  puts "Exception when calling MobilePushApi->mobile_push_get_tokens: #{e}"
+  puts "Exception when calling MobilePushApi->mobile_push_get_my_token: #{e}"
 end
 ```
 
@@ -90,8 +90,8 @@ No authorization required
 
 
 
-# **mobile_push_post_token**
-> mobile_push_post_token(body)
+# **mobile_push_post_my_token**
+> mobile_push_post_my_token(body)
 
 Register a mobile push token for the current user.
 
@@ -106,9 +106,9 @@ body = Notifo::RegisterMobileTokenDto.new # RegisterMobileTokenDto | The request
 
 begin
   #Register a mobile push token for the current user.
-  api_instance.mobile_push_post_token(body)
+  api_instance.mobile_push_post_my_token(body)
 rescue Notifo::ApiError => e
-  puts "Exception when calling MobilePushApi->mobile_push_post_token: #{e}"
+  puts "Exception when calling MobilePushApi->mobile_push_post_my_token: #{e}"
 end
 ```
 

data/docs/MobilePushTokenDto.md

@@ -3,6 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token** | **String** | The device token. | 
-**device_type** | [**MobileDeviceType**](MobileDeviceType.md) |  | [optional] 
+**token** | **String** | The token. | 
+**device_type** | [**MobileDeviceType**](MobileDeviceType.md) |  | 
+**device_identifier** | **String** | A unique identifier for the device. | [optional] 
+**last_wakeup** | **DateTime** | The last time the device was woken up. | [optional] 
 

data/docs/MobilePushTokenDto2.md

@@ -0,0 +1,9 @@
+# Notifo::MobilePushTokenDto2
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** | The device token. | 
+**device_type** | [**MobileDeviceType**](MobileDeviceType.md) |  | [optional] 
+**device_identifier** | **String** | A unique identifier for the device. | [optional] 
+

data/docs/NotificationFormattingDto.md

@@ -10,5 +10,5 @@ Name | Type | Description | Notes
 **image_large** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
 **link_url** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
 **link_text** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
-**confirm_mode** | [**ConfirmMode**](ConfirmMode.md) |  | 
+**confirm_mode** | [**ConfirmMode**](ConfirmMode.md) |  | [optional] 
 

data/docs/NotificationProperties.md

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

data/docs/NotificationsApi.md

@@ -1,15 +1,18 @@
 # Notifo::NotificationsApi
 
-All URIs are relative to *https://notifo.easierlife.com*
+All URIs are relative to *https://notifo-dev.easierlife.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**notifications_confirm**](NotificationsApi.md#notifications_confirm) | **POST** /api/me/notifications/handled | Confirms the user notifications for the current user.
-[**notifications_get_archive**](NotificationsApi.md#notifications_get_archive) | **GET** /api/me/notifications/archive | Query archhived user notifications of the current user.
-[**notifications_get_notifications**](NotificationsApi.md#notifications_get_notifications) | **GET** /api/me/notifications | Query user notifications of the current user.
+[**notifications_confirm_me**](NotificationsApi.md#notifications_confirm_me) | **POST** /api/me/notifications/handled | Confirms the user notifications for the current user.
+[**notifications_get_all_notifications**](NotificationsApi.md#notifications_get_all_notifications) | **GET** /api/apps/{appId}/notifications | Query notifications.
+[**notifications_get_my_archive**](NotificationsApi.md#notifications_get_my_archive) | **GET** /api/me/notifications/archive | Query archived user notifications of the current user.
+[**notifications_get_my_device_notifications**](NotificationsApi.md#notifications_get_my_device_notifications) | **GET** /api/me/notifications/device | Query user notifications of the current user for a specific device.
+[**notifications_get_my_notifications**](NotificationsApi.md#notifications_get_my_notifications) | **GET** /api/me/notifications | Query user notifications of the current user.
+[**notifications_get_notifications**](NotificationsApi.md#notifications_get_notifications) | **GET** /api/apps/{appId}/users/{id}/notifications | Query user notifications.
 
-# **notifications_confirm**
-> notifications_confirm(body)
+# **notifications_confirm_me**
+> notifications_confirm_me(body)
 
 Confirms the user notifications for the current user.
 
@@ -24,9 +27,9 @@ body = Notifo::TrackNotificationDto.new # TrackNotificationDto | The request obj
 
 begin
   #Confirms the user notifications for the current user.
-  api_instance.notifications_confirm(body)
+  api_instance.notifications_confirm_me(body)
 rescue Notifo::ApiError => e
-  puts "Exception when calling NotificationsApi->notifications_confirm: #{e}"
+  puts "Exception when calling NotificationsApi->notifications_confirm_me: #{e}"
 end
 ```
 
@@ -51,10 +54,10 @@ No authorization required
 
 
 
-# **notifications_get_archive**
-> ListResponseDtoOfNotificationDto notifications_get_archive
+# **notifications_get_all_notifications**
+> ListResponseDtoOfUserNotificationDetailsDto notifications_get_all_notifications(app_id, opts)
 
-Query archhived user notifications of the current user.
+Query notifications.
 
 ### Example
 ```ruby
@@ -62,22 +65,40 @@ Query archhived user notifications of the current user.
 require 'notifo'
 
 api_instance = Notifo::NotificationsApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+opts = { 
+  channels: ['channels_example'], # Array<String> | The active channels.
+  channel: 'channel_example', # String | The source channel.
+  correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
+  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 archhived user notifications of the current user.
-  result = api_instance.notifications_get_archive
+  #Query notifications.
+  result = api_instance.notifications_get_all_notifications(app_id, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Exception when calling NotificationsApi->notifications_get_archive: #{e}"
+  puts "Exception when calling NotificationsApi->notifications_get_all_notifications: #{e}"
 end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the user belongs to. | 
+ **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional] 
+ **channel** | **String**| The source channel. | [optional] 
+ **correlation_id** | **String**| The correlation ID, that can be used to query notifications. | [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
 
-[**ListResponseDtoOfNotificationDto**](ListResponseDtoOfNotificationDto.md)
+[**ListResponseDtoOfUserNotificationDetailsDto**](ListResponseDtoOfUserNotificationDetailsDto.md)
 
 ### Authorization
 
@@ -90,8 +111,104 @@ No authorization required
 
 
 
-# **notifications_get_notifications**
-> ListResponseDtoOfNotificationDto notifications_get_notifications(opts)
+# **notifications_get_my_archive**
+> ListResponseDtoOfUserNotificationDto notifications_get_my_archive(opts)
+
+Query archived user notifications of the current user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+opts = { 
+  channel: 'channel_example' # String | The tracking channel.
+}
+
+begin
+  #Query archived user notifications of the current user.
+  result = api_instance.notifications_get_my_archive(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_my_archive: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **channel** | **String**| The tracking channel. | [optional] 
+
+### Return type
+
+[**ListResponseDtoOfUserNotificationDto**](ListResponseDtoOfUserNotificationDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **notifications_get_my_device_notifications**
+> ListResponseDtoOfUserNotificationDto notifications_get_my_device_notifications(opts)
+
+Query user notifications of the current user for a specific device.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+opts = { 
+  device_identifier: 'device_identifier_example', # String | The device identifier (aka mobile push token).
+  after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The max age of the notifications.
+  include_unseen: true, # BOOLEAN | True to also include unseen notifications.
+  take: 56 # Integer | The number of notifications to query.
+}
+
+begin
+  #Query user notifications of the current user for a specific device.
+  result = api_instance.notifications_get_my_device_notifications(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_my_device_notifications: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_identifier** | **String**| The device identifier (aka mobile push token). | [optional] 
+ **after** | **DateTime**| The max age of the notifications. | [optional] 
+ **include_unseen** | **BOOLEAN**| True to also include unseen notifications. | [optional] 
+ **take** | **Integer**| The number of notifications to query. | [optional] 
+
+### Return type
+
+[**ListResponseDtoOfUserNotificationDto**](ListResponseDtoOfUserNotificationDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **notifications_get_my_notifications**
+> ListResponseDtoOfUserNotificationDto notifications_get_my_notifications(opts)
 
 Query user notifications of the current user.
 
@@ -102,6 +219,9 @@ require 'notifo'
 
 api_instance = Notifo::NotificationsApi.new
 opts = { 
+  channels: ['channels_example'], # Array<String> | The active channels.
+  channel: 'channel_example', # String | The source channel.
+  correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
   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.
@@ -109,7 +229,64 @@ opts = {
 
 begin
   #Query user notifications of the current user.
-  result = api_instance.notifications_get_notifications(opts)
+  result = api_instance.notifications_get_my_notifications(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_my_notifications: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional] 
+ **channel** | **String**| The source channel. | [optional] 
+ **correlation_id** | **String**| The correlation ID, that can be used to query notifications. | [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
+
+[**ListResponseDtoOfUserNotificationDto**](ListResponseDtoOfUserNotificationDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **notifications_get_notifications**
+> ListResponseDtoOfUserNotificationDetailsDto notifications_get_notifications(app_id, id, opts)
+
+Query user notifications.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+opts = { 
+  channels: ['channels_example'], # Array<String> | The active channels.
+  channel: 'channel_example', # String | The source channel.
+  correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
+  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 user notifications.
+  result = api_instance.notifications_get_notifications(app_id, id, opts)
   p result
 rescue Notifo::ApiError => e
   puts "Exception when calling NotificationsApi->notifications_get_notifications: #{e}"
@@ -120,13 +297,18 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the user belongs to. | 
+ **id** | **String**| The user id. | 
+ **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional] 
+ **channel** | **String**| The source channel. | [optional] 
+ **correlation_id** | **String**| The correlation ID, that can be used to query notifications. | [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
 
-[**ListResponseDtoOfNotificationDto**](ListResponseDtoOfNotificationDto.md)
+[**ListResponseDtoOfUserNotificationDetailsDto**](ListResponseDtoOfUserNotificationDetailsDto.md)
 
 ### Authorization
 

data/docs/PingApi.md

@@ -0,0 +1,131 @@
+# Notifo::PingApi
+
+All URIs are relative to *https://notifo-dev.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ping_get_info**](PingApi.md#ping_get_info) | **GET** /api/info | Get some info about the API.
+[**ping_get_old_ping**](PingApi.md#ping_get_old_ping) | **GET** /ping | Get ping status of the API.
+[**ping_get_ping**](PingApi.md#ping_get_ping) | **GET** /api/ping | Get ping status of the API.
+
+# **ping_get_info**
+> InfoDto ping_get_info
+
+Get some info about the API.
+
+Can be used to test, if the Squidex API is alive and responding.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::PingApi.new
+
+begin
+  #Get some info about the API.
+  result = api_instance.ping_get_info
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling PingApi->ping_get_info: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InfoDto**](InfoDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **ping_get_old_ping**
+> ping_get_old_ping
+
+Get ping status of the API.
+
+Can be used to test, if the Squidex API is alive and responding.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::PingApi.new
+
+begin
+  #Get ping status of the API.
+  api_instance.ping_get_old_ping
+rescue Notifo::ApiError => e
+  puts "Exception when calling PingApi->ping_get_old_ping: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **ping_get_ping**
+> ping_get_ping
+
+Get ping status of the API.
+
+Can be used to test, if the Squidex API is alive and responding.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::PingApi.new
+
+begin
+  #Get ping status of the API.
+  api_instance.ping_get_ping
+rescue Notifo::ApiError => e
+  puts "Exception when calling PingApi->ping_get_ping: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ProcessStatus.md

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

data/docs/ProfileDto.md

@@ -6,9 +6,10 @@ Name | Type | Description | Notes
 **full_name** | **String** | The full name of the user. | 
 **email_address** | **String** | The email of the user. | 
 **phone_number** | **String** | The phone number. | [optional] 
+**allowed_topics** | **Array<String>** | The allowed Topics. | [optional] 
 **preferred_language** | **String** | The preferred language of the user. | [optional] 
 **preferred_timezone** | **String** | The timezone of the user. | [optional] 
 **supported_languages** | **Array<String>** | The supported languages. | 
 **supported_timezones** | **Array<String>** | The supported timezones. | 
-**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | 
 

data/docs/PropertyType.md

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

data/docs/PublishDto.md

@@ -6,11 +6,13 @@ Name | Type | Description | Notes
 **topic** | **String** | The topic path. | 
 **creator_id** | **String** | A custom id to identity the creator. | [optional] 
 **template_code** | **String** | The template code. | [optional] 
+**correlation_id** | **String** | The correlation ID, that can be used to query notifications. | [optional] 
+**template_variants** | **Hash<String, Float>** | The template variants with propability. | [optional] 
 **data** | **String** | Additional user defined data. | [optional] 
 **timestamp** | **DateTime** | A custom timestamp. | [optional] 
 **preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | [optional] 
-**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | The notification settings. | [optional] 
-**properties** | [**EventProperties**](EventProperties.md) |  | [optional] 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | The notification settings. | [optional] 
+**properties** | [**NotificationProperties**](NotificationProperties.md) |  | [optional] 
 **scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] 
 **silent** | **BOOLEAN** | True when silent. | [optional] 
 **test** | **BOOLEAN** | True when using test integrations. | [optional] 

data/docs/RegisterMobileTokenDto.md

@@ -5,4 +5,5 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **token** | **String** | The device token. | 
 **device_type** | [**MobileDeviceType**](MobileDeviceType.md) |  | [optional] 
+**device_identifier** | **String** | A unique identifier for the device. | [optional] 
 

data/docs/SendConfiguration.md

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

data/docs/{Body.md → SmsTemplateDto.md}

@@ -1,7 +1,7 @@
-# Notifo::Body
+# Notifo::SmsTemplateDto
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **String** |  | [optional] 
+**text** | **String** | The template text. |