notifo-io 1.0.0.1 → 1.0.0.2

data/docs/UpdateProfileDto.md

@@ -0,0 +1,28 @@
+# 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
+)
+```
+

data/docs/UpsertTemplateDto.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **code** | **String** | The code of the template. | [optional] |
-| **formatting** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | The formatting. | [optional] |
-| **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+| **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | [optional] |
+| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
 
 ## Example
 

data/docs/UpsertUserDto.md

@@ -11,7 +11,7 @@
 | **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** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
 
 ## Example
 

data/docs/UserApi.md

@@ -0,0 +1,323 @@
+# Notifo::UserApi
+
+All URIs are relative to *https://app.notifo.io*
+
+| 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. |
+
+
+## user_delete_subscription
+
+> user_delete_subscription(topic)
+
+Deletes a user subscription.
+
+User Id and App Id are resolved using the API token.
+
+### Examples
+
+```ruby
+require 'time'
+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.
+
+> <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
+rescue Notifo::ApiError => e
+  puts "Error when calling UserApi->user_delete_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic** | **String** | The topic path. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_get_subscription
+
+> <SubscriptionDto> user_get_subscription(topic)
+
+Gets a user subscription.
+
+User Id and App Id are resolved using the API token.
+
+### Examples
+
+```ruby
+require 'time'
+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)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling UserApi->user_get_subscription: #{e}"
+end
+```
+
+#### Using the user_get_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionDto>, Integer, Hash)> user_get_subscription_with_http_info(topic)
+
+```ruby
+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>
+rescue Notifo::ApiError => e
+  puts "Error when calling UserApi->user_get_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic** | **String** | The topic path. |  |
+
+### Return type
+
+[**SubscriptionDto**](SubscriptionDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_get_user
+
+> <ProfileDto> user_get_user
+
+Get the current user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UserApi.new
+
+begin
+  # Get the current user.
+  result = api_instance.user_get_user
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling UserApi->user_get_user: #{e}"
+end
+```
+
+#### Using the user_get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProfileDto>, Integer, Hash)> user_get_user_with_http_info
+
+```ruby
+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>
+rescue Notifo::ApiError => e
+  puts "Error when calling UserApi->user_get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ProfileDto**](ProfileDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_post_subscription
+
+> user_post_subscription(subscription_dto)
+
+Creates a user subscription.
+
+User Id and App Id are resolved using the API token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UserApi.new
+subscription_dto = Notifo::SubscriptionDto.new # SubscriptionDto | 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
+rescue Notifo::ApiError => e
+  puts "Error when calling UserApi->user_post_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_dto** | [**SubscriptionDto**](SubscriptionDto.md) | The subscription settings. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## user_post_user
+
+> <ProfileDto> user_post_user(update_profile_dto)
+
+Update the user.
+
+### Examples
+
+```ruby
+require 'time'
+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
+
+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>
+rescue Notifo::ApiError => e
+  puts "Error when calling UserApi->user_post_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_profile_dto** | [**UpdateProfileDto**](UpdateProfileDto.md) | The upsert request. |  |
+
+### Return type
+
+[**ProfileDto**](ProfileDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UserDto.md

@@ -12,8 +12,8 @@
 | **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** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
-| **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
+| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
+| **counters** | **Hash<String, Integer>** | The statistics counters. | [optional] |
 
 ## Example
 

data/docs/UsersApi.md

@@ -417,7 +417,7 @@ No authorization required
 
 ## users_post_allowed_topic
 
-> users_post_allowed_topic(app_id, id, add_allowed_topic_request)
+> users_post_allowed_topic(app_id, id, add_allowed_topic_dto)
 
 Add an allowed topic.
 
@@ -430,11 +430,11 @@ require 'notifo'
 api_instance = Notifo::UsersApi.new
 app_id = 'app_id_example' # String | The app where the users belong to.
 id = 'id_example' # String | The user id.
-add_allowed_topic_request = Notifo::AddAllowedTopicRequest.new # AddAllowedTopicRequest | The upsert request.
+add_allowed_topic_dto = Notifo::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
 
 begin
   # Add an allowed topic.
-  api_instance.users_post_allowed_topic(app_id, id, add_allowed_topic_request)
+  api_instance.users_post_allowed_topic(app_id, id, add_allowed_topic_dto)
 rescue Notifo::ApiError => e
   puts "Error when calling UsersApi->users_post_allowed_topic: #{e}"
 end
@@ -444,12 +444,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_request)
+> <Array(nil, Integer, Hash)> users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_dto)
 
 ```ruby
 begin
   # Add an allowed topic.
-  data, status_code, headers = api_instance.users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_request)
+  data, status_code, headers = api_instance.users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_dto)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -464,7 +464,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **app_id** | **String** | The app where the users belong to. |  |
 | **id** | **String** | The user id. |  |
-| **add_allowed_topic_request** | [**AddAllowedTopicRequest**](AddAllowedTopicRequest.md) | The upsert request. |  |
+| **add_allowed_topic_dto** | [**AddAllowedTopicDto**](AddAllowedTopicDto.md) | The upsert request. |  |
 
 ### Return type
 
@@ -482,7 +482,7 @@ No authorization required
 
 ## users_post_subscription
 
-> users_post_subscription(app_id, id, subscribe_dto)
+> users_post_subscription(app_id, id, subscription_dto)
 
 Upsert a user subscriptions.
 
@@ -495,11 +495,11 @@ require 'notifo'
 api_instance = Notifo::UsersApi.new
 app_id = 'app_id_example' # String | The app where the user belongs to.
 id = 'id_example' # String | The user id.
-subscribe_dto = Notifo::SubscribeDto.new # SubscribeDto | The subscription object.
+subscription_dto = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription object.
 
 begin
   # Upsert a user subscriptions.
-  api_instance.users_post_subscription(app_id, id, subscribe_dto)
+  api_instance.users_post_subscription(app_id, id, subscription_dto)
 rescue Notifo::ApiError => e
   puts "Error when calling UsersApi->users_post_subscription: #{e}"
 end
@@ -509,12 +509,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> users_post_subscription_with_http_info(app_id, id, subscribe_dto)
+> <Array(nil, Integer, Hash)> users_post_subscription_with_http_info(app_id, id, subscription_dto)
 
 ```ruby
 begin
   # Upsert a user subscriptions.
-  data, status_code, headers = api_instance.users_post_subscription_with_http_info(app_id, id, subscribe_dto)
+  data, status_code, headers = api_instance.users_post_subscription_with_http_info(app_id, id, subscription_dto)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -529,7 +529,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **app_id** | **String** | The app where the user belongs to. |  |
 | **id** | **String** | The user id. |  |
-| **subscribe_dto** | [**SubscribeDto**](SubscribeDto.md) | The subscription object. |  |
+| **subscription_dto** | [**SubscriptionDto**](SubscriptionDto.md) | The subscription object. |  |
 
 ### Return type