notifo-io 1.0.1 → 1.0.1.1

data/docs/TopicDto.md

@@ -1,22 +1,9 @@
 # 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. | 
+**last_update** | **DateTime** | THe last update to the topic. | 
+**counters** | **Hash<String, Integer>** | The statistics counters. | 
 

data/docs/TopicsApi.md

@@ -1,67 +1,46 @@
 # Notifo::TopicsApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://app.notifo.io*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics. |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics.
 
-
-## topics_get_topics
-
-> <ListResponseDtoOfTopicDto> topics_get_topics(app_id, opts)
+# **topics_get_topics**
+> ListResponseDtoOfTopicDto topics_get_topics(app_id, opts)
 
 Query topics.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TopicsApi.new
 app_id = 'app_id_example' # String | The app where the topics 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 topics.
+  #Query topics.
   result = api_instance.topics_get_topics(app_id, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TopicsApi->topics_get_topics: #{e}"
-end
-```
-
-#### Using the topics_get_topics_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListResponseDtoOfTopicDto>, Integer, Hash)> topics_get_topics_with_http_info(app_id, opts)
-
-```ruby
-begin
-  # Query topics.
-  data, status_code, headers = api_instance.topics_get_topics_with_http_info(app_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfTopicDto>
-rescue Notifo::ApiError => e
-  puts "Error when calling TopicsApi->topics_get_topics_with_http_info: #{e}"
+  puts "Exception when calling TopicsApi->topics_get_topics: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the topics 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 topics 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
 
@@ -73,6 +52,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 

data/docs/UpdateProfileDto.md

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

data/docs/UpsertAppDto.md

@@ -1,36 +1,16 @@
 # Notifo::UpsertAppDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | The app name. | [optional] |
-| **languages** | **Array<String>** | The supported languages. | [optional] |
-| **email_address** | **String** | The sender email address. | [optional] |
-| **email_name** | **String** | The sender email name. | [optional] |
-| **firebase_project** | **String** | The firebase project ID. | [optional] |
-| **firebase_credential** | **String** | The firebase credentials. | [optional] |
-| **webhook_url** | **String** | The webhook URL. | [optional] |
-| **confirm_url** | **String** | The confirm URL. | [optional] |
-| **allow_email** | **Boolean** | True, when emails are allowed. | [optional] |
-| **allow_sms** | **Boolean** | True, when SMS are allowed. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertAppDto.new(
-  name: null,
-  languages: null,
-  email_address: null,
-  email_name: null,
-  firebase_project: null,
-  firebase_credential: null,
-  webhook_url: null,
-  confirm_url: null,
-  allow_email: null,
-  allow_sms: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The app name. | [optional] 
+**languages** | **Array<String>** | The supported languages. | [optional] 
+**email_address** | **String** | The sender email address. | [optional] 
+**email_name** | **String** | The sender email name. | [optional] 
+**firebase_project** | **String** | The firebase project ID. | [optional] 
+**firebase_credential** | **String** | The firebase credentials. | [optional] 
+**webhook_url** | **String** | The webhook URL. | [optional] 
+**confirm_url** | **String** | The confirm URL. | [optional] 
+**allow_email** | **BOOLEAN** | True, when emails are allowed. | [optional] 
+**allow_sms** | **BOOLEAN** | True, when SMS are allowed. | [optional] 
 

data/docs/UpsertTemplateDto.md

@@ -1,22 +1,9 @@
 # Notifo::UpsertTemplateDto
 
 ## 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. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertTemplateDto.new(
-  code: null,
-  formatting: null,
-  settings: null
-)
-```
+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. | [optional] 
 

data/docs/UpsertTemplatesDto.md

@@ -1,18 +1,7 @@
 # Notifo::UpsertTemplatesDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **requests** | [**Array<UpsertTemplateDto>**](UpsertTemplateDto.md) | The templates to update. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertTemplatesDto.new(
-  requests: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**Array<UpsertTemplateDto>**](UpsertTemplateDto.md) | The templates to update. | 
 

data/docs/UpsertUserDto.md

@@ -1,32 +1,14 @@
 # Notifo::UpsertUserDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the user. | [optional] |
-| **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. | [optional] |
-| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertUserDto.new(
-  id: null,
-  full_name: null,
-  email_address: null,
-  phone_number: null,
-  preferred_language: null,
-  preferred_timezone: null,
-  requires_whitelisted_topics: null,
-  settings: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the user. | [optional] 
+**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. | [optional] 
+**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] 
 

data/docs/UpsertUsersDto.md

@@ -1,18 +1,7 @@
 # Notifo::UpsertUsersDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **requests** | [**Array<UpsertUserDto>**](UpsertUserDto.md) | The users to update. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::UpsertUsersDto.new(
-  requests: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**Array<UpsertUserDto>**](UpsertUserDto.md) | The users to update. | 
 

data/docs/UserApi.md

@@ -1,64 +1,44 @@
 # Notifo::UserApi
 
-All URIs are relative to *http://localhost*
+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
+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
-
+### 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.
-
-> <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
+  #Deletes a user subscription.
+  api_instance.user_delete_subscription(topic)
 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
+------------- | ------------- | ------------- | -------------
+ **topic** | **String**| The topic path. | 
 
 ### Return type
 
@@ -70,59 +50,41 @@ 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_subscription**
+> SubscriptionDto user_get_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.
+  #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}"
+  puts "Exception when calling UserApi->user_get_subscription: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **topic** | **String** | The topic path. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **topic** | **String**| The topic path. | 
 
 ### Return type
 
@@ -134,53 +96,33 @@ 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
+# **user_get_user**
+> ProfileDto user_get_user
 
 Get the current user.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::UserApi.new
 
 begin
-  # Get the current user.
+  #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}"
+  puts "Exception when calling UserApi->user_get_user: #{e}"
 end
 ```
 
 ### Parameters
-
 This endpoint does not need any parameter.
 
 ### Return type
@@ -193,58 +135,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_subscription**
+> user_post_subscription(body)
 
 Creates 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
-subscription_dto = Notifo::SubscriptionDto.new({topic_prefix: 'topic_prefix_example'}) # 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.
+body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription settings.
 
-> <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
+  #Creates a user subscription.
+  api_instance.user_post_subscription(body)
 rescue Notifo::ApiError => e
-  puts "Error when calling UserApi->user_post_subscription_with_http_info: #{e}"
+  puts "Exception when calling UserApi->user_post_subscription: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subscription_dto** | [**SubscriptionDto**](SubscriptionDto.md) | The subscription settings. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription settings. | 
 
 ### Return type
 
@@ -256,57 +180,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 +224,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+