notifo-io 1.0.1 → 1.1.0

data/docs/UserApi.md

@@ -1,64 +1,46 @@
 # Notifo::UserApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://notifo.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_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_user**](UserApi.md#user_post_user) | **POST** /api/me | Update the user. |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**user_delete_subscription**](UserApi.md#user_delete_subscription) | **POST** /api/me/subscriptions/{prefix} | Remove my subscription.
+[**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_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(prefix)
 
-## user_delete_subscription
-
-> user_delete_subscription(topic)
-
-Deletes a user subscription.
+Remove my subscription.
 
 User Id and App Id are resolved using the API token.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
-topic = 'topic_example' # String | The topic path.
-
-begin
-  # Deletes a user subscription.
-  api_instance.user_delete_subscription(topic)
-rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_delete_subscription: #{e}"
-end
-```
-
-#### Using the user_delete_subscription_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+prefix = 'prefix_example' # String | The topic prefix.
 
-> <Array(nil, Integer, Hash)> user_delete_subscription_with_http_info(topic)
 
-```ruby
 begin
-  # Deletes a user subscription.
-  data, status_code, headers = api_instance.user_delete_subscription_with_http_info(topic)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #Remove my subscription.
+  api_instance.user_delete_subscription(prefix)
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_delete_subscription_with_http_info: #{e}"
+  puts "Exception when calling UserApi->user_delete_subscription: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **topic** | **String** | The topic path. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prefix** | **String**| The topic prefix. | 
 
 ### Return type
 
@@ -70,63 +52,96 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## user_get_subscription
 
-> <SubscriptionDto> user_get_subscription(topic)
+# **user_get_my_subscription**
+> SubscriptionDto user_get_my_subscription(topic)
 
 Gets a user subscription.
 
 User Id and App Id are resolved using the API token.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
 topic = 'topic_example' # String | The topic path.
 
+
 begin
-  # Gets a user subscription.
-  result = api_instance.user_get_subscription(topic)
+  #Gets a user subscription.
+  result = api_instance.user_get_my_subscription(topic)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_get_subscription: #{e}"
+  puts "Exception when calling UserApi->user_get_my_subscription: #{e}"
 end
 ```
 
-#### Using the user_get_subscription_with_http_info variant
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **topic** | **String**| The topic path. | 
 
-This returns an Array which contains the response data, status code and headers.
+### Return type
 
-> <Array(<SubscriptionDto>, Integer, Hash)> user_get_subscription_with_http_info(topic)
+[**SubscriptionDto**](SubscriptionDto.md)
 
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **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
-  # Gets a user subscription.
-  data, status_code, headers = api_instance.user_get_subscription_with_http_info(topic)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <SubscriptionDto>
+  #Query the user subscriptions.
+  result = api_instance.user_get_my_subscriptions(opts)
+  p result
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_get_subscription_with_http_info: #{e}"
+  puts "Exception when calling UserApi->user_get_my_subscriptions: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **topic** | **String** | The topic path. |  |
+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
 
-[**SubscriptionDto**](SubscriptionDto.md)
+[**ListResponseDtoOfSubscriptionDto**](ListResponseDtoOfSubscriptionDto.md)
 
 ### Authorization
 
@@ -134,53 +149,78 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
-## user_get_user
 
-> <ProfileDto> user_get_user
 
-Get the current user.
+# **user_get_topics**
+> Array&lt;UserTopicDto&gt; user_get_topics(opts)
 
-### Examples
+Query the user topics.
 
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
+opts = { 
+  language: 'language_example' # String | The optional language.
+}
 
 begin
-  # Get the current user.
-  result = api_instance.user_get_user
+  #Query the user topics.
+  result = api_instance.user_get_topics(opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_get_user: #{e}"
+  puts "Exception when calling UserApi->user_get_topics: #{e}"
 end
 ```
 
-#### Using the user_get_user_with_http_info variant
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **language** | **String**| The optional language. | [optional] 
+
+### Return type
+
+[**Array&lt;UserTopicDto&gt;**](UserTopicDto.md)
+
+### Authorization
 
-This returns an Array which contains the response data, status code and headers.
+No authorization required
 
-> <Array(<ProfileDto>, Integer, Hash)> user_get_user_with_http_info
+### HTTP request headers
 
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **user_get_user**
+> ProfileDto user_get_user
+
+Get the current user.
+
+### Example
 ```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::UserApi.new
+
 begin
-  # Get the current user.
-  data, status_code, headers = api_instance.user_get_user_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ProfileDto>
+  #Get the current user.
+  result = api_instance.user_get_user
+  p result
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_get_user_with_http_info: #{e}"
+  puts "Exception when calling UserApi->user_get_user: #{e}"
 end
 ```
 
 ### Parameters
-
 This endpoint does not need any parameter.
 
 ### Return type
@@ -193,58 +233,40 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## user_post_subscription
 
-> user_post_subscription(subscription_dto)
+# **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.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
-subscription_dto = Notifo::SubscriptionDto.new({topic_prefix: 'topic_prefix_example'}) # SubscriptionDto | The subscription settings.
+body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription settings.
 
-begin
-  # Creates a user subscription.
-  api_instance.user_post_subscription(subscription_dto)
-rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_post_subscription: #{e}"
-end
-```
-
-#### Using the user_post_subscription_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> user_post_subscription_with_http_info(subscription_dto)
-
-```ruby
 begin
-  # Creates a user subscription.
-  data, status_code, headers = api_instance.user_post_subscription_with_http_info(subscription_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #Upserts or deletes my subscriptions.
+  api_instance.user_post_my_subscriptions(body)
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_post_subscription_with_http_info: #{e}"
+  puts "Exception when calling UserApi->user_post_my_subscriptions: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subscription_dto** | [**SubscriptionDto**](SubscriptionDto.md) | The subscription settings. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SubscribeManyDto**](SubscribeManyDto.md)| The subscription settings. | 
 
 ### Return type
 
@@ -256,57 +278,39 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
 
 
-## user_post_user
 
-> <ProfileDto> user_post_user(update_profile_dto)
+# **user_post_user**
+> ProfileDto user_post_user(body)
 
 Update the user.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
-update_profile_dto = Notifo::UpdateProfileDto.new # UpdateProfileDto | The upsert request.
-
-begin
-  # Update the user.
-  result = api_instance.user_post_user(update_profile_dto)
-  p result
-rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_post_user: #{e}"
-end
-```
-
-#### Using the user_post_user_with_http_info variant
+body = Notifo::UpdateProfileDto.new # UpdateProfileDto | The upsert request.
 
-This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ProfileDto>, Integer, Hash)> user_post_user_with_http_info(update_profile_dto)
-
-```ruby
 begin
-  # Update the user.
-  data, status_code, headers = api_instance.user_post_user_with_http_info(update_profile_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ProfileDto>
+  #Update the user.
+  result = api_instance.user_post_user(body)
+  p result
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_post_user_with_http_info: #{e}"
+  puts "Exception when calling UserApi->user_post_user: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **update_profile_dto** | [**UpdateProfileDto**](UpdateProfileDto.md) | The upsert request. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpdateProfileDto**](UpdateProfileDto.md)| The upsert request. | 
 
 ### Return type
 
@@ -318,6 +322,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 

data/docs/UserDto.md

@@ -1,36 +1,24 @@
 # Notifo::UserDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the user. |  |
-| **api_key** | **String** | The unique api key for the user. |  |
-| **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. |  |
-| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |  |
-| **counters** | **Hash<String, Integer>** | The statistics counters. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UserDto.new(
-  id: null,
-  api_key: null,
-  full_name: null,
-  email_address: null,
-  phone_number: null,
-  preferred_language: null,
-  preferred_timezone: null,
-  requires_whitelisted_topics: null,
-  settings: null,
-  counters: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the user. | 
+**api_key** | **String** | The unique api key for the user. | 
+**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] 
+**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] 
+**number_of_web_push_tokens** | **Integer** | The number of web hook tokens. | 
+**number_of_mobile_push_tokens** | **Integer** | The number of web hook tokens. | 
+**requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. | 
+**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. | 
+**user_properties** | [**Array<UserPropertyDto>**](UserPropertyDto.md) | The supported user properties. | [optional] 
 

data/docs/UserNotificationBaseDto.md

@@ -0,0 +1,23 @@
+# 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] 
+**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,27 @@
+# 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] 
+**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/UserNotificationDto.md

@@ -0,0 +1,25 @@
+# Notifo::UserNotificationDto
+
+## 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] 
+**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. | 
+