notifo-io 1.0.1 → 1.0.1.1

data/docs/MediaDto.md

@@ -1,30 +1,13 @@
 # Notifo::MediaDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **mime_type** | **String** | The mime type. |  |
-| **file_name** | **String** | The file name. |  |
-| **file_info** | **String** | Generated information about the file. |  |
-| **file_size** | **Integer** | The size of the media file. |  |
-| **url** | **String** | The url to the media item. |  |
-| **type** | [**MediaType**](MediaType.md) |  |  |
-| **metadata** | **Hash<String, String>** |  |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::MediaDto.new(
-  mime_type: null,
-  file_name: null,
-  file_info: null,
-  file_size: null,
-  url: null,
-  type: null,
-  metadata: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mime_type** | **String** | The mime type. | 
+**file_name** | **String** | The file name. | 
+**file_info** | **String** | Generated information about the file. | 
+**file_size** | **Integer** | The size of the media file. | 
+**url** | **String** | The url to the media item. | 
+**type** | [**MediaType**](MediaType.md) |  | 
+**metadata** | [**MediaMetadata**](MediaMetadata.md) |  | 
 

data/docs/MediaMetadata.md

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

data/docs/MediaType.md

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

data/docs/NotificationFormattingDto.md

@@ -1,32 +1,14 @@
 # Notifo::NotificationFormattingDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | **Hash<String, String>** |  |  |
-| **body** | **Hash<String, String>** |  | [optional] |
-| **confirm_text** | **Hash<String, String>** |  | [optional] |
-| **image_small** | **Hash<String, String>** |  | [optional] |
-| **image_large** | **Hash<String, String>** |  | [optional] |
-| **link_url** | **Hash<String, String>** |  | [optional] |
-| **link_text** | **Hash<String, String>** |  | [optional] |
-| **confirm_mode** | [**ConfirmMode**](ConfirmMode.md) |  |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::NotificationFormattingDto.new(
-  subject: null,
-  body: null,
-  confirm_text: null,
-  image_small: null,
-  image_large: null,
-  link_url: null,
-  link_text: null,
-  confirm_mode: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subject** | [**LocalizedText**](LocalizedText.md) |  | 
+**body** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**confirm_text** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**image_small** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**image_large** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**link_url** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**link_text** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**confirm_mode** | [**ConfirmMode**](ConfirmMode.md) |  | 
 

data/docs/NotificationSend.md

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

data/docs/NotificationSettingDto.md

@@ -1,20 +1,8 @@
 # Notifo::NotificationSettingDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **_send** | [**NotificationSend**](NotificationSend.md) |  |  |
-| **delay_in_seconds** | **Integer** | The delay in seconds. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::NotificationSettingDto.new(
-  _send: null,
-  delay_in_seconds: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**send** | [**NotificationSend**](NotificationSend.md) |  | 
+**delay_in_seconds** | **Integer** | The delay in seconds. | [optional] 
 

data/docs/ProfileDto.md

@@ -1,32 +1,14 @@
 # Notifo::ProfileDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **full_name** | **String** | The full name of the user. |  |
-| **email_address** | **String** | The email of the user. |  |
-| **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] |
-| **supported_languages** | **Array<String>** | The supported languages. |  |
-| **supported_timezones** | **Array<String>** | The supported timezones. |  |
-| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::ProfileDto.new(
-  full_name: null,
-  email_address: null,
-  phone_number: null,
-  preferred_language: null,
-  preferred_timezone: null,
-  supported_languages: null,
-  supported_timezones: null,
-  settings: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**full_name** | **String** | The full name of the user. | 
+**email_address** | **String** | The email of the user. | 
+**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] 
+**supported_languages** | **Array<String>** | The supported languages. | 
+**supported_timezones** | **Array<String>** | The supported timezones. | 
+**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | 
 

data/docs/PublishDto.md

@@ -1,36 +1,16 @@
 # Notifo::PublishDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **topic** | **String** | The topic path. |  |
-| **creator_id** | **String** | A custom id to identity the creator. | [optional] |
-| **template_code** | **String** | The template code. | [optional] |
-| **data** | **String** | Additional user defined data. | [optional] |
-| **timestamp** | **Time** | A custom timestamp. | [optional] |
-| **preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | [optional] |
-| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | The notification settings. | [optional] |
-| **properties** | **Hash<String, String>** |  | [optional] |
-| **scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] |
-| **silent** | **Boolean** | True when silent. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::PublishDto.new(
-  topic: null,
-  creator_id: null,
-  template_code: null,
-  data: null,
-  timestamp: null,
-  preformatted: null,
-  settings: null,
-  properties: null,
-  scheduling: null,
-  silent: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic** | **String** | The topic path. | 
+**creator_id** | **String** | A custom id to identity the creator. | [optional] 
+**template_code** | **String** | The template code. | [optional] 
+**data** | **String** | Additional user defined data. | [optional] 
+**timestamp** | **DateTime** | A custom timestamp. | [optional] 
+**preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | [optional] 
+**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | The notification settings. | [optional] 
+**properties** | [**EventProperties**](EventProperties.md) |  | [optional] 
+**scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] 
+**silent** | **BOOLEAN** | True when silent. | [optional] 
 

data/docs/PublishManyDto.md

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

data/docs/ResizeMode.md

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

data/docs/SchedulingDto.md

@@ -1,24 +1,10 @@
 # Notifo::SchedulingDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | [**SchedulingType**](SchedulingType.md) |  | [optional] |
-| **next_week_day** | [**IsoDayOfWeek**](IsoDayOfWeek.md) |  | [optional] |
-| **date** | **Date** | The scheduling date. | [optional] |
-| **time** | **String** | The scheduling time. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::SchedulingDto.new(
-  type: null,
-  next_week_day: null,
-  date: null,
-  time: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**SchedulingType**](SchedulingType.md) |  | [optional] 
+**next_week_day** | [**IsoDayOfWeek**](IsoDayOfWeek.md) |  | [optional] 
+**date** | **Date** | The scheduling date. | [optional] 
+**time** | **String** | The scheduling time. | [optional] 
 

data/docs/SchedulingType.md

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

data/docs/SubscriptionDto.md

@@ -1,20 +1,8 @@
 # Notifo::SubscriptionDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **topic_prefix** | **String** | The topic to add. |  |
-| **topic_settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::SubscriptionDto.new(
-  topic_prefix: null,
-  topic_settings: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic_prefix** | **String** | The topic to add. | 
+**topic_settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] 
 

data/docs/TemplateDto.md

@@ -1,22 +1,9 @@
 # Notifo::TemplateDto
 
 ## 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. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::TemplateDto.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. | 
 

data/docs/TemplatesApi.md

@@ -1,63 +1,43 @@
 # Notifo::TemplatesApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://app.notifo.io*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**templates_delete_template**](TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template. |
-| [**templates_get_templates**](TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates. |
-| [**templates_post_templates**](TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates. |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**templates_delete_template**](TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
+[**templates_get_templates**](TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates.
+[**templates_post_templates**](TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates.
 
-
-## templates_delete_template
-
-> <ListResponseDtoOfTemplateDto> templates_delete_template(app_id, code)
+# **templates_delete_template**
+> ListResponseDtoOfTemplateDto templates_delete_template(app_id, code)
 
 Delete a template.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TemplatesApi.new
 app_id = 'app_id_example' # String | The app where the templates belong to.
 code = 'code_example' # String | The template code to delete.
 
+
 begin
-  # Delete a template.
+  #Delete a template.
   result = api_instance.templates_delete_template(app_id, code)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_delete_template: #{e}"
-end
-```
-
-#### Using the templates_delete_template_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_delete_template_with_http_info(app_id, code)
-
-```ruby
-begin
-  # Delete a template.
-  data, status_code, headers = api_instance.templates_delete_template_with_http_info(app_id, code)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfTemplateDto>
-rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_delete_template_with_http_info: #{e}"
+  puts "Exception when calling TemplatesApi->templates_delete_template: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the templates belong to. |  |
-| **code** | **String** | The template code to delete. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the templates belong to. | 
+ **code** | **String**| The template code to delete. | 
 
 ### Return type
 
@@ -69,65 +49,46 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## templates_get_templates
 
-> <ListResponseDtoOfTemplateDto> templates_get_templates(app_id, opts)
+# **templates_get_templates**
+> ListResponseDtoOfTemplateDto templates_get_templates(app_id, opts)
 
 Query templates.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TemplatesApi.new
 app_id = 'app_id_example' # String | The app where the templates 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 templates.
+  #Query templates.
   result = api_instance.templates_get_templates(app_id, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_get_templates: #{e}"
-end
-```
-
-#### Using the templates_get_templates_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_get_templates_with_http_info(app_id, opts)
-
-```ruby
-begin
-  # Query templates.
-  data, status_code, headers = api_instance.templates_get_templates_with_http_info(app_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfTemplateDto>
-rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_get_templates_with_http_info: #{e}"
+  puts "Exception when calling TemplatesApi->templates_get_templates: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the templates 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 templates 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
 
@@ -139,59 +100,41 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## templates_post_templates
 
-> <Array<TemplateDto>> templates_post_templates(app_id, upsert_templates_dto)
+# **templates_post_templates**
+> Array&lt;TemplateDto&gt; templates_post_templates(bodyapp_id)
 
 Upsert templates.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::TemplatesApi.new
+body = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
 app_id = 'app_id_example' # String | The app where the templates belong to.
-upsert_templates_dto = Notifo::UpsertTemplatesDto.new({requests: [Notifo::UpsertTemplateDto.new({code: 'code_example', formatting: Notifo::NotificationFormattingDto.new({subject: { key: 'inner_example'}, confirm_mode: Notifo::ConfirmMode::SEEN})})]}) # UpsertTemplatesDto | The upsert request.
-
-begin
-  # Upsert templates.
-  result = api_instance.templates_post_templates(app_id, upsert_templates_dto)
-  p result
-rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_post_templates: #{e}"
-end
-```
-
-#### Using the templates_post_templates_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<TemplateDto>>, Integer, Hash)> templates_post_templates_with_http_info(app_id, upsert_templates_dto)
 
-```ruby
 begin
-  # Upsert templates.
-  data, status_code, headers = api_instance.templates_post_templates_with_http_info(app_id, upsert_templates_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<TemplateDto>>
+  #Upsert templates.
+  result = api_instance.templates_post_templates(bodyapp_id)
+  p result
 rescue Notifo::ApiError => e
-  puts "Error when calling TemplatesApi->templates_post_templates_with_http_info: #{e}"
+  puts "Exception when calling TemplatesApi->templates_post_templates: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the templates belong to. |  |
-| **upsert_templates_dto** | [**UpsertTemplatesDto**](UpsertTemplatesDto.md) | The upsert request. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpsertTemplatesDto**](UpsertTemplatesDto.md)| The upsert request. | 
+ **app_id** | **String**| The app where the templates belong to. | 
 
 ### Return type
 
@@ -203,6 +146,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+