notifo-io 1.0.1 → 1.0.1.1

data/docs/Body.md

@@ -0,0 +1,7 @@
+# Notifo::Body
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **String** |  | [optional] 
+

data/docs/ConfigsApi.md

@@ -1,56 +1,34 @@
 # Notifo::ConfigsApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://app.notifo.io*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**configs_get_languages**](ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages. |
-| [**configs_get_timezones**](ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones. |
-
-
-## configs_get_languages
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**configs_get_languages**](ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages.
+[**configs_get_timezones**](ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones.
 
+# **configs_get_languages**
 > Array<String> configs_get_languages
 
 Get all supported languages.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::ConfigsApi.new
 
 begin
-  # Get all supported languages.
+  #Get all supported languages.
   result = api_instance.configs_get_languages
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_languages: #{e}"
-end
-```
-
-#### Using the configs_get_languages_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_languages_with_http_info
-
-```ruby
-begin
-  # Get all supported languages.
-  data, status_code, headers = api_instance.configs_get_languages_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;String&gt;
-rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_languages_with_http_info: #{e}"
+  puts "Exception when calling ConfigsApi->configs_get_languages: #{e}"
 end
 ```
 
 ### Parameters
-
 This endpoint does not need any parameter.
 
 ### Return type
@@ -63,53 +41,33 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## configs_get_timezones
 
+# **configs_get_timezones**
 > Array&lt;String&gt; configs_get_timezones
 
 Get all supported timezones.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::ConfigsApi.new
 
 begin
-  # Get all supported timezones.
+  #Get all supported timezones.
   result = api_instance.configs_get_timezones
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_timezones: #{e}"
-end
-```
-
-#### Using the configs_get_timezones_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_timezones_with_http_info
-
-```ruby
-begin
-  # Get all supported timezones.
-  data, status_code, headers = api_instance.configs_get_timezones_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;String&gt;
-rescue Notifo::ApiError => e
-  puts "Error when calling ConfigsApi->configs_get_timezones_with_http_info: #{e}"
+  puts "Exception when calling ConfigsApi->configs_get_timezones: #{e}"
 end
 ```
 
 ### Parameters
-
 This endpoint does not need any parameter.
 
 ### Return type
@@ -122,6 +80,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 

data/docs/ConfirmMode.md

@@ -1,15 +1,6 @@
 # Notifo::ConfirmMode
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::ConfirmMode.new()
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
 

data/docs/CreateEmailTemplateDto.md

@@ -1,18 +1,7 @@
 # Notifo::CreateEmailTemplateDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **language** | **String** | The new language. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::CreateEmailTemplateDto.new(
-  language: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **String** | The new language. | 
 

data/docs/EmailTemplateDto.md

@@ -1,22 +1,9 @@
 # Notifo::EmailTemplateDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | **String** | The subject text. |  |
-| **body_html** | **String** | The body html template. |  |
-| **body_text** | **String** | The body text template. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::EmailTemplateDto.new(
-  subject: null,
-  body_html: null,
-  body_text: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subject** | **String** | The subject text. | 
+**body_html** | **String** | The body html template. | 
+**body_text** | **String** | The body text template. | [optional] 
 

data/docs/EmailTemplatesDto.md

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

data/docs/EmailVerificationStatus.md

@@ -1,15 +1,6 @@
 # Notifo::EmailVerificationStatus
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::EmailVerificationStatus.new()
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
 

data/docs/ErrorDto.md

@@ -1,26 +1,11 @@
 # Notifo::ErrorDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | The error message. | [optional] |
-| **trace_id** | **String** | The optional trace id. | [optional] |
-| **type** | **String** | The error type, usually a link. | [optional] |
-| **details** | **Array<String>** | Detailed error messages. | [optional] |
-| **status_code** | **Integer** | Status code of the http response. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::ErrorDto.new(
-  message: null,
-  trace_id: null,
-  type: null,
-  details: null,
-  status_code: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | The error message. | [optional] 
+**trace_id** | **String** | The optional trace id. | [optional] 
+**type** | **String** | The error type, usually a link. | [optional] 
+**details** | **Array<String>** | Detailed error messages. | [optional] 
+**status_code** | **Integer** | Status code of the http response. | [optional] 
 

data/docs/EventDto.md

@@ -1,40 +1,18 @@
 # Notifo::EventDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the event. |  |
-| **topic** | **String** | The topic path. |  |
-| **creator_id** | **String** | A custom id to identity the creator. | [optional] |
-| **display_name** | **String** | The display name. |  |
-| **data** | **String** | Additional user defined data. | [optional] |
-| **created** | **Time** | The time when the event has been created. |  |
-| **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  |  |
-| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |  |
-| **properties** | **Hash<String, String>** | User defined properties. |  |
-| **scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] |
-| **counters** | **Hash<String, Integer>** | The statistics counters. |  |
-| **silent** | **Boolean** | True when silent. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::EventDto.new(
-  id: null,
-  topic: null,
-  creator_id: null,
-  display_name: null,
-  data: null,
-  created: null,
-  formatting: null,
-  settings: null,
-  properties: null,
-  scheduling: null,
-  counters: null,
-  silent: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the event. | 
+**topic** | **String** | The topic path. | 
+**creator_id** | **String** | A custom id to identity the creator. | [optional] 
+**display_name** | **String** | The display name. | 
+**data** | **String** | Additional user defined data. | [optional] 
+**created** | **DateTime** | The time when the event has been created. | 
+**formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | 
+**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | 
+**properties** | **Hash<String, String>** | User defined properties. | 
+**scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] 
+**counters** | **Hash<String, Integer>** | The statistics counters. | 
+**silent** | **BOOLEAN** | True when silent. | 
 

data/docs/EventProperties.md

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

data/docs/EventsApi.md

@@ -1,68 +1,47 @@
 # Notifo::EventsApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://app.notifo.io*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**events_get_events**](EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events. |
-| [**events_post_events**](EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events. |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**events_get_events**](EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events.
+[**events_post_events**](EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events.
 
-
-## events_get_events
-
-> <ListResponseDtoOfEventDto> events_get_events(app_id, opts)
+# **events_get_events**
+> ListResponseDtoOfEventDto events_get_events(app_id, opts)
 
 Query events.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::EventsApi.new
 app_id = 'app_id_example' # String | The app where the events 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 events.
+  #Query events.
   result = api_instance.events_get_events(app_id, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling EventsApi->events_get_events: #{e}"
-end
-```
-
-#### Using the events_get_events_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListResponseDtoOfEventDto>, Integer, Hash)> events_get_events_with_http_info(app_id, opts)
-
-```ruby
-begin
-  # Query events.
-  data, status_code, headers = api_instance.events_get_events_with_http_info(app_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfEventDto>
-rescue Notifo::ApiError => e
-  puts "Error when calling EventsApi->events_get_events_with_http_info: #{e}"
+  puts "Exception when calling EventsApi->events_get_events: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the events 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 events 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
 
@@ -74,58 +53,40 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## events_post_events
 
-> events_post_events(app_id, publish_many_dto)
+# **events_post_events**
+> events_post_events(bodyapp_id)
 
 Publish events.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::EventsApi.new
+body = Notifo::PublishManyDto.new # PublishManyDto | The publish request.
 app_id = 'app_id_example' # String | The app where the events belongs to.
-publish_many_dto = Notifo::PublishManyDto.new({requests: [Notifo::PublishDto.new({topic: 'topic_example'})]}) # PublishManyDto | The publish request.
-
-begin
-  # Publish events.
-  api_instance.events_post_events(app_id, publish_many_dto)
-rescue Notifo::ApiError => e
-  puts "Error when calling EventsApi->events_post_events: #{e}"
-end
-```
 
-#### Using the events_post_events_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)> events_post_events_with_http_info(app_id, publish_many_dto)
-
-```ruby
 begin
-  # Publish events.
-  data, status_code, headers = api_instance.events_post_events_with_http_info(app_id, publish_many_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #Publish events.
+  api_instance.events_post_events(bodyapp_id)
 rescue Notifo::ApiError => e
-  puts "Error when calling EventsApi->events_post_events_with_http_info: #{e}"
+  puts "Exception when calling EventsApi->events_post_events: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the events belongs to. |  |
-| **publish_many_dto** | [**PublishManyDto**](PublishManyDto.md) | The publish request. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**PublishManyDto**](PublishManyDto.md)| The publish request. | 
+ **app_id** | **String**| The app where the events belongs to. | 
 
 ### Return type
 
@@ -137,6 +98,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+