notifo-io 1.0.1.2 → 1.2.0

data/docs/UserApi.md

@@ -1,19 +1,22 @@
 # Notifo::UserApi
 
-All URIs are relative to *https://notifo.easierlife.com*
+All URIs are relative to *https://notifo-dev.easierlife.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**user_delete_subscription**](UserApi.md#user_delete_subscription) | **DELETE** /api/me/subscriptions/{topic} | Deletes a user subscription.
-[**user_get_subscription**](UserApi.md#user_get_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
+[**user_delete_subscription**](UserApi.md#user_delete_subscription) | **POST** /api/me/subscriptions/{prefix} | Remove my subscription.
+[**user_get_admin_user**](UserApi.md#user_get_admin_user) | **GET** /api/me/admin | Get the current admin user.
+[**user_get_my_subscription**](UserApi.md#user_get_my_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
+[**user_get_my_subscriptions**](UserApi.md#user_get_my_subscriptions) | **GET** /api/me/subscriptions | Query the user subscriptions.
+[**user_get_topics**](UserApi.md#user_get_topics) | **GET** /api/me/topics | Query the user topics.
 [**user_get_user**](UserApi.md#user_get_user) | **GET** /api/me | Get the current user.
-[**user_post_subscription**](UserApi.md#user_post_subscription) | **POST** /api/me/subscriptions | Creates a user subscription.
+[**user_post_my_subscriptions**](UserApi.md#user_post_my_subscriptions) | **POST** /api/me/subscriptions | Upserts or deletes my subscriptions.
 [**user_post_user**](UserApi.md#user_post_user) | **POST** /api/me | Update the user.
 
 # **user_delete_subscription**
-> user_delete_subscription(topic)
+> user_delete_subscription(prefix)
 
-Deletes a user subscription.
+Remove my subscription.
 
 User Id and App Id are resolved using the API token.
 
@@ -23,12 +26,12 @@ User Id and App Id are resolved using the API token.
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
-topic = 'topic_example' # String | The topic path.
+prefix = 'prefix_example' # String | The topic prefix.
 
 
 begin
-  #Deletes a user subscription.
-  api_instance.user_delete_subscription(topic)
+  #Remove my subscription.
+  api_instance.user_delete_subscription(prefix)
 rescue Notifo::ApiError => e
   puts "Exception when calling UserApi->user_delete_subscription: #{e}"
 end
@@ -38,7 +41,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **topic** | **String**| The topic path. | 
+ **prefix** | **String**| The topic prefix. | 
 
 ### Return type
 
@@ -55,8 +58,47 @@ No authorization required
 
 
 
-# **user_get_subscription**
-> SubscriptionDto user_get_subscription(topic)
+# **user_get_admin_user**
+> AdminProfileDto user_get_admin_user
+
+Get the current admin user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::UserApi.new
+
+begin
+  #Get the current admin user.
+  result = api_instance.user_get_admin_user
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_get_admin_user: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AdminProfileDto**](AdminProfileDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **user_get_my_subscription**
+> SubscriptionDto user_get_my_subscription(topic)
 
 Gets a user subscription.
 
@@ -73,10 +115,10 @@ topic = 'topic_example' # String | The topic path.
 
 begin
   #Gets a user subscription.
-  result = api_instance.user_get_subscription(topic)
+  result = api_instance.user_get_my_subscription(topic)
   p result
 rescue Notifo::ApiError => e
-  puts "Exception when calling UserApi->user_get_subscription: #{e}"
+  puts "Exception when calling UserApi->user_get_my_subscription: #{e}"
 end
 ```
 
@@ -101,6 +143,102 @@ No authorization required
 
 
 
+# **user_get_my_subscriptions**
+> ListResponseDtoOfSubscriptionDto user_get_my_subscriptions(opts)
+
+Query the user subscriptions.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::UserApi.new
+opts = { 
+  topics: 'topics_example', # String | The topics we are interested in.
+  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 the user subscriptions.
+  result = api_instance.user_get_my_subscriptions(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_get_my_subscriptions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **topics** | **String**| The topics we are interested in. | [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
+
+[**ListResponseDtoOfSubscriptionDto**](ListResponseDtoOfSubscriptionDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **user_get_topics**
+> Array<UserTopicDto> user_get_topics(opts)
+
+Query the user topics.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::UserApi.new
+opts = { 
+  language: 'language_example' # String | The optional language.
+}
+
+begin
+  #Query the user topics.
+  result = api_instance.user_get_topics(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling UserApi->user_get_topics: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **language** | **String**| The optional language. | [optional] 
+
+### Return type
+
+[**Array<UserTopicDto>**](UserTopicDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **user_get_user**
 > ProfileDto user_get_user
 
@@ -140,10 +278,10 @@ No authorization required
 
 
 
-# **user_post_subscription**
-> user_post_subscription(body)
+# **user_post_my_subscriptions**
+> user_post_my_subscriptions(body)
 
-Creates a user subscription.
+Upserts or deletes my subscriptions.
 
 User Id and App Id are resolved using the API token.
 
@@ -153,14 +291,14 @@ User Id and App Id are resolved using the API token.
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
-body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription settings.
+body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription settings.
 
 
 begin
-  #Creates a user subscription.
-  api_instance.user_post_subscription(body)
+  #Upserts or deletes my subscriptions.
+  api_instance.user_post_my_subscriptions(body)
 rescue Notifo::ApiError => e
-  puts "Exception when calling UserApi->user_post_subscription: #{e}"
+  puts "Exception when calling UserApi->user_post_my_subscriptions: #{e}"
 end
 ```
 
@@ -168,7 +306,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription settings. | 
+ **body** | [**SubscribeManyDto**](SubscribeManyDto.md)| The subscription settings. | 
 
 ### Return type
 

data/docs/UserDto.md

@@ -8,12 +8,16 @@ 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] 
-**number_of_web_push_tokens** | **Integer** | The number of web hook tokens. | 
-**number_of_mobile_push_tokens** | **Integer** | The number of web hook tokens. | 
+**created** | **DateTime** | The date time (ISO 8601) when the user has been created. | 
+**last_update** | **DateTime** | The date time (ISO 8601) when the user has been updated. | 
+**last_notification** | **DateTime** | The date time (ISO 8601) when the user has been received the last notification. | [optional] 
 **requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. | 
-**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | 
+**properties** | **Hash<String, String>** | The user properties. | [optional] 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | 
 **counters** | **Hash<String, Integer>** | The statistics counters. | 
+**mobile_push_tokens** | [**Array<MobilePushTokenDto>**](MobilePushTokenDto.md) | The mobile push tokens. | 
+**web_push_subscriptions** | [**Array<WebPushSubscriptionDto>**](WebPushSubscriptionDto.md) | The web push subscriptions. | 
+**user_properties** | [**Array<UserPropertyDto>**](UserPropertyDto.md) | The supported user properties. | [optional] 
 

data/docs/UserNotificationBaseDto.md

@@ -0,0 +1,24 @@
+# Notifo::UserNotificationBaseDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the notification. | 
+**subject** | **String** | The subject of the notification in the language of the user. | 
+**silent** | **BOOLEAN** | True when the notification is silent. | 
+**created** | **DateTime** | The timestamp when the notification has been created. | 
+**updated** | **DateTime** | The timestamp when the notification has been updated. | 
+**tracking_token** | **String** | The tracking token. | [optional] 
+**body** | **String** | The optional body text. | [optional] 
+**image_small** | **String** | The optional link to the small image. | [optional] 
+**image_large** | **String** | The optional link to the large image. | [optional] 
+**track_seen_url** | **String** | The tracking url that needs to be invoked to mark the notification as seen. | [optional] 
+**track_delivered_url** | **String** | The tracking url that needs to be invoked to mark the notification as delivered. | [optional] 
+**link_url** | **String** | An optional link. | [optional] 
+**link_text** | **String** | The link text. | [optional] 
+**confirm_text** | **String** | The text for the confirm button. | [optional] 
+**confirm_url** | **String** | The tracking url that needs to be invoked to mark the notification as confirmed. | [optional] 
+**correlation_id** | **String** | The correlation ID, that can be used to query notifications. | [optional] 
+**data** | **String** | Optional data, usually a json object. | [optional] 
+**properties** | [**NotificationProperties**](NotificationProperties.md) |  | [optional] 
+

data/docs/UserNotificationChannelDto.md

@@ -0,0 +1,11 @@
+# Notifo::UserNotificationChannelDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**setting** | [**ChannelSettingDto**](ChannelSettingDto.md) |  | 
+**status** | [**Hash<String, ChannelSendInfoDto>**](ChannelSendInfoDto.md) | The status per token or configuration. | 
+**first_delivered** | **DateTime** | The first time the notification has been marked as delivered for this channel. | [optional] 
+**first_seen** | **DateTime** | The first time the notification has been marked as seen for this channel. | [optional] 
+**first_confirmed** | **DateTime** | The first time the notification has been marked as confirmed for this channel. | [optional] 
+

data/docs/UserNotificationDetailsDto.md

@@ -0,0 +1,28 @@
+# Notifo::UserNotificationDetailsDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the notification. | 
+**subject** | **String** | The subject of the notification in the language of the user. | 
+**silent** | **BOOLEAN** | True when the notification is silent. | 
+**created** | **DateTime** | The timestamp when the notification has been created. | 
+**updated** | **DateTime** | The timestamp when the notification has been updated. | 
+**tracking_token** | **String** | The tracking token. | [optional] 
+**body** | **String** | The optional body text. | [optional] 
+**image_small** | **String** | The optional link to the small image. | [optional] 
+**image_large** | **String** | The optional link to the large image. | [optional] 
+**track_seen_url** | **String** | The tracking url that needs to be invoked to mark the notification as seen. | [optional] 
+**track_delivered_url** | **String** | The tracking url that needs to be invoked to mark the notification as delivered. | [optional] 
+**link_url** | **String** | An optional link. | [optional] 
+**link_text** | **String** | The link text. | [optional] 
+**confirm_text** | **String** | The text for the confirm button. | [optional] 
+**confirm_url** | **String** | The tracking url that needs to be invoked to mark the notification as confirmed. | [optional] 
+**correlation_id** | **String** | The correlation ID, that can be used to query notifications. | [optional] 
+**data** | **String** | Optional data, usually a json object. | [optional] 
+**properties** | [**NotificationProperties**](NotificationProperties.md) |  | [optional] 
+**channels** | [**Hash<String, UserNotificationChannelDto>**](UserNotificationChannelDto.md) | The channel details. | 
+**first_delivered** | [**HandledInfoDto**](HandledInfoDto.md) |  | [optional] 
+**first_seen** | [**HandledInfoDto**](HandledInfoDto.md) |  | [optional] 
+**first_confirmed** | [**HandledInfoDto**](HandledInfoDto.md) |  | [optional] 
+

data/docs/{NotificationDto.md → UserNotificationDto.md}

@@ -1,4 +1,4 @@
-# Notifo::NotificationDto
+# Notifo::UserNotificationDto
 
 ## Properties
 Name | Type | Description | Notes
@@ -6,16 +6,21 @@ Name | Type | Description | Notes
 **id** | **String** | The id of the notification. | 
 **subject** | **String** | The subject of the notification in the language of the user. | 
 **silent** | **BOOLEAN** | True when the notification is silent. | 
-**is_confirmed** | **BOOLEAN** | True when the notification has been confirmed. | 
-**is_seen** | **BOOLEAN** | True when the notification has been seen. | 
 **created** | **DateTime** | The timestamp when the notification has been created. | 
+**updated** | **DateTime** | The timestamp when the notification has been updated. | 
+**tracking_token** | **String** | The tracking token. | [optional] 
 **body** | **String** | The optional body text. | [optional] 
 **image_small** | **String** | The optional link to the small image. | [optional] 
 **image_large** | **String** | The optional link to the large image. | [optional] 
-**tracking_url** | **String** | The tracking url that needs to be invoked to mark the notifiation as seen. | [optional] 
+**track_seen_url** | **String** | The tracking url that needs to be invoked to mark the notification as seen. | [optional] 
+**track_delivered_url** | **String** | The tracking url that needs to be invoked to mark the notification as delivered. | [optional] 
 **link_url** | **String** | An optional link. | [optional] 
 **link_text** | **String** | The link text. | [optional] 
 **confirm_text** | **String** | The text for the confirm button. | [optional] 
-**confirm_url** | **String** | The tracking url that needs to be invoked to mark the notifiation as confirmed. | [optional] 
+**confirm_url** | **String** | The tracking url that needs to be invoked to mark the notification as confirmed. | [optional] 
+**correlation_id** | **String** | The correlation ID, that can be used to query notifications. | [optional] 
 **data** | **String** | Optional data, usually a json object. | [optional] 
+**properties** | [**NotificationProperties**](NotificationProperties.md) |  | [optional] 
+**is_seen** | **BOOLEAN** | True when the notification has been seen at least once. | 
+**is_confirmed** | **BOOLEAN** | True when the notification has been confirmed at least once. | 
 

data/docs/UserPropertyDto.md

@@ -0,0 +1,9 @@
+# Notifo::UserPropertyDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The field name for the property. | 
+**editor_description** | **String** | The optional description. | [optional] 
+**editor_label** | **String** | The optional label. | [optional] 
+

data/docs/UserTopicDto.md

@@ -0,0 +1,11 @@
+# Notifo::UserTopicDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | The path. | 
+**name** | **String** | The name. | 
+**description** | **String** | The optional description. | [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 options. | 
+